SCR_ButtonEffectText Interface Reference

Effect which changes text of a text or rich text widget. More...

Inheritance diagram for SCR_ButtonEffectText:

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	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)
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
string	m_sDefault
string	m_sHovered
string	m_sActivated
string	m_sActivatedHovered
string	m_sDisabled
string	m_sDisabledActivated
string	m_sFocusGained
string	m_sFocusLost
string	m_sToggledOn
string	m_sToggledOff
Public Attributes inherited from SCR_ButtonEffectBase
ref array< string >	m_aTags
EModularButtonEventFlag	m_eEvents
EModularButtonInputDevice	m_eInputDevices

Protected Member Functions
void	Apply (string text)
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 changes text of a text or rich text widget.

Member Function Documentation

Apply()

void SCR_ButtonEffectText.Apply ( string  text )

protected

OnFocusGained()

override void SCR_ButtonEffectText.OnFocusGained

(

bool

instant

)

Implements SCR_ButtonEffectBase.

OnFocusLost()

override void SCR_ButtonEffectText.OnFocusLost

(

bool

instant

)

Implements SCR_ButtonEffectBase.

OnStateActivated()

override void SCR_ButtonEffectText.OnStateActivated

(

bool

instant

)

Implements SCR_ButtonEffectBase.

OnStateActivatedHovered()

override void SCR_ButtonEffectText.OnStateActivatedHovered

(

bool

instant

)

Implements SCR_ButtonEffectBase.

OnStateDefault()

override void SCR_ButtonEffectText.OnStateDefault

(

bool

instant

)

Implements SCR_ButtonEffectBase.

OnStateDisabled()

override void SCR_ButtonEffectText.OnStateDisabled

(

bool

instant

)

Implements SCR_ButtonEffectBase.

OnStateDisabledActivated()

override void SCR_ButtonEffectText.OnStateDisabledActivated

(

bool

instant

)

Implements SCR_ButtonEffectBase.

OnStateHovered()

override void SCR_ButtonEffectText.OnStateHovered

(

bool

instant

)

Implements SCR_ButtonEffectBase.

OnToggledOff()

override void SCR_ButtonEffectText.OnToggledOff

(

bool

instant

)

Implements SCR_ButtonEffectBase.

OnToggledOn()

override void SCR_ButtonEffectText.OnToggledOn

(

bool

instant

)

Implements SCR_ButtonEffectBase.

Member Data Documentation

m_sActivated

string SCR_ButtonEffectText.m_sActivated

m_sActivatedHovered

string SCR_ButtonEffectText.m_sActivatedHovered

m_sDefault

string SCR_ButtonEffectText.m_sDefault

m_sDisabled

string SCR_ButtonEffectText.m_sDisabled

m_sDisabledActivated

string SCR_ButtonEffectText.m_sDisabledActivated

m_sFocusGained

string SCR_ButtonEffectText.m_sFocusGained

m_sFocusLost

string SCR_ButtonEffectText.m_sFocusLost

m_sHovered

string SCR_ButtonEffectText.m_sHovered

m_sToggledOff

string SCR_ButtonEffectText.m_sToggledOff

m_sToggledOn

string SCR_ButtonEffectText.m_sToggledOn

---

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

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