Enumerations
enum	EModularButtonState

Functions
enum EModularButtonState	Attribute ()] protected ref array< ref SCR_ButtonEffectBase > m_aEffects
void	SetEnabled (bool enabled)
bool	GetEnabled ()
void	SetToggled (bool toggled, bool invokeOnToggled=true, bool instant=false)
bool	GetToggled ()
bool	GetFocused ()
bool	GetMouseOver ()
void	SetToggleable (bool toggleable)
void	SetTogglableOnlyThroughApi (bool newValue)
void	SetData (Managed data)
Managed	GetData ()
Widget	GetRootWidget ()
bool	SetVisible (bool visible)
SCR_ButtonEffectBase	FindEffect (string tag)
array< SCR_ButtonEffectBase >	FindAllEffects (string tag)
array< SCR_ButtonEffectBase >	GetAllEffects ()
void	SetEffectsEnabled (string tag, bool enable)
void	SetEffectsWithAnyTagEnabled (notnull array< string > tags)
void	SetAllEffectsEnabled (bool enable)
void	InvokeAllEnabledEffects (bool instant)
void	UpdateCurrentState ()
	Checks current state, invokes state change effects if state has changed.
EModularButtonState	GetCurrentState ()
void	InvokeEffectsEvent (EModularButtonEventFlag eventFlag, bool instant=false)
void	Internal_OnMasterButtonEvent (EModularButtonEventFlag eventFlag, bool instant)
void	Internal_SetToggled (bool newToggled, bool invokeOnToggled=true, bool instant=false)
void	Internal_OnEffectEnabled (SCR_ButtonEffectBase effect)
override void	HandlerAttached (Widget w)
override bool	OnClick (Widget w, int x, int y, int button)
override bool	OnDoubleClick (Widget w, int x, int y, int button)
override bool	OnMouseEnter (Widget w, int x, int y)
override bool	OnMouseLeave (Widget w, Widget enterW, int x, int y)
override bool	OnFocus (Widget w, int x, int y)
override bool	OnFocusLost (Widget w, int x, int y)
void	_print (string s)
bool	GetIsFocusOnMouseEnter ()
void	SetIsFocusOnMouseEnter (bool focus)
string	GetCurrentStateName ()
void	IgnoreStandardInputs (bool ignore)

Variables
enum EModularButtonState	CLICK = 1 << 0
	Enum corresponding Enfusion native event types.
enum EModularButtonState	DOUBLE_CLICK = 1 << 1
enum EModularButtonState	FOCUS_GAINED = 1 << 2
enum EModularButtonState	FOCUS_LOST = 1 << 3
enum EModularButtonState	MOUSE_ENTER = 1 << 4
enum EModularButtonState	MOUSE_LEAVE = 1 << 5
	STATE_DEFAULT = 1 << 0
	Default state.
	STATE_HOVERED = 1 << 1
	Hovered.
	STATE_ACTIVATED = 1 << 2
	Activated.
	STATE_ACTIVATED_HOVERED = 1 << 3
	Activated and hovered.
	STATE_DISABLED = 1 << 4
	Disabled.
	STATE_DISABLED_ACTIVATED = 1 << 5
	Disabled and activated.
bool	m_bCanBeToggled
bool	m_bToggledOnlyThroughApi
bool	m_bToggledAtStart
EModularButtonEventHandler	m_eEventReturnValue
bool	m_bFocusOnMouseEnter
bool	m_bIgnoreStandardInputs
ref ScriptInvoker	m_OnClicked = new ScriptInvoker()
ref ScriptInvoker	m_OnDoubleClicked = new ScriptInvoker()
ref ScriptInvoker	m_OnToggled = new ScriptInvoker()
ref ScriptInvoker	m_OnFocus = new ScriptInvoker()
ref ScriptInvoker	m_OnFocusLost = new ScriptInvoker()
ref ScriptInvoker	m_OnMouseEnter = new ScriptInvoker()
ref ScriptInvoker	m_OnMouseLeave = new ScriptInvoker()
Widget	m_wRoot
bool	m_bFocus
bool	m_bMouseOver
bool	m_bToggled
EModularButtonState	m_eState
ref Managed	m_UserData

Enumeration Type Documentation

◆ EModularButtonState

enum EModularButtonState

These enum values correspond to change of button state, A button can only be in one state at a time

Definition at line 6 of file SCR_ModularButtonComponent.c.

Function Documentation

◆ _print()

void _print ( string s )

protected

Parameters

[in] s

Definition at line 678 of file SCR_ModularButtonComponent.c.

◆ FindAllEffects()

array< SCR_ButtonEffectBase > FindAllEffects ( string tag )

protected

Parameters

[in] tag

Returns: all effects with given tag

Definition at line 225 of file SCR_ModularButtonComponent.c.

◆ FindEffect()

SCR_ButtonEffectBase FindEffect ( string tag )

protected

Returns first effect with given tag

Parameters

[in] tag

Returns

Definition at line 211 of file SCR_ModularButtonComponent.c.

◆ GetAllEffects()

array< SCR_ButtonEffectBase > GetAllEffects ( )

protected

Returns: all effects

Definition at line 239 of file SCR_ModularButtonComponent.c.

◆ GetCurrentState()

EModularButtonState GetCurrentState ( )

protected

Returns: Enum with current state value

Definition at line 347 of file SCR_ModularButtonComponent.c.

◆ GetCurrentStateName()

string GetCurrentStateName ( )

protected

Returns

Definition at line 699 of file SCR_ModularButtonComponent.c.

◆ GetData()

Managed GetData ( )

protected

Returns

Definition at line 182 of file SCR_ModularButtonComponent.c.

◆ GetEnabled()

bool GetEnabled ( )

protected

Returns

Definition at line 118 of file SCR_ModularButtonComponent.c.

◆ GetFocused()

bool GetFocused ( )

protected

Returns

Definition at line 147 of file SCR_ModularButtonComponent.c.

◆ GetIsFocusOnMouseEnter()

bool GetIsFocusOnMouseEnter ( )

protected

Returns

Definition at line 685 of file SCR_ModularButtonComponent.c.

◆ GetMouseOver()

bool GetMouseOver ( )

protected

Returns

Definition at line 154 of file SCR_ModularButtonComponent.c.

◆ GetRootWidget()

Widget GetRootWidget ( )

protected

Returns

Definition at line 189 of file SCR_ModularButtonComponent.c.

◆ GetToggled()

bool GetToggled ( )

protected

Returns

Definition at line 140 of file SCR_ModularButtonComponent.c.

◆ HandlerAttached()

override void HandlerAttached ( Widget w )

protected

Definition at line 472 of file SCR_ModularButtonComponent.c.

◆ IgnoreStandardInputs()

void IgnoreStandardInputs ( bool ignore )

protected

Definition at line 705 of file SCR_ModularButtonComponent.c.

◆ Internal_OnEffectEnabled()

void Internal_OnEffectEnabled ( SCR_ButtonEffectBase effect )

protected

Must only be called by the effect class

Parameters

[in] effect

Definition at line 449 of file SCR_ModularButtonComponent.c.

◆ Internal_OnMasterButtonEvent()

void Internal_OnMasterButtonEvent	(	EModularButtonEventFlag	eventFlag,
		bool	instant )

protected

Used for passing events from master button / slave button This is called on a slave button by SCR_ButtonEffectSlaveButton

Parameters

[in]	eventFlag
[in]	instant

Definition at line 421 of file SCR_ModularButtonComponent.c.

◆ Internal_SetToggled()

void Internal_SetToggled	(	bool	newToggled,
		bool	invokeOnToggled = true,
		bool	instant = false )

protected

Definition at line 427 of file SCR_ModularButtonComponent.c.

◆ InvokeAllEnabledEffects()

void InvokeAllEnabledEffects ( bool instant )

protected

Applies all enabled effects. Param instant should be true for changes to an effect's setting while it is active (eg: change the focused color while element is focused) If instant == false, it's like retriggering the event, eg element simulates being focused again

Parameters

[in] instant

Definition at line 308 of file SCR_ModularButtonComponent.c.