You.i Engine
YiToggleButtonView.h
Go to the documentation of this file.
1 // © You i Labs Inc. 2000-2017. All rights reserved.
2 #ifndef _YI_TOGGLEBUTTON_VIEW_H_
3 #define _YI_TOGGLEBUTTON_VIEW_H_
4 
6 
48 {
49 public:
54  {
55 
58  };
59 
61  virtual ~CYIToggleButtonView();
62 
63  virtual bool Init() override;
64 
69  void SetToggled(bool bIsToggled);
70 
75  void ToggleOn();
76 
81  void ToggleOff();
82 
86  bool IsToggledOn() const;
87 
92  void SetState(CYIAbstractButtonView::ENABLE_STATE eEnabledState, TOGGLE_STATE eToggleState);
93 
114 protected:
119  {
122  };
123 
124  virtual void OnEnable() override;
125  virtual void OnDisable() override;
126  virtual void OnPress() override;
127  virtual void OnRelease() override;
128  virtual void OnEnter() override;
129  virtual void OnLeave() override;
130  virtual void OnCancel() override;
131 
136  virtual void OnToggleOn(EMIT_SIGNALS eSignals);
137 
142  virtual void OnToggleOff(EMIT_SIGNALS eSignals);
143 
144  virtual void FinishAllPlayingTimelines() override;
148  virtual void FinishAllPlayingFocusTimelines();
149 
153  void ToggleOn (EMIT_SIGNALS eSignals);
157  void ToggleOff(EMIT_SIGNALS eSignals);
158 
159  void OnPressOnCompleted();
160  void OnPressOffCompleted();
161  void OnReleaseOnCompleted();
162  void OnReleaseOffCompleted();
163 
164  virtual bool HandleEvent(const std::shared_ptr<CYIEventDispatcher> &pDispatcher, CYIEvent *pEvent) override;
165 
167 
184 
186 };
187 
192 #endif // _YI_TOGGLEBUTTON_VIEW_H_
virtual void OnPress() override
The base class for the timeline framework.
Definition: YiAbstractTimeline.h:29
CYIAbstractTimeline * m_pUpOverCheckedAnim
Definition: YiToggleButtonView.h:175
virtual ~CYIToggleButtonView()
virtual void OnDisable() override
CYIAbstractTimeline * m_pDownUpAnim
Definition: YiToggleButtonView.h:178
Provides an abstraction for a button which accepts user interaction in the form of a press...
Definition: YiAbstractButtonView.h:25
CYISignal< int32_t > ButtonReleasingOn
Definition: YiToggleButtonView.h:107
ENABLE_STATE
Definition: YiAbstractButtonView.h:31
CYIAbstractTimeline * m_pToggleOnAnim
Definition: YiToggleButtonView.h:170
virtual void OnEnter() override
Base class for events.
Definition: YiEvent.h:489
CYISignal< int32_t > ButtonPressingOn
Definition: YiToggleButtonView.h:95
TOGGLE_STATE m_eToggleState
Definition: YiToggleButtonView.h:166
void OnReleaseOffCompleted()
virtual void OnToggleOff(EMIT_SIGNALS eSignals)
virtual bool Init() override
Definition: YiToggleButtonView.h:56
CYIAbstractTimeline * m_pOverUpAnim
Definition: YiToggleButtonView.h:176
TOGGLE_STATE
Definition: YiToggleButtonView.h:53
CYIAbstractTimeline * m_pFocusInCheckedAnim
Definition: YiToggleButtonView.h:180
CYISignal< int32_t > ButtonToggledOff
Definition: YiToggleButtonView.h:104
#define YI_TYPE_BASES(...)
Definition: YiRtti.h:350
CYISignal< bool, int32_t > ButtonReleasing
Definition: YiToggleButtonView.h:106
CYISignal< bool, int32_t > ButtonToggled
Definition: YiToggleButtonView.h:102
CYISignal< int32_t > ButtonReleasedOn
Definition: YiToggleButtonView.h:111
virtual void OnEnable() override
CYIAbstractTimeline * m_pDisableAnim
Definition: YiToggleButtonView.h:172
CYISignal< int32_t > ButtonToggledOn
Definition: YiToggleButtonView.h:103
CYISignal< bool, int32_t > ButtonPressing
Definition: YiToggleButtonView.h:94
CYISignal< int32_t > ButtonPressedOn
Definition: YiToggleButtonView.h:99
CYIAbstractTimeline * m_pPressCheckedAnim
Definition: YiToggleButtonView.h:169
Definition: YiToggleButtonView.h:57
bool IsToggledOn() const
CYIAbstractTimeline * m_pDisableCheckedAnim
Definition: YiToggleButtonView.h:173
void SetState(CYIAbstractButtonView::ENABLE_STATE eEnabledState, TOGGLE_STATE eToggleState)
Provides an implementation of a button which maintains a state based on user interaction.
Definition: YiToggleButtonView.h:47
CYISignal< int32_t > ButtonReleasingOff
Definition: YiToggleButtonView.h:108
virtual void FinishAllPlayingTimelines() override
CYIAbstractTimeline * m_pFocusInCheckedToggleTransitionAnim
Definition: YiToggleButtonView.h:183
Definition: YiToggleButtonView.h:121
virtual bool HandleEvent(const std::shared_ptr< CYIEventDispatcher > &pDispatcher, CYIEvent *pEvent) override
CYIAbstractTimeline * m_pOverUpCheckedAnim
Definition: YiToggleButtonView.h:177
CYISignal< int32_t > ButtonPressedOff
Definition: YiToggleButtonView.h:100
virtual void OnRelease() override
virtual void OnCancel() override
CYISignal< int32_t > ButtonReleasedOff
Definition: YiToggleButtonView.h:112
virtual void OnToggleOn(EMIT_SIGNALS eSignals)
CYISignal< bool, int32_t > ButtonPressed
Definition: YiToggleButtonView.h:98
virtual void FinishAllPlayingFocusTimelines()
CYIAbstractTimeline * m_pDownUpCheckedAnim
Definition: YiToggleButtonView.h:179
virtual void OnLeave() override
CYIAbstractTimeline * m_pToggleOffAnim
Definition: YiToggleButtonView.h:171
Definition: YiToggleButtonView.h:120
CYISignal< bool, int32_t > ButtonReleased
Definition: YiToggleButtonView.h:110
CYISignal< int32_t > ButtonPressingOff
Definition: YiToggleButtonView.h:96
CYIAbstractTimeline * m_pFocusOutCheckedAnim
Definition: YiToggleButtonView.h:181
EMIT_SIGNALS
Definition: YiToggleButtonView.h:118
CYIAbstractTimeline * m_pUpOverAnim
Definition: YiToggleButtonView.h:174
CYIAbstractTimeline * m_pPressAnim
Definition: YiToggleButtonView.h:168
CYIAbstractTimeline * m_pFocusInToggleTransitionAnim
Definition: YiToggleButtonView.h:182
void SetToggled(bool bIsToggled)