SCR_SortHeaderComponent Interface Reference

Sort header manages multiple sort element components. More...

Inheritance diagram for SCR_SortHeaderComponent:

Public Member Functions
ESortOrder	GetSortOrder ()
bool	GetSortOrderAscending ()
	True when sort order is ASCENDING.
int	GetSortElementId ()
string	GetSortElementName ()
int	FindElement (string name)
	Finds element by name. Returns id, or -1 if not found.
void	SetCurrentSortElement (int id, ESortOrder order, bool useDefaultSortOrder=false, bool invokeOnChanged=true)
void	SetElementVisible (int id, bool visible)
Widget	GetRootWidget ()
void	SetFocus (int id)
	Sets focus on element with ID.

Public Attributes
int	m_iDefaultSortElement
ref ScriptInvoker	m_OnChanged = new ScriptInvoker

Protected Member Functions
override void	HandlerAttached (Widget w)
void	OnButtonClicked (SCR_ModularButtonComponent compClicked)
SCR_SortElementComponent	GetCurrentSortElement ()
void	InvokeOnChanged ()

Static Protected Member Functions
static void	FindAllSortButtons (Widget w, array< SCR_SortElementComponent > components)
	Find all sort button components recursively.

Protected Attributes
ref array< SCR_SortElementComponent >	m_aSortElements
Widget	m_wRoot

Detailed Description

Sort header manages multiple sort element components.

At init it scans its hierarchy for any sort elements. On clicks it ensures that only one sort element is toggled.

Member Function Documentation

FindAllSortButtons()

static void SCR_SortHeaderComponent.FindAllSortButtons ( Widget  w, array< SCR_SortElementComponent >  components  )

staticprotected

Find all sort button components recursively.

FindElement()

int SCR_SortHeaderComponent.FindElement

(

string

name

)

Finds element by name. Returns id, or -1 if not found.

GetCurrentSortElement()

SCR_SortElementComponent SCR_SortHeaderComponent.GetCurrentSortElement ( )

protected

GetRootWidget()

Widget SCR_SortHeaderComponent.GetRootWidget

(

)

GetSortElementId()

int SCR_SortHeaderComponent.GetSortElementId

(

)

GetSortElementName()

string SCR_SortHeaderComponent.GetSortElementName

(

)

GetSortOrder()

ESortOrder SCR_SortHeaderComponent.GetSortOrder

(

)

GetSortOrderAscending()

bool SCR_SortHeaderComponent.GetSortOrderAscending

(

)

True when sort order is ASCENDING.

HandlerAttached()

override void SCR_SortHeaderComponent.HandlerAttached ( Widget  w )

protected

InvokeOnChanged()

void SCR_SortHeaderComponent.InvokeOnChanged ( )

protected

OnButtonClicked()

void SCR_SortHeaderComponent.OnButtonClicked ( SCR_ModularButtonComponent  compClicked )

protected

SetCurrentSortElement()

void SCR_SortHeaderComponent.SetCurrentSortElement	(	int	id,
		ESortOrder	order,
		bool	useDefaultSortOrder = false,
		bool	invokeOnChanged = true
	)

SetElementVisible()

void SCR_SortHeaderComponent.SetElementVisible	(	int	id,
		bool	visible
	)

SetFocus()

void SCR_SortHeaderComponent.SetFocus

(

int

id

)

Sets focus on element with ID.

Member Data Documentation

m_aSortElements

ref array<SCR_SortElementComponent> SCR_SortHeaderComponent.m_aSortElements

protected

m_iDefaultSortElement

int SCR_SortHeaderComponent.m_iDefaultSortElement

m_OnChanged

ref ScriptInvoker SCR_SortHeaderComponent.m_OnChanged = new ScriptInvoker

m_wRoot

Widget SCR_SortHeaderComponent.m_wRoot

protected

---

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

• Game/UI/Components/WidgetLibrary/SCR_SortHeader/SCR_SortHeaderComponent.c