SCR_SpinBoxPagingComponent Class Reference

Inheritance diagram for SCR_SpinBoxPagingComponent:

Protected Member Functions
override void	HandlerAttached (Widget w)
void	OnButtonLeft ()
void	OnButtonRight ()
void	UpdateTextAndButtons (bool animate=true)
void	SetCurrentItem (int page, bool invokeChange=true)
void	SetPageCount (int count, bool animate=true)
int	GetPageCount ()
int	GetCurrentIndex ()
void	SetCanNavigate (bool enable)
void	SetButtonsVisible (bool visible)
void	SetButtonsActive (bool active)

Static Protected Member Functions
static SCR_SpinBoxPagingComponent	GetSpinBoxPagingComponent (string name, Widget parent, bool searchAllChildren=true)

Protected Attributes
string	m_sLeftAction
string	m_sRightAction
string	m_sText
ref array< string >	m_aElementNames
int	m_iPageCount
int	m_iPageCurrent
bool	m_bCycleMode
bool	m_bEnabled = true
bool	m_bCanNavigate = true
TextWidget	m_wText
SCR_PagingButtonComponent	m_ButtonLeft
SCR_PagingButtonComponent	m_ButtonRight
ref ScriptInvoker	m_OnChanged = new ScriptInvoker()

Detailed Description

Definition at line 2 of file SCR_SpinBoxPaging.c.

Member Function Documentation

GetCurrentIndex()

int SCR_SpinBoxPagingComponent::GetCurrentIndex ( )

inlineprotected

Definition at line 173 of file SCR_SpinBoxPaging.c.

GetPageCount()

int SCR_SpinBoxPagingComponent::GetPageCount ( )

inlineprotected

Definition at line 167 of file SCR_SpinBoxPaging.c.

GetSpinBoxPagingComponent()

SCR_SpinBoxPagingComponent SCR_SpinBoxPagingComponent::GetSpinBoxPagingComponent ( string name, Widget parent, bool searchAllChildren = true )

inlinestaticprotected

Static method to easily find component by providing name and parent. Searching all children will go through whole hierarchy, instead of immediate chidren

Definition at line 219 of file SCR_SpinBoxPaging.c.

HandlerAttached()

override void SCR_SpinBoxPagingComponent::HandlerAttached ( Widget w )

inlineprotected

Definition at line 46 of file SCR_SpinBoxPaging.c.

OnButtonLeft()

void SCR_SpinBoxPagingComponent::OnButtonLeft ( )

inlineprotected

Definition at line 74 of file SCR_SpinBoxPaging.c.

OnButtonRight()

void SCR_SpinBoxPagingComponent::OnButtonRight ( )

inlineprotected

Definition at line 81 of file SCR_SpinBoxPaging.c.

SetButtonsActive()

void SCR_SpinBoxPagingComponent::SetButtonsActive ( bool active )

inlineprotected

Definition at line 199 of file SCR_SpinBoxPaging.c.

SetButtonsVisible()

void SCR_SpinBoxPagingComponent::SetButtonsVisible ( bool visible )

inlineprotected

Definition at line 189 of file SCR_SpinBoxPaging.c.

SetCanNavigate()

void SCR_SpinBoxPagingComponent::SetCanNavigate ( bool enable )

inlineprotected

Definition at line 179 of file SCR_SpinBoxPaging.c.

SetCurrentItem()

void SCR_SpinBoxPagingComponent::SetCurrentItem ( int page, bool invokeChange = true )

inlineprotected

Definition at line 120 of file SCR_SpinBoxPaging.c.

SetPageCount()

void SCR_SpinBoxPagingComponent::SetPageCount ( int count, bool animate = true )

inlineprotected

Definition at line 149 of file SCR_SpinBoxPaging.c.

UpdateTextAndButtons()

void SCR_SpinBoxPagingComponent::UpdateTextAndButtons ( bool animate = true )

inlineprotected

Definition at line 88 of file SCR_SpinBoxPaging.c.

Member Data Documentation

m_aElementNames

ref array<string> SCR_SpinBoxPagingComponent::m_aElementNames

protected

Definition at line 19 of file SCR_SpinBoxPaging.c.

m_bCanNavigate

bool SCR_SpinBoxPagingComponent::m_bCanNavigate = true

protected

Definition at line 34 of file SCR_SpinBoxPaging.c.

m_bCycleMode

bool SCR_SpinBoxPagingComponent::m_bCycleMode

protected

Definition at line 28 of file SCR_SpinBoxPaging.c.

m_bEnabled

bool SCR_SpinBoxPagingComponent::m_bEnabled = true

protected

Definition at line 33 of file SCR_SpinBoxPaging.c.

m_ButtonLeft

SCR_PagingButtonComponent SCR_SpinBoxPagingComponent::m_ButtonLeft

protected

Definition at line 40 of file SCR_SpinBoxPaging.c.

m_ButtonRight

SCR_PagingButtonComponent SCR_SpinBoxPagingComponent::m_ButtonRight

protected

Definition at line 41 of file SCR_SpinBoxPaging.c.

m_iPageCount

int SCR_SpinBoxPagingComponent::m_iPageCount

protected

Definition at line 22 of file SCR_SpinBoxPaging.c.

m_iPageCurrent

int SCR_SpinBoxPagingComponent::m_iPageCurrent

protected

Definition at line 25 of file SCR_SpinBoxPaging.c.

m_OnChanged

ref ScriptInvoker SCR_SpinBoxPagingComponent::m_OnChanged = new ScriptInvoker()

protected

Definition at line 43 of file SCR_SpinBoxPaging.c.

m_sLeftAction

string SCR_SpinBoxPagingComponent::m_sLeftAction

protected

Definition at line 5 of file SCR_SpinBoxPaging.c.

m_sRightAction

string SCR_SpinBoxPagingComponent::m_sRightAction

protected

Definition at line 8 of file SCR_SpinBoxPaging.c.

m_sText

string SCR_SpinBoxPagingComponent::m_sText

protected

Definition at line 14 of file SCR_SpinBoxPaging.c.

m_wText

TextWidget SCR_SpinBoxPagingComponent::m_wText

protected

Definition at line 38 of file SCR_SpinBoxPaging.c.

---

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

• scripts/Game/UI/Components/WidgetLibrary/SCR_Slider/SCR_SpinBoxPaging.c