SCR_ButtonEffectVisibility Interface Reference

Effect which sets a widget visible (SetVisible). More...

Inheritance diagram for SCR_ButtonEffectVisibility:

Public Member Functions
override void	OnStateDefault (bool instant)
override void	OnStateHovered (bool instant)
override void	OnStateActivated (bool instant)
override void	OnStateActivatedHovered (bool instant)
override void	OnClicked (bool instant)
override void	OnStateDisabled (bool instant)
override void	OnStateDisabledActivated (bool instant)
override void	OnFocusGained (bool instant)
override void	OnFocusLost (bool instant)
override void	OnToggledOn (bool instant)
override void	OnToggledOff (bool instant)
override void	OnDisabled ()
Public Member Functions inherited from SCR_ButtonEffectWidgetBase
override void	OnHandlerAttached (Widget w)
Widget	GetTargetWidget ()
Public Member Functions inherited from SCR_ButtonEffectBase
bool	GetEnabled ()
void	SetEnabled (bool enabled)
void	PropertiesChanged ()
	Call it if properties have changed and they must be reapplied.
bool	HasTag (string tag)
	Returns true when the effect contains a given tag.
void	OnHandlerAttached (Widget w)
void	OnDisabled ()
bool	Internal_OnEvent (EModularButtonEventFlag eventFlag, EInputDeviceType deviceType, bool instant=false)
void	Init (SCR_ModularButtonComponent parentButton)

Public Attributes
bool	m_bDefault
bool	m_bHovered
bool	m_bActivated
bool	m_bActivatedHovered
bool	m_bDisabled
bool	m_bDisabledActivated
bool	m_bClicked
bool	m_bFocusGained
bool	m_bFocusLost
bool	m_bToggledOn
bool	m_bToggledOff
Public Attributes inherited from SCR_ButtonEffectBase
ref array< string >	m_aTags
EModularButtonEventFlag	m_eEvents
EModularButtonInputDevice	m_eInputDevices

Protected Member Functions
void	Apply (bool visible, bool instant)
Protected Member Functions inherited from SCR_ButtonEffectBase
void	OnStateDefault (bool instant)
void	OnStateHovered (bool instant)
void	OnStateActivated (bool instant)
void	OnStateActivatedHovered (bool instant)
void	OnStateDisabled (bool instant)
void	OnStateDisabledActivated (bool instant)
void	OnClicked (bool instant)
void	OnFocusGained (bool instant)
void	OnFocusLost (bool instant)
void	OnToggledOn (bool instant)
void	OnToggledOff (bool instant)
void	OnMouseEnter (bool instant)
void	OnMouseLeave (bool instant)
void	_print (string s)

Additional Inherited Members
Protected Attributes inherited from SCR_ButtonEffectWidgetBase
string	m_sWidgetName
Widget	m_wTarget
Protected Attributes inherited from SCR_ButtonEffectBase
bool	m_bEnabled
SCR_ModularButtonComponent	m_Button

Detailed Description

Effect which sets a widget visible (SetVisible).

Member Function Documentation

Apply()

void SCR_ButtonEffectVisibility.Apply ( bool  visible, bool  instant  )

protected

OnClicked()

override void SCR_ButtonEffectVisibility.OnClicked

(

bool

instant

)

Implements SCR_ButtonEffectBase.

OnDisabled()

override void SCR_ButtonEffectVisibility.OnDisabled

(

)

Implements SCR_ButtonEffectBase.

OnFocusGained()

override void SCR_ButtonEffectVisibility.OnFocusGained

(

bool

instant

)

Implements SCR_ButtonEffectBase.

OnFocusLost()

override void SCR_ButtonEffectVisibility.OnFocusLost

(

bool

instant

)

Implements SCR_ButtonEffectBase.

OnStateActivated()

override void SCR_ButtonEffectVisibility.OnStateActivated

(

bool

instant

)

Implements SCR_ButtonEffectBase.

OnStateActivatedHovered()

override void SCR_ButtonEffectVisibility.OnStateActivatedHovered

(

bool

instant

)

Implements SCR_ButtonEffectBase.

OnStateDefault()

override void SCR_ButtonEffectVisibility.OnStateDefault

(

bool

instant

)

Implements SCR_ButtonEffectBase.

OnStateDisabled()

override void SCR_ButtonEffectVisibility.OnStateDisabled

(

bool

instant

)

Implements SCR_ButtonEffectBase.

OnStateDisabledActivated()

override void SCR_ButtonEffectVisibility.OnStateDisabledActivated

(

bool

instant

)

Implements SCR_ButtonEffectBase.

OnStateHovered()

override void SCR_ButtonEffectVisibility.OnStateHovered

(

bool

instant

)

Implements SCR_ButtonEffectBase.

OnToggledOff()

override void SCR_ButtonEffectVisibility.OnToggledOff

(

bool

instant

)

Implements SCR_ButtonEffectBase.

OnToggledOn()

override void SCR_ButtonEffectVisibility.OnToggledOn

(

bool

instant

)

Implements SCR_ButtonEffectBase.

Member Data Documentation

m_bActivated

bool SCR_ButtonEffectVisibility.m_bActivated

m_bActivatedHovered

bool SCR_ButtonEffectVisibility.m_bActivatedHovered

m_bClicked

bool SCR_ButtonEffectVisibility.m_bClicked

m_bDefault

bool SCR_ButtonEffectVisibility.m_bDefault

m_bDisabled

bool SCR_ButtonEffectVisibility.m_bDisabled

m_bDisabledActivated

bool SCR_ButtonEffectVisibility.m_bDisabledActivated

m_bFocusGained

bool SCR_ButtonEffectVisibility.m_bFocusGained

m_bFocusLost

bool SCR_ButtonEffectVisibility.m_bFocusLost

m_bHovered

bool SCR_ButtonEffectVisibility.m_bHovered

m_bToggledOff

bool SCR_ButtonEffectVisibility.m_bToggledOff

m_bToggledOn

bool SCR_ButtonEffectVisibility.m_bToggledOn

---

The documentation for this interface was generated from the following file:

• Game/UI/Components/ButtonComponents/ModularButton/Effects/SCR_ButtonEffectVisibility.c