Sort element must be placed on a widget inside a sort header. More...

Inheritance diagram for SCR_SortElementComponent:

Public Member Functions
void	SetSortOrder (ESortOrder order)

ESortOrder	GetSortOrder ()

ESortOrder	GetDefaultSortOrder ()

string	GetName ()

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

Static Public Attributes
const string	TAG_ALL = "all"

const string	TAG_SORT_ASC = "sort_asc"

const string	TAG_SORT_DESC = "sort_desc"

const string	TAG_SORT_NONE = "sort_none"

Protected Member Functions
override void	HandlerAttached (Widget w)

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

override bool	OnClick (Widget w, int x, int y, int button)

void	SelectNewSortOrder (bool reset)
	Selects new sort order, either default or flips prev. sort order.

void	UpdateSortEffects ()
	Enables effects according to new sort order and toggled state: When not toggled, only effects with TAG_ALL are enabled.

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)

Protected Attributes
bool	m_bSortOrderAscending

string	m_sName

bool	m_bSortSingleOrder

ESortOrder	m_eDefaultSortOrder

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

Detailed Description

Sort element must be placed on a widget inside a sort header.

The sort element visualizes sort order by using effects with different tags:

Effects with "all" tag are always active;
Effects with "sort_desc" and "sort_asc" are active only when sorting in specific direction;
Effects with "sort_none" are active when not sorting in any direciton.

!!! When any sorting is selected, button is in "toggled on" state. When no sorting, button is in "toggled off" state. Therefore effects must be configured accordingly, and proper states must be used in effect configuration.

Member Function Documentation

◆ GetDefaultSortOrder()

ESortOrder SCR_SortElementComponent.GetDefaultSortOrder ( )

◆ GetName()

string SCR_SortElementComponent.GetName ( )

◆ GetSortOrder()

ESortOrder SCR_SortElementComponent.GetSortOrder ( )

◆ HandlerAttached()

override void SCR_SortElementComponent.HandlerAttached ( Widget w )

protected

Implements SCR_ModularButtonComponent.

◆ Internal_SetToggled()

override void SCR_SortElementComponent.Internal_SetToggled	(	bool	newToggled,
		bool	invokeOnToggled = `true`,
		bool	instant = `false`
	)

protected

Implements SCR_ModularButtonComponent.

◆ OnClick()

override bool SCR_SortElementComponent.OnClick	(	Widget	w,
		int	x,
		int	y,
		int	button
	)

protected

Implements SCR_ModularButtonComponent.

◆ SelectNewSortOrder()

void SCR_SortElementComponent.SelectNewSortOrder ( bool reset )

protected

Selects new sort order, either default or flips prev. sort order.

◆ SetSortOrder()

void SCR_SortElementComponent.SetSortOrder ( ESortOrder order )

◆ UpdateSortEffects()

void SCR_SortElementComponent.UpdateSortEffects ( )

protected

Enables effects according to new sort order and toggled state: When not toggled, only effects with TAG_ALL are enabled.

When toggled, also effects with TAG_SORT_DESC or TAG_SORT_ASC are enabled.

Member Data Documentation

◆ m_bSortOrderAscending

bool SCR_SortElementComponent.m_bSortOrderAscending

protected

◆ m_bSortSingleOrder

bool SCR_SortElementComponent.m_bSortSingleOrder

protected

◆ m_eDefaultSortOrder

ESortOrder SCR_SortElementComponent.m_eDefaultSortOrder

protected

◆ m_sName

string SCR_SortElementComponent.m_sName

protected

◆ TAG_ALL

const string SCR_SortElementComponent.TAG_ALL = "all"

static

◆ TAG_SORT_ASC

const string SCR_SortElementComponent.TAG_SORT_ASC = "sort_asc"

static

◆ TAG_SORT_DESC

const string SCR_SortElementComponent.TAG_SORT_DESC = "sort_desc"

static

◆ TAG_SORT_NONE

const string SCR_SortElementComponent.TAG_SORT_NONE = "sort_none"

static

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

Game/UI/Components/WidgetLibrary/SCR_SortHeader/SCR_SortElementComponent.c

Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ GetDefaultSortOrder()

◆ GetName()

◆ GetSortOrder()

◆ HandlerAttached()

◆ Internal_SetToggled()

◆ OnClick()

◆ SelectNewSortOrder()

◆ SetSortOrder()

◆ UpdateSortEffects()

Member Data Documentation

◆ m_bSortOrderAscending

◆ m_bSortSingleOrder

◆ m_eDefaultSortOrder

◆ m_sName

◆ TAG_ALL

◆ TAG_SORT_ASC

◆ TAG_SORT_DESC

◆ TAG_SORT_NONE