Arma Reforger Script API
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
SCR_BasePaginationUIComponent Interface Reference
Inheritance diagram for SCR_BasePaginationUIComponent:
[legend]

Public Member Functions

int GetEntryCount ()
 Return total number of entries.
 
int GetRows ()
 
int GetColumns ()
 
int GetCurrentPage ()
 
int GetEntryIndex (Widget w)
 
ScriptInvoker GetOnPageChanged ()
 
sealed bool SetPage (int page, bool isRefresh=false)
 Set current page.
 
sealed bool RefreshPage ()
 Refresh the current page.
 
override bool OnFocus (Widget w, int x, int y)
 
override bool OnMouseEnter (Widget w, int x, int y)
 
override bool OnMouseLeave (Widget w, Widget enterW, int x, int y)
 
override void HandlerAttached (Widget w)
 
override void HandlerDeattached (Widget w)
 
- Public Member Functions inherited from MenuRootSubComponent
Widget GetWidget ()
 Get widget to which the component belongs to.
 
MenuRootBase GetMenu ()
 Get menu of which the widget is part of.
 
MenuRootComponent GetRootComponent ()
 Get root component of this subcomponent,.
 
void HandlerAttachedScripted (Widget w)
 Event called when subcomponent is initialized.
 
override void HandlerAttached (Widget w)
 
override void HandlerDeattached (Widget w)
 

Protected Member Functions

void DisableArrowsSinglePage ()
 Disable page change button if flag is true and number of pages is 1.
 
void ShowEntries (Widget contentWidget, int indexStart, int indexEnd)
 Function called when the page is refreshed.
 
void IterateIndex (out int row, out int column)
 
void EnablePageButton (Widget w, bool enable)
 
void OnButtonPrev ()
 
void OnButtonNext ()
 
void SetUnderCursor (bool newUnderCursor)
 
void OnInputDeviceIsGamepad (bool isGamepad)
 
override bool IsUnique ()
 Is the component to exist only in one instance? If so, it will be registered in the list of components and can be searched for.
 
bool IsUnique ()
 Is the component to exist only in one instance? If so, it will be registered in the list of components and can be searched for.
 

Protected Attributes

int m_iRows
 
int m_iColumns
 
int m_iMinRows
 
int m_iMinColumns
 
string m_sContentName
 
string m_sButtonPrevName
 
string m_sButtonNextName
 
string m_sButtonPrevName_NoScrolling
 
string m_sButtonNextName_NoScrolling
 
string m_sFocusPrevName
 
string m_sFocusNextName
 
string m_sPageIndexVisualName
 
string m_sPageIndexVisualText
 
bool m_bMustHoverOverContent
 
ref array< ResourceName > m_aEmptyItemLayouts
 
bool m_bLoop
 
bool m_bHideArrowsIfDisabled
 
bool m_bIgnoreGamePadInput
 
bool m_bPlayAudioOnPageChange
 
bool m_bShowEmptyEntries
 
string m_sOnNextPageSfx
 
string m_sOnPrevPageSfx
 
bool m_bDisableArrowsSinglePage
 
int m_iCurrentPage
 
bool m_bUnderCursor
 
Widget m_ContentWidget
 
Widget m_ButtonPrevWidget
 
Widget m_ButtonNextWidget
 
Widget m_FocusPrevWidget
 
Widget m_FocusNextWidget
 
Widget m_ButtonPrevNoScrollWidget
 
Widget m_ButtonNextNoScrollWidget
 
TextWidget m_PageNumberWidget
 
ref ScriptInvoker m_OnPageChanged = new ScriptInvoker()
 
int m_FocusedIndex [2]
 

Member Function Documentation

◆ DisableArrowsSinglePage()

void SCR_BasePaginationUIComponent.DisableArrowsSinglePage ( )
protected

Disable page change button if flag is true and number of pages is 1.

◆ EnablePageButton()

void SCR_BasePaginationUIComponent.EnablePageButton ( Widget  w,
bool  enable 
)
protected

◆ GetColumns()

int SCR_BasePaginationUIComponent.GetColumns ( )
Returns
Number of Columns

◆ GetCurrentPage()

int SCR_BasePaginationUIComponent.GetCurrentPage ( )
Returns
Currently selected page

◆ GetEntryCount()

int SCR_BasePaginationUIComponent.GetEntryCount ( )

Return total number of entries.

To be overridden by inherited classes.

Returns
Number of entries

Implemented in SCR_ContentBrowserEditorUIComponent, and SCR_ExternalPaginationUIComponent.

◆ GetEntryIndex()

int SCR_BasePaginationUIComponent.GetEntryIndex ( Widget  w)
Parameters
wQueried widget
Returns
Index of entry represented by given widget

◆ GetOnPageChanged()

ScriptInvoker SCR_BasePaginationUIComponent.GetOnPageChanged ( )
Returns
Event called when current page changes.

◆ GetRows()

int SCR_BasePaginationUIComponent.GetRows ( )
Returns
Number of rows

◆ HandlerAttached()

override void SCR_BasePaginationUIComponent.HandlerAttached ( Widget  w)

Implements MenuRootSubComponent.

Implemented in SCR_ExternalPaginationUIComponent.

◆ HandlerDeattached()

override void SCR_BasePaginationUIComponent.HandlerDeattached ( Widget  w)

Implements MenuRootSubComponent.

Implemented in SCR_ContentBrowserEditorUIComponent.

◆ IsUnique()

override bool SCR_BasePaginationUIComponent.IsUnique ( )
protected

Is the component to exist only in one instance? If so, it will be registered in the list of components and can be searched for.

To be overwritten by inherited classes.

Returns
True if unique

Implements MenuRootSubComponent.

Implemented in SCR_ContentBrowserEditorUIComponent.

◆ IterateIndex()

void SCR_BasePaginationUIComponent.IterateIndex ( out int  row,
out int  column 
)
protected

◆ OnButtonNext()

void SCR_BasePaginationUIComponent.OnButtonNext ( )
protected

Implemented in SCR_ContentBrowserEditorUIComponent.

◆ OnButtonPrev()

void SCR_BasePaginationUIComponent.OnButtonPrev ( )
protected

Implemented in SCR_ContentBrowserEditorUIComponent.

◆ OnFocus()

override bool SCR_BasePaginationUIComponent.OnFocus ( Widget  w,
int  x,
int  y 
)

◆ OnInputDeviceIsGamepad()

void SCR_BasePaginationUIComponent.OnInputDeviceIsGamepad ( bool  isGamepad)
protected

◆ OnMouseEnter()

override bool SCR_BasePaginationUIComponent.OnMouseEnter ( Widget  w,
int  x,
int  y 
)

◆ OnMouseLeave()

override bool SCR_BasePaginationUIComponent.OnMouseLeave ( Widget  w,
Widget  enterW,
int  x,
int  y 
)

◆ RefreshPage()

sealed bool SCR_BasePaginationUIComponent.RefreshPage ( )

Refresh the current page.

Returns
True if the page has any content

◆ SetPage()

sealed bool SCR_BasePaginationUIComponent.SetPage ( int  page,
bool  isRefresh = false 
)

Set current page.

Parameters
pagePage number
Returns
True if the page has any content

◆ SetUnderCursor()

void SCR_BasePaginationUIComponent.SetUnderCursor ( bool  newUnderCursor)
protected

◆ ShowEntries()

void SCR_BasePaginationUIComponent.ShowEntries ( Widget  contentWidget,
int  indexStart,
int  indexEnd 
)
protected

Function called when the page is refreshed.

To be overridden by inherited classes.

Parameters
contentWidgetContent widget
indexStartIndex of the first displayed item
indexEndIndex of the last displayed item

Implemented in SCR_ContentBrowserEditorUIComponent, and SCR_ExternalPaginationUIComponent.

Member Data Documentation

◆ m_aEmptyItemLayouts

ref array<ResourceName> SCR_BasePaginationUIComponent.m_aEmptyItemLayouts
protected

◆ m_bDisableArrowsSinglePage

bool SCR_BasePaginationUIComponent.m_bDisableArrowsSinglePage
protected

◆ m_bHideArrowsIfDisabled

bool SCR_BasePaginationUIComponent.m_bHideArrowsIfDisabled
protected

◆ m_bIgnoreGamePadInput

bool SCR_BasePaginationUIComponent.m_bIgnoreGamePadInput
protected

◆ m_bLoop

bool SCR_BasePaginationUIComponent.m_bLoop
protected

◆ m_bMustHoverOverContent

bool SCR_BasePaginationUIComponent.m_bMustHoverOverContent
protected

◆ m_bPlayAudioOnPageChange

bool SCR_BasePaginationUIComponent.m_bPlayAudioOnPageChange
protected

◆ m_bShowEmptyEntries

bool SCR_BasePaginationUIComponent.m_bShowEmptyEntries
protected

◆ m_bUnderCursor

bool SCR_BasePaginationUIComponent.m_bUnderCursor
protected

◆ m_ButtonNextNoScrollWidget

Widget SCR_BasePaginationUIComponent.m_ButtonNextNoScrollWidget
protected

◆ m_ButtonNextWidget

Widget SCR_BasePaginationUIComponent.m_ButtonNextWidget
protected

◆ m_ButtonPrevNoScrollWidget

Widget SCR_BasePaginationUIComponent.m_ButtonPrevNoScrollWidget
protected

◆ m_ButtonPrevWidget

Widget SCR_BasePaginationUIComponent.m_ButtonPrevWidget
protected

◆ m_ContentWidget

Widget SCR_BasePaginationUIComponent.m_ContentWidget
protected

◆ m_FocusedIndex

int SCR_BasePaginationUIComponent.m_FocusedIndex[2]
protected

◆ m_FocusNextWidget

Widget SCR_BasePaginationUIComponent.m_FocusNextWidget
protected

◆ m_FocusPrevWidget

Widget SCR_BasePaginationUIComponent.m_FocusPrevWidget
protected

◆ m_iColumns

int SCR_BasePaginationUIComponent.m_iColumns
protected

◆ m_iCurrentPage

int SCR_BasePaginationUIComponent.m_iCurrentPage
protected

◆ m_iMinColumns

int SCR_BasePaginationUIComponent.m_iMinColumns
protected

◆ m_iMinRows

int SCR_BasePaginationUIComponent.m_iMinRows
protected

◆ m_iRows

int SCR_BasePaginationUIComponent.m_iRows
protected

◆ m_OnPageChanged

ref ScriptInvoker SCR_BasePaginationUIComponent.m_OnPageChanged = new ScriptInvoker()
protected

◆ m_PageNumberWidget

TextWidget SCR_BasePaginationUIComponent.m_PageNumberWidget
protected

◆ m_sButtonNextName

string SCR_BasePaginationUIComponent.m_sButtonNextName
protected

◆ m_sButtonNextName_NoScrolling

string SCR_BasePaginationUIComponent.m_sButtonNextName_NoScrolling
protected

◆ m_sButtonPrevName

string SCR_BasePaginationUIComponent.m_sButtonPrevName
protected

◆ m_sButtonPrevName_NoScrolling

string SCR_BasePaginationUIComponent.m_sButtonPrevName_NoScrolling
protected

◆ m_sContentName

string SCR_BasePaginationUIComponent.m_sContentName
protected

◆ m_sFocusNextName

string SCR_BasePaginationUIComponent.m_sFocusNextName
protected

◆ m_sFocusPrevName

string SCR_BasePaginationUIComponent.m_sFocusPrevName
protected

◆ m_sOnNextPageSfx

string SCR_BasePaginationUIComponent.m_sOnNextPageSfx
protected

◆ m_sOnPrevPageSfx

string SCR_BasePaginationUIComponent.m_sOnPrevPageSfx
protected

◆ m_sPageIndexVisualName

string SCR_BasePaginationUIComponent.m_sPageIndexVisualName
protected

◆ m_sPageIndexVisualText

string SCR_BasePaginationUIComponent.m_sPageIndexVisualText
protected
The documentation for this interface was generated from the following file:
Generated by doxygen 1.9.6