SCR_ExternalPaginationUIComponent Interface Reference

Inheritance diagram for SCR_ExternalPaginationUIComponent:

Public Member Functions
void	SetPageIndex (int index)
void	SetEntryCount (int count)
ScriptInvoker	GetOnShowEntries ()
override void	HandlerAttached (Widget w)
Public Member Functions inherited from SCR_BasePaginationUIComponent
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
override void	ShowEntries (Widget contentWidget, int indexStart, int indexEnd)
	Function called when the page is refreshed.
override int	GetEntryCount ()
	Return total number of entries.
Protected Member Functions inherited from SCR_BasePaginationUIComponent
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_iEntryCount
ref ScriptInvoker	m_OnShowEntries = new ScriptInvoker()
Protected Attributes inherited from SCR_BasePaginationUIComponent
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

GetEntryCount()

override int SCR_ExternalPaginationUIComponent.GetEntryCount ( )

protected

Return total number of entries.

To be overridden by inherited classes.

Returns

Number of entries

Implements SCR_BasePaginationUIComponent.

GetOnShowEntries()

ScriptInvoker SCR_ExternalPaginationUIComponent.GetOnShowEntries

(

)

HandlerAttached()

override void SCR_ExternalPaginationUIComponent.HandlerAttached

(

Widget

w

)

Implements SCR_BasePaginationUIComponent.

SetEntryCount()

void SCR_ExternalPaginationUIComponent.SetEntryCount

(

int

count

)

SetPageIndex()

void SCR_ExternalPaginationUIComponent.SetPageIndex

(

int

index

)

ShowEntries()

override void SCR_ExternalPaginationUIComponent.ShowEntries ( Widget  contentWidget, int  indexStart, int  indexEnd  )

protected

Function called when the page is refreshed.

To be overridden by inherited classes.

Parameters

contentWidget	Content widget
indexStart	Index of the first displayed item
indexEnd	Index of the last displayed item

Implements SCR_BasePaginationUIComponent.

Member Data Documentation

m_iEntryCount

int SCR_ExternalPaginationUIComponent.m_iEntryCount

protected

m_OnShowEntries

ref ScriptInvoker SCR_ExternalPaginationUIComponent.m_OnShowEntries = new ScriptInvoker()

protected

---

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

• Game/UI/Components/SCR_ExternalPaginationUIComponent.c