SCR_SortHeaderComponent Class Reference

Inheritance diagram for SCR_SortHeaderComponent:

Protected 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.
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.

Definition at line 7 of file SCR_SortHeaderComponent.c.

Member Function Documentation

FindAllSortButtons()

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

inlinestaticprotected

Find all sort button components recursively.

Definition at line 152 of file SCR_SortHeaderComponent.c.

FindElement()

int SCR_SortHeaderComponent::FindElement ( string name )

inlineprotected

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

Definition at line 65 of file SCR_SortHeaderComponent.c.

GetCurrentSortElement()

SCR_SortElementComponent SCR_SortHeaderComponent::GetCurrentSortElement ( )

inlineprotected

Definition at line 180 of file SCR_SortHeaderComponent.c.

GetRootWidget()

Widget SCR_SortHeaderComponent::GetRootWidget ( )

inlineprotected

Definition at line 111 of file SCR_SortHeaderComponent.c.

GetSortElementId()

int SCR_SortHeaderComponent::GetSortElementId ( )

inlineprotected

Definition at line 42 of file SCR_SortHeaderComponent.c.

GetSortElementName()

string SCR_SortHeaderComponent::GetSortElementName ( )

inlineprotected

Definition at line 53 of file SCR_SortHeaderComponent.c.

GetSortOrder()

ESortOrder SCR_SortHeaderComponent::GetSortOrder ( )

inlineprotected

Definition at line 24 of file SCR_SortHeaderComponent.c.

GetSortOrderAscending()

bool SCR_SortHeaderComponent::GetSortOrderAscending ( )

inlineprotected

True when sort order is ASCENDING.

Definition at line 36 of file SCR_SortHeaderComponent.c.

HandlerAttached()

void SCR_SortHeaderComponent::HandlerAttached ( Widget w )

inlineprotected

Definition at line 133 of file SCR_SortHeaderComponent.c.

InvokeOnChanged()

void SCR_SortHeaderComponent::InvokeOnChanged ( )

inlineprotected

Definition at line 191 of file SCR_SortHeaderComponent.c.

OnButtonClicked()

void SCR_SortHeaderComponent::OnButtonClicked ( SCR_ModularButtonComponent compClicked )

inlineprotected

Definition at line 167 of file SCR_SortHeaderComponent.c.

SetCurrentSortElement()

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

inlineprotected

Definition at line 78 of file SCR_SortHeaderComponent.c.

SetElementVisible()

void SCR_SortHeaderComponent::SetElementVisible ( int id, bool visible )

inlineprotected

Definition at line 102 of file SCR_SortHeaderComponent.c.

SetFocus()

void SCR_SortHeaderComponent::SetFocus ( int id )

inlineprotected

Sets focus on element with ID.

Definition at line 119 of file SCR_SortHeaderComponent.c.

Member Data Documentation

m_aSortElements

ref array<SCR_SortElementComponent> SCR_SortHeaderComponent::m_aSortElements

protected

Definition at line 15 of file SCR_SortHeaderComponent.c.

m_wRoot

Widget SCR_SortHeaderComponent::m_wRoot

protected

Definition at line 17 of file SCR_SortHeaderComponent.c.

---

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

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