Arma Reforger Explorer 1.7.0.54
Arma Reforger Code Explorer by Zeroy - Thanks to MisterOutofTime
Loading...
Searching...
No Matches
SCR_SortElementComponent Class Reference
Inheritance diagram for SCR_SortElementComponent:

Protected Member Functions

void SetSortOrder (ESortOrder order)
ESortOrder GetSortOrder ()
ESortOrder GetDefaultSortOrder ()
string GetName ()
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 ()

Protected Attributes

bool m_bSortOrderAscending
string m_sName
bool m_bSortSingleOrder
ESortOrder m_eDefaultSortOrder
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"

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.

Definition at line 19 of file SCR_SortElementComponent.c.

Member Function Documentation

◆ GetDefaultSortOrder()

ESortOrder SCR_SortElementComponent::GetDefaultSortOrder ( )
inlineprotected

Definition at line 87 of file SCR_SortElementComponent.c.

◆ GetName()

string SCR_SortElementComponent::GetName ( )
inlineprotected

Definition at line 93 of file SCR_SortElementComponent.c.

◆ GetSortOrder()

ESortOrder SCR_SortElementComponent::GetSortOrder ( )
inlineprotected

Definition at line 73 of file SCR_SortElementComponent.c.

◆ HandlerAttached()

override void SCR_SortElementComponent::HandlerAttached ( Widget w)
inlineprotected

Definition at line 104 of file SCR_SortElementComponent.c.

◆ Internal_SetToggled()

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

Definition at line 120 of file SCR_SortElementComponent.c.

◆ OnClick()

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

Definition at line 127 of file SCR_SortElementComponent.c.

◆ SelectNewSortOrder()

void SCR_SortElementComponent::SelectNewSortOrder ( bool reset)
inlineprotected

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

Definition at line 145 of file SCR_SortElementComponent.c.

◆ SetSortOrder()

void SCR_SortElementComponent::SetSortOrder ( ESortOrder order)
inlineprotected

Definition at line 45 of file SCR_SortElementComponent.c.

◆ UpdateSortEffects()

void SCR_SortElementComponent::UpdateSortEffects ( )
inlineprotected

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.

Definition at line 164 of file SCR_SortElementComponent.c.

Member Data Documentation

◆ m_bSortOrderAscending

bool SCR_SortElementComponent::m_bSortOrderAscending
protected

Definition at line 21 of file SCR_SortElementComponent.c.

◆ m_bSortSingleOrder

bool SCR_SortElementComponent::m_bSortSingleOrder
protected

Definition at line 27 of file SCR_SortElementComponent.c.

◆ m_eDefaultSortOrder

ESortOrder SCR_SortElementComponent::m_eDefaultSortOrder
protected

Definition at line 30 of file SCR_SortElementComponent.c.

◆ m_sName

string SCR_SortElementComponent::m_sName
protected

Definition at line 24 of file SCR_SortElementComponent.c.

◆ TAG_ALL

const string SCR_SortElementComponent::TAG_ALL = "all"
protected

Definition at line 33 of file SCR_SortElementComponent.c.

◆ TAG_SORT_ASC

const string SCR_SortElementComponent::TAG_SORT_ASC = "sort_asc"
protected

Definition at line 34 of file SCR_SortElementComponent.c.

◆ TAG_SORT_DESC

const string SCR_SortElementComponent::TAG_SORT_DESC = "sort_desc"
protected

Definition at line 35 of file SCR_SortElementComponent.c.

◆ TAG_SORT_NONE

const string SCR_SortElementComponent::TAG_SORT_NONE = "sort_none"
protected

Definition at line 36 of file SCR_SortElementComponent.c.

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