Element of a listbox. More...

Inheritance diagram for SCR_ListBoxElementComponent:

Public Member Functions
override void	HandlerAttached (Widget w)

void	SetImage (ResourceName imageOrImageset, string iconName)

void	SetText (string text)

Public Member Functions inherited from SCR_ModularButtonComponent
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)
	Returns first effect with given tag.

array< SCR_ButtonEffectBase >	FindAllEffects (string tag)

array< SCR_ButtonEffectBase >	GetAllEffects ()

void	SetEffectsEnabled (string tag, bool enable)
	Enables or disables all effects with given tag.

void	SetEffectsWithAnyTagEnabled (notnull array< string > tags)
	Effects with at least one tag are enabled.

void	SetAllEffectsEnabled (bool enable)
	Enables ar disables all effects.

void	InvokeAllEnabledEffects (bool instant)
	Applies all enabled effects.

void	Internal_OnMasterButtonEvent (EModularButtonEventFlag eventFlag, bool instant)
	Used for passing events from master button / slave button This is called on a slave button by SCR_ButtonEffectSlaveButton.

void	Internal_OnEffectEnabled (SCR_ButtonEffectBase effect)
	Must only be called by the effect class.

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 ()

Protected Attributes
string	m_sWidgetImageName

string	m_sWidgetTextName

Protected Attributes inherited from SCR_ModularButtonComponent
ref array< ref SCR_ButtonEffectBase >	m_aEffects

bool	m_bCanBeToggled

bool	m_bToggledOnlyThroughApi

bool	m_bToggledAtStart

EModularButtonEventHandler	m_eEventReturnValue

bool	m_bFocusOnMouseEnter

bool	m_bIgnoreStandardInputs

Widget	m_wRoot

bool	m_bFocus

bool	m_bMouseOver

bool	m_bToggled

EModularButtonState	m_eState

ref Managed	m_UserData

Additional Inherited Members
Static Public Member Functions inherited from SCR_ModularButtonComponent
static SCR_ModularButtonComponent	FindComponent (Widget w)
	Finds SCR_ModularButtonComponent on a widget.

Public Attributes inherited from SCR_ModularButtonComponent
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()

Protected Member Functions inherited from SCR_ModularButtonComponent
void	UpdateCurrentState ()
	Checks current state, invokes state change effects if state has changed.

EModularButtonState	GetCurrentState ()

void	InvokeEffectsEvent (EModularButtonEventFlag eventFlag, bool instant=false)
	Calls _OnEvent of all enabled effects.

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

Detailed Description

Element of a listbox.

Member Function Documentation

◆ HandlerAttached()

override void SCR_ListBoxElementComponent.HandlerAttached ( Widget w )

Implements SCR_ModularButtonComponent.

◆ SetImage()

void SCR_ListBoxElementComponent.SetImage	(	ResourceName	imageOrImageset,
		string	iconName )

Parameters

[in]	imageOrImageset
[in]	iconName

◆ SetText()

void SCR_ListBoxElementComponent.SetText ( string text )

Parameters

[in] text

Member Data Documentation

◆ m_sWidgetImageName

string SCR_ListBoxElementComponent.m_sWidgetImageName

protected

◆ m_sWidgetTextName

string SCR_ListBoxElementComponent.m_sWidgetTextName

protected

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

Game/UI/Components/ListBox/SCR_ListBoxElementComponent.c

Public Member Functions

Protected Attributes

Additional Inherited Members