YiDevWidget.h

Go to the documentation of this file.

#ifndef _YI_DEV_WIDGET_H_
#define _YI_DEV_WIDGET_H_

#include "binding/YiScriptableObject.h"
#include "debug/YiDevPanel.h"
#include "signal/YiSignalHandler.h"
#include "utility/YiRtti.h"
#include "utility/YiString.h"
#include "utility/YiTimer.h"

class CYISceneNode;

class CYIDevWidget : public CYISignalHandler, public CYIScriptableObject
{
public:
    enum STATE
    {
        OFF, 
        ON, 
        STATELESS, 
        DISABLED 
    };

    CYIDevWidget(const CYIString &title, const CYIString &subtitle = "");
    virtual ~CYIDevWidget();

    bool IsUsingIndicator() const;
    
    bool IsUsingSimulatedKeys() const;

    bool IsCapturingAllEvents() const;
    
    bool IsUsingConfigurationItems() const;
    
    STATE GetState() const;

    virtual const CYIString &GetTitle() const;
    
    virtual const CYIString &GetSubtitle() const;

    void SetParentPanel(CYIDevPanel *pPanel, uint32_t uIndexInPanel);

    uint32_t GetIndexInPanel() const;

    void UpdateWidgetState();
    
    virtual void OnPanelItemClicked() = 0;

    virtual void RefreshState() {};
    
    virtual void OnConfigureButtonClicked();
    
    virtual void OnConfigurationItemClicked(int32_t nButtonID);

    virtual void OnConfigurationSubpanelClosed();

    virtual void OnDraw() {};
    
    virtual bool OnUpdate(bool *pbSkipUpdate = nullptr);

    virtual bool OnHandleKeyInputs(const CYIKeyEvent &keyEvent);
    
    virtual bool OnHandleActionInputs(int32_t nX, int32_t nY, int32_t nWheelDelta, uint8_t uButton, YI_EVENT_TYPE eEventType, uint8_t uPointerID, bool bHover);

    virtual bool OnPreFilterEvent(const std::shared_ptr<CYIEventDispatcher> &pDispatcher, CYIEvent *pEvent, CYIEventHandler *pDestination);

    void SimulatePanelItemClicked();
    
    bool SimulateKeyPress(const CYIKeyEvent &keyEvent);
    
    void SimulatedKeyPressesEnded();
    
protected:
    void SetUseSimulatedKeys(bool bUseSimulatedKeys);

    void SetCaptureAllEvents(bool bCaptureAllEvents);
    
    void SetUsesConfigurationItems(bool bUsesConfigurationItems);
    
    virtual std::vector<std::pair<CYIString, CYIString> > GetConfigurationButtonTitles();

    CYISceneNode *GetLogicalRoot() const;
    
    CYIDevPanel *m_pParentPanel;
    uint32_t m_uIndexInPanel;
    STATE m_eState;
    CYIString m_title;
    CYIString m_subtitle;
    
private:
    void OnTimerExpired();
    
    CYITimer m_timer;
    bool m_bUseSimulatedKeys;
    bool m_bCaptureAllEvents;
    bool m_bUseConfigurationItems;
    bool m_bActionDown;
    CYIKeyEvent m_lastKeyEvent;

    YI_TYPE_BASES(CYIDevWidget);
};

#endif