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

Protected Member Functions

SCR_FilterSet GetFilter ()
SCR_EditBoxSearchComponent GetEditBoxSearch ()
bool AnyFilterSelected ()
bool AnyFilterButtonsVisible ()
bool SetEditBoxSearchMessage (string message)
void SetItemsFoundMessage (int current, int total, bool enabled=true)
void ShowFilterListBox (bool show, bool animate=false)
bool GetFilterListBoxShown ()
void SelectFilter (SCR_FilterEntry filter, bool select, bool invokeOnChanged=true, bool instant=false)
void Save (string tag=string.Empty)
void ResetToDefaultValues ()
void EnableFilterButton (bool enable)
bool GetFilterButtonEnabled ()
bool TryLoad (string tag=string.Empty)
string GetStorageTag ()
bool GetFocused ()
void SetFocusOnFirstItem ()
SCR_FilterPanelWidgets GetWidgets ()
ScriptInvokerFilter GetOnFilterChanged ()
ScriptInvokerBool GetOnFilterPanelToggled ()
void SetItemsFoundMessageVisible (bool visible)
void EnableItemsFoundMessage (bool enabled=false)
void Filter_ListBox_EnableFilter (SCR_FilterEntry filter, bool enabled, bool instant=false)
void Filter_ListBox_ResetFiltersInCategory (SCR_FilterCategory category, SCR_FilterEntry filterExclude)
void Filter_TopBar_DeleteButton (SCR_FilterEntry filter)
void Filter_TopBar_DeleteButtonsInCategory (SCR_FilterCategory category)
void Filter_TopBar_AddButton (SCR_FilterEntry filter)
void Filter_TopBar_UpdateButtonsVisibility ()
void Filter_InitFilterPanel ()
 Fills the listbox with categories and filters.
void SyncUiToInternal ()
 Updates internal values from UI.
void SyncInternalToUi ()
 Updates UI from internal values.
void ShowFilterListBox_Internal (bool show, bool animate=false)
void OnTopBarHighlightCycleCompleted ()
void OnTopBarFilterButtonClicked (SCR_ModularButtonComponent comp)
void OnTopBarFilterButtonFocused (SCR_ModularButtonComponent comp)
void OnTopBarFilterButtonFocusLost (SCR_ModularButtonComponent comp)
void OnFilterListBoxChanged (SCR_ListBoxComponent comp, int item, bool newSelected)
void OnToggleFilterPanelButton (SCR_ModularButtonComponent comp, bool newToggled)
void OnSearchConfirm (SCR_EditBoxComponent comp, string value)
override void HandlerAttached (Widget w)
override void HandlerDeattached (Widget w)
void OnTooltipShow (SCR_ScriptedWidgetTooltip tooltip)
void UpdateItemsFoundTooltip ()
void FillTooltip (SCR_ScriptedWidgetTooltip tooltip)
bool IsTooltipHoverWidgetInHierarchy ()
void ResetTooltipInitializationFlags ()

Protected Attributes

ResourceName m_sTopBarFilterButtonLayout
string m_sTopBarFilterButtonIconName
string m_sTopBarFilterButtonIconGlowName
string m_sTopBarFilterButtonTooltipTag
string m_sTopBarHiddenFiltersTooltipTag
string m_sTopBarItemsFoundTooltipTag
string m_sTopBarItemsFoundTooltipMessage
ref SCR_FilterSet m_FilterSet
int m_iMaxFilterButtons
bool m_bFilterShownAtStart
string m_sFilterSetStorageTag
ResourceName m_sElementLayoutMututallyExclusive
ResourceName m_sElementLayoutGeneral
float m_fTobBarHighlightOpacity
float m_fTopBarHighlightAnimationSpeed
int m_iTopBarHighlightAnimationCycles
EAnimationCurve m_eTopBarHighlightAnimationCurve
EAnimationCurve m_eTopBarHighlightAnimationCurveReverse
ref SCR_FilterPanelWidgets m_Widgets = new SCR_FilterPanelWidgets()
SCR_FilterEntry m_FocusedTopBarFilter
ref array< SCR_FilterEntry > m_aHiddenFilters = {}
int m_iTopBarHighlightCycle
WidgetAnimationOpacity m_TopBarAnimation
ref ScriptInvokerFilter m_OnFilterChanged
ref ScriptInvokerBool m_OnFilterPanelToggled
const string ITEMS_FOUND_MESSAGE = "#AR-Filters_EntriesFound_Condensed"
bool m_bItemsFoundMessageEnabled
int m_iEntriesFiltered
int m_iEntriesTotal
SCR_ScriptedWidgetTooltip m_ItemsFoundTooltip
bool m_bIsTooltipHoverWidgetInHierarchy
bool m_bIsTooltipInitialized
SCR_ScriptedWidgetTooltip m_Tooltip

Static Protected Attributes

static ref array< SCR_FilterPanelComponent > m_aActiveFilterPanels = {}

Detailed Description

Filter panel component which is commonly found in content browser, scenarios menu, and other places.

It controls a filter list box and a set of filter buttons which are added to the top bar when filter items are selected. When we click on these buttons, they are removed and the according filter in the list is disabled.

So, this panel just keeps the list box and buttons synchronized. Use the public API to get selected filters.

Definition at line 11 of file SCR_FilterPanelComponent.c.

Member Function Documentation

◆ AnyFilterButtonsVisible()

bool SCR_FilterPanelComponent::AnyFilterButtonsVisible ( )
inlineprotected
Returns

Definition at line 121 of file SCR_FilterPanelComponent.c.

◆ AnyFilterSelected()

bool SCR_FilterPanelComponent::AnyFilterSelected ( )
inlineprotected
Returns

Definition at line 113 of file SCR_FilterPanelComponent.c.

◆ EnableFilterButton()

void SCR_FilterPanelComponent::EnableFilterButton ( bool enable)
inlineprotected
Parameters
[in]enable

Definition at line 236 of file SCR_FilterPanelComponent.c.

◆ EnableItemsFoundMessage()

void SCR_FilterPanelComponent::EnableItemsFoundMessage ( bool enabled = false)
inlineprotected

Definition at line 349 of file SCR_FilterPanelComponent.c.

◆ FillTooltip()

void SCR_FilterPanelComponent::FillTooltip ( SCR_ScriptedWidgetTooltip tooltip)
inlineprotected
Parameters
[in]tooltip

Definition at line 916 of file SCR_FilterPanelComponent.c.

◆ Filter_InitFilterPanel()

void SCR_FilterPanelComponent::Filter_InitFilterPanel ( )
inlineprotected

Fills the listbox with categories and filters.

Definition at line 580 of file SCR_FilterPanelComponent.c.

◆ Filter_ListBox_EnableFilter()

void SCR_FilterPanelComponent::Filter_ListBox_EnableFilter ( SCR_FilterEntry filter,
bool enabled,
bool instant = false )
inlineprotected

Enables/disables this filter in the list box

Parameters
[in]filter
[in]enabled

Definition at line 360 of file SCR_FilterPanelComponent.c.

◆ Filter_ListBox_ResetFiltersInCategory()

void SCR_FilterPanelComponent::Filter_ListBox_ResetFiltersInCategory ( SCR_FilterCategory category,
SCR_FilterEntry filterExclude )
inlineprotected

Resets filters in category, all except for one filter, if it is not null

Parameters
[in]category
[in]filterExclude

Definition at line 375 of file SCR_FilterPanelComponent.c.

◆ Filter_TopBar_AddButton()

void SCR_FilterPanelComponent::Filter_TopBar_AddButton ( SCR_FilterEntry filter)
inlineprotected

Adds a top bar filter button, links it with this filter category and filter

Parameters
[in]filter

Definition at line 480 of file SCR_FilterPanelComponent.c.

◆ Filter_TopBar_DeleteButton()

void SCR_FilterPanelComponent::Filter_TopBar_DeleteButton ( SCR_FilterEntry filter)
inlineprotected

Deletes a button which matches given category and filter

Parameters
[in]filter

Definition at line 392 of file SCR_FilterPanelComponent.c.

◆ Filter_TopBar_DeleteButtonsInCategory()

void SCR_FilterPanelComponent::Filter_TopBar_DeleteButtonsInCategory ( SCR_FilterCategory category)
inlineprotected

Deletes all buttons which are linked to filters of given category

Parameters
[in]category

Definition at line 453 of file SCR_FilterPanelComponent.c.

◆ Filter_TopBar_UpdateButtonsVisibility()

void SCR_FilterPanelComponent::Filter_TopBar_UpdateButtonsVisibility ( )
inlineprotected

Hides latest buttons if there are above m_iMaxFilterButtons buttons. Also updates the text of extra button count.

Definition at line 526 of file SCR_FilterPanelComponent.c.

◆ GetEditBoxSearch()

SCR_EditBoxSearchComponent SCR_FilterPanelComponent::GetEditBoxSearch ( )
inlineprotected
Returns
the component of the search edit box

Definition at line 105 of file SCR_FilterPanelComponent.c.

◆ GetFilter()

SCR_FilterSet SCR_FilterPanelComponent::GetFilter ( )
inlineprotected
Returns

Definition at line 98 of file SCR_FilterPanelComponent.c.

◆ GetFilterButtonEnabled()

bool SCR_FilterPanelComponent::GetFilterButtonEnabled ( )
inlineprotected
Returns

Definition at line 243 of file SCR_FilterPanelComponent.c.

◆ GetFilterListBoxShown()

bool SCR_FilterPanelComponent::GetFilterListBoxShown ( )
inlineprotected
Returns

Definition at line 181 of file SCR_FilterPanelComponent.c.

◆ GetFocused()

bool SCR_FilterPanelComponent::GetFocused ( )
inlineprotected
Returns
true when anything inside the filter panel is focused

Definition at line 279 of file SCR_FilterPanelComponent.c.

◆ GetOnFilterChanged()

ScriptInvokerFilter SCR_FilterPanelComponent::GetOnFilterChanged ( )
inlineprotected
Returns

Definition at line 315 of file SCR_FilterPanelComponent.c.

◆ GetOnFilterPanelToggled()

ScriptInvokerBool SCR_FilterPanelComponent::GetOnFilterPanelToggled ( )
inlineprotected
Returns

Definition at line 325 of file SCR_FilterPanelComponent.c.

◆ GetStorageTag()

string SCR_FilterPanelComponent::GetStorageTag ( )
inlineprotected
Returns

Definition at line 272 of file SCR_FilterPanelComponent.c.

◆ GetWidgets()

SCR_FilterPanelWidgets SCR_FilterPanelComponent::GetWidgets ( )
inlineprotected
Returns

Definition at line 308 of file SCR_FilterPanelComponent.c.

◆ HandlerAttached()

override void SCR_FilterPanelComponent::HandlerAttached ( Widget w)
inlineprotected

Definition at line 807 of file SCR_FilterPanelComponent.c.

◆ HandlerDeattached()

override void SCR_FilterPanelComponent::HandlerDeattached ( Widget w)
inlineprotected

Definition at line 831 of file SCR_FilterPanelComponent.c.

◆ IsTooltipHoverWidgetInHierarchy()

bool SCR_FilterPanelComponent::IsTooltipHoverWidgetInHierarchy ( )
inlineprotected
Returns

Definition at line 976 of file SCR_FilterPanelComponent.c.

◆ OnFilterListBoxChanged()

void SCR_FilterPanelComponent::OnFilterListBoxChanged ( SCR_ListBoxComponent comp,
int item,
bool newSelected )
inlineprotected

Called when filter listbox selection changes

Parameters
[in]comp
[in]item
[in]newSelected

Definition at line 757 of file SCR_FilterPanelComponent.c.

◆ OnSearchConfirm()

void SCR_FilterPanelComponent::OnSearchConfirm ( SCR_EditBoxComponent comp,
string value )
inlineprotected

Definition at line 799 of file SCR_FilterPanelComponent.c.

◆ OnToggleFilterPanelButton()

void SCR_FilterPanelComponent::OnToggleFilterPanelButton ( SCR_ModularButtonComponent comp,
bool newToggled )
inlineprotected

Definition at line 793 of file SCR_FilterPanelComponent.c.

◆ OnTooltipShow()

void SCR_FilterPanelComponent::OnTooltipShow ( SCR_ScriptedWidgetTooltip tooltip)
inlineprotected

Definition at line 846 of file SCR_FilterPanelComponent.c.

◆ OnTopBarFilterButtonClicked()

void SCR_FilterPanelComponent::OnTopBarFilterButtonClicked ( SCR_ModularButtonComponent comp)
inlineprotected

Called when top bar filter button is clicked Button is deleted, according filter in the listbox is unchecked

Parameters
[in]comp

Definition at line 704 of file SCR_FilterPanelComponent.c.

◆ OnTopBarFilterButtonFocused()

void SCR_FilterPanelComponent::OnTopBarFilterButtonFocused ( SCR_ModularButtonComponent comp)
inlineprotected

Definition at line 741 of file SCR_FilterPanelComponent.c.

◆ OnTopBarFilterButtonFocusLost()

void SCR_FilterPanelComponent::OnTopBarFilterButtonFocusLost ( SCR_ModularButtonComponent comp)
inlineprotected

Definition at line 747 of file SCR_FilterPanelComponent.c.

◆ OnTopBarHighlightCycleCompleted()

void SCR_FilterPanelComponent::OnTopBarHighlightCycleCompleted ( )
inlineprotected

Definition at line 682 of file SCR_FilterPanelComponent.c.

◆ ResetToDefaultValues()

void SCR_FilterPanelComponent::ResetToDefaultValues ( )
inlineprotected

Definition at line 227 of file SCR_FilterPanelComponent.c.

◆ ResetTooltipInitializationFlags()

void SCR_FilterPanelComponent::ResetTooltipInitializationFlags ( )
inlineprotected

Definition at line 983 of file SCR_FilterPanelComponent.c.

◆ Save()

void SCR_FilterPanelComponent::Save ( string tag = string.Empty)
inlineprotected

Saves the filter configuration in user settings.

Parameters
[in]tagoptional parameter, a tag used for saving the filter. if tag is not provided, the internal m_sFilterSetStorageTag is used from the attribute.

Definition at line 213 of file SCR_FilterPanelComponent.c.

◆ SelectFilter()

void SCR_FilterPanelComponent::SelectFilter ( SCR_FilterEntry filter,
bool select,
bool invokeOnChanged = true,
bool instant = false )
inlineprotected

Selects or deselects the filter visually. !!! Does not update the internal state of the filter. You still need to call filter.SetSelected();

Parameters
[in]filter
[in]select
[in]invokeOnChanged

Definition at line 192 of file SCR_FilterPanelComponent.c.

◆ SetEditBoxSearchMessage()

bool SCR_FilterPanelComponent::SetEditBoxSearchMessage ( string message)
inlineprotected
Parameters
[in]message
Returns

Definition at line 138 of file SCR_FilterPanelComponent.c.

◆ SetFocusOnFirstItem()

void SCR_FilterPanelComponent::SetFocusOnFirstItem ( )
inlineprotected

Definition at line 301 of file SCR_FilterPanelComponent.c.

◆ SetItemsFoundMessage()

void SCR_FilterPanelComponent::SetItemsFoundMessage ( int current,
int total,
bool enabled = true )
inlineprotected
Parameters
[in]current
[in]total
[in]enabled

Definition at line 150 of file SCR_FilterPanelComponent.c.

◆ SetItemsFoundMessageVisible()

void SCR_FilterPanelComponent::SetItemsFoundMessageVisible ( bool visible)
inlineprotected

Definition at line 340 of file SCR_FilterPanelComponent.c.

◆ ShowFilterListBox()

void SCR_FilterPanelComponent::ShowFilterListBox ( bool show,
bool animate = false )
inlineprotected

Shows either the main content of the panel or the filter

Parameters
[in]show
[in]animate

Definition at line 170 of file SCR_FilterPanelComponent.c.

◆ ShowFilterListBox_Internal()

void SCR_FilterPanelComponent::ShowFilterListBox_Internal ( bool show,
bool animate = false )
inlineprotected

Shows either the main content of the panel or the filter

Parameters
[in]show
[in]animate

Definition at line 657 of file SCR_FilterPanelComponent.c.

◆ SyncInternalToUi()

void SCR_FilterPanelComponent::SyncInternalToUi ( )
inlineprotected

Updates UI from internal values.

Definition at line 636 of file SCR_FilterPanelComponent.c.

◆ SyncUiToInternal()

void SCR_FilterPanelComponent::SyncUiToInternal ( )
inlineprotected

Updates internal values from UI.

Definition at line 619 of file SCR_FilterPanelComponent.c.

◆ TryLoad()

bool SCR_FilterPanelComponent::TryLoad ( string tag = string.Empty)
inlineprotected

Tries to load filter values. If fails, it restores the filter to default state.

Parameters
[in]tagoptional parameter, a tag used for saving the filter. if tag is not provided, the internal m_sFilterSetStorageTag is used from the attribute.
Returns

Definition at line 253 of file SCR_FilterPanelComponent.c.

◆ UpdateItemsFoundTooltip()

void SCR_FilterPanelComponent::UpdateItemsFoundTooltip ( )
inlineprotected

Definition at line 901 of file SCR_FilterPanelComponent.c.

Member Data Documentation

◆ ITEMS_FOUND_MESSAGE

const string SCR_FilterPanelComponent::ITEMS_FOUND_MESSAGE = "#AR-Filters_EntriesFound_Condensed"
protected

Definition at line 81 of file SCR_FilterPanelComponent.c.

◆ m_aActiveFilterPanels

ref array<SCR_FilterPanelComponent> SCR_FilterPanelComponent::m_aActiveFilterPanels = {}
staticprotected

Definition at line 92 of file SCR_FilterPanelComponent.c.

◆ m_aHiddenFilters

ref array<SCR_FilterEntry> SCR_FilterPanelComponent::m_aHiddenFilters = {}
protected

Definition at line 70 of file SCR_FilterPanelComponent.c.

◆ m_bFilterShownAtStart

bool SCR_FilterPanelComponent::m_bFilterShownAtStart
protected

Definition at line 41 of file SCR_FilterPanelComponent.c.

◆ m_bIsTooltipHoverWidgetInHierarchy

bool SCR_FilterPanelComponent::m_bIsTooltipHoverWidgetInHierarchy
protected

Definition at line 87 of file SCR_FilterPanelComponent.c.

◆ m_bIsTooltipInitialized

bool SCR_FilterPanelComponent::m_bIsTooltipInitialized
protected

Definition at line 88 of file SCR_FilterPanelComponent.c.

◆ m_bItemsFoundMessageEnabled

bool SCR_FilterPanelComponent::m_bItemsFoundMessageEnabled
protected

Definition at line 82 of file SCR_FilterPanelComponent.c.

◆ m_eTopBarHighlightAnimationCurve

EAnimationCurve SCR_FilterPanelComponent::m_eTopBarHighlightAnimationCurve
protected

Definition at line 62 of file SCR_FilterPanelComponent.c.

◆ m_eTopBarHighlightAnimationCurveReverse

EAnimationCurve SCR_FilterPanelComponent::m_eTopBarHighlightAnimationCurveReverse
protected

Definition at line 65 of file SCR_FilterPanelComponent.c.

◆ m_FilterSet

ref SCR_FilterSet SCR_FilterPanelComponent::m_FilterSet
protected

Definition at line 35 of file SCR_FilterPanelComponent.c.

◆ m_FocusedTopBarFilter

SCR_FilterEntry SCR_FilterPanelComponent::m_FocusedTopBarFilter
protected

Definition at line 68 of file SCR_FilterPanelComponent.c.

◆ m_fTobBarHighlightOpacity

float SCR_FilterPanelComponent::m_fTobBarHighlightOpacity
protected

Definition at line 53 of file SCR_FilterPanelComponent.c.

◆ m_fTopBarHighlightAnimationSpeed

float SCR_FilterPanelComponent::m_fTopBarHighlightAnimationSpeed
protected

Definition at line 56 of file SCR_FilterPanelComponent.c.

◆ m_iEntriesFiltered

int SCR_FilterPanelComponent::m_iEntriesFiltered
protected

Definition at line 83 of file SCR_FilterPanelComponent.c.

◆ m_iEntriesTotal

int SCR_FilterPanelComponent::m_iEntriesTotal
protected

Definition at line 84 of file SCR_FilterPanelComponent.c.

◆ m_iMaxFilterButtons

int SCR_FilterPanelComponent::m_iMaxFilterButtons
protected

Definition at line 38 of file SCR_FilterPanelComponent.c.

◆ m_ItemsFoundTooltip

SCR_ScriptedWidgetTooltip SCR_FilterPanelComponent::m_ItemsFoundTooltip
protected

Definition at line 85 of file SCR_FilterPanelComponent.c.

◆ m_iTopBarHighlightAnimationCycles

int SCR_FilterPanelComponent::m_iTopBarHighlightAnimationCycles
protected

Definition at line 59 of file SCR_FilterPanelComponent.c.

◆ m_iTopBarHighlightCycle

int SCR_FilterPanelComponent::m_iTopBarHighlightCycle
protected

Definition at line 73 of file SCR_FilterPanelComponent.c.

◆ m_OnFilterChanged

ref ScriptInvokerFilter SCR_FilterPanelComponent::m_OnFilterChanged
protected

Definition at line 77 of file SCR_FilterPanelComponent.c.

◆ m_OnFilterPanelToggled

ref ScriptInvokerBool SCR_FilterPanelComponent::m_OnFilterPanelToggled
protected

Definition at line 78 of file SCR_FilterPanelComponent.c.

◆ m_sElementLayoutGeneral

ResourceName SCR_FilterPanelComponent::m_sElementLayoutGeneral
protected

Definition at line 50 of file SCR_FilterPanelComponent.c.

◆ m_sElementLayoutMututallyExclusive

ResourceName SCR_FilterPanelComponent::m_sElementLayoutMututallyExclusive
protected

Definition at line 47 of file SCR_FilterPanelComponent.c.

◆ m_sFilterSetStorageTag

string SCR_FilterPanelComponent::m_sFilterSetStorageTag
protected

Definition at line 44 of file SCR_FilterPanelComponent.c.

◆ m_sTopBarFilterButtonIconGlowName

string SCR_FilterPanelComponent::m_sTopBarFilterButtonIconGlowName
protected

Definition at line 20 of file SCR_FilterPanelComponent.c.

◆ m_sTopBarFilterButtonIconName

string SCR_FilterPanelComponent::m_sTopBarFilterButtonIconName
protected

Definition at line 17 of file SCR_FilterPanelComponent.c.

◆ m_sTopBarFilterButtonLayout

ResourceName SCR_FilterPanelComponent::m_sTopBarFilterButtonLayout
protected

Definition at line 14 of file SCR_FilterPanelComponent.c.

◆ m_sTopBarFilterButtonTooltipTag

string SCR_FilterPanelComponent::m_sTopBarFilterButtonTooltipTag
protected

Definition at line 23 of file SCR_FilterPanelComponent.c.

◆ m_sTopBarHiddenFiltersTooltipTag

string SCR_FilterPanelComponent::m_sTopBarHiddenFiltersTooltipTag
protected

Definition at line 26 of file SCR_FilterPanelComponent.c.

◆ m_sTopBarItemsFoundTooltipMessage

string SCR_FilterPanelComponent::m_sTopBarItemsFoundTooltipMessage
protected

Definition at line 32 of file SCR_FilterPanelComponent.c.

◆ m_sTopBarItemsFoundTooltipTag

string SCR_FilterPanelComponent::m_sTopBarItemsFoundTooltipTag
protected

Definition at line 29 of file SCR_FilterPanelComponent.c.

◆ m_Tooltip

SCR_ScriptedWidgetTooltip SCR_FilterPanelComponent::m_Tooltip
protected

Definition at line 90 of file SCR_FilterPanelComponent.c.

◆ m_TopBarAnimation

WidgetAnimationOpacity SCR_FilterPanelComponent::m_TopBarAnimation
protected

Definition at line 74 of file SCR_FilterPanelComponent.c.

◆ m_Widgets

ref SCR_FilterPanelWidgets SCR_FilterPanelComponent::m_Widgets = new SCR_FilterPanelWidgets()
protected

Definition at line 67 of file SCR_FilterPanelComponent.c.

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