SCR_SpinBoxPagingComponent Interface Reference

Inheritance diagram for SCR_SpinBoxPagingComponent:

Public Member Functions
override void	HandlerAttached (Widget w)
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)
Public Member Functions inherited from SCR_WLibComponentBase
override void	HandlerAttached (Widget w)
override bool	OnClick (Widget w, int x, int y, int button)
override bool	OnMouseEnter (Widget w, int x, int y)
override bool	OnFocus (Widget w, int x, int y)
void	SetHoverSound (string soundHover)
void	SetClickedSound (string soundClicked)
string	GetHoverSound ()
string	GetClickedSound ()
void	SetEnabled (bool enabled, bool animate=true)
void	SetVisible (bool visible, bool animate=true)
bool	IsEnabled ()
void	SetMouseOverToFocus (bool mouseOverToFocus)
void	SetDisabledOpacity (float newDisabledOpacity)
Public Member Functions inherited from SCR_ScriptedWidgetComponent
override void	HandlerAttached (Widget w)
override bool	OnClick (Widget w, int x, int y, int button)
Widget	GetRootWidget ()
bool	IsVisible ()

Static Public Member Functions
static SCR_SpinBoxPagingComponent	GetSpinBoxPagingComponent (string name, Widget parent, bool searchAllChildren=true)
	Static method to easily find component by providing name and parent.
Static Public Member Functions inherited from SCR_WLibComponentBase
static bool	SetTexture (ImageWidget widget, ResourceName texture, string image="")
Static Public Member Functions inherited from SCR_ScriptedWidgetComponent
static SCR_ScriptedWidgetComponent	GetComponent (TypeName componentType, string name, Widget parent, bool searchAllChildren=true)
	Base method for component lookup through the widget library.

Public Attributes
ref array< string >	m_aElementNames
bool	m_bCycleMode
ref ScriptInvoker	m_OnChanged = new ScriptInvoker()
Public Attributes inherited from SCR_ScriptedWidgetComponent
ref ScriptInvoker	m_OnClick = new ScriptInvoker

Protected Member Functions
void	OnButtonLeft ()
void	OnButtonRight ()
void	UpdateTextAndButtons (bool animate=true)
Protected Member Functions inherited from SCR_WLibComponentBase
void	OnEnabled (bool animate)
void	OnDisabled (bool animate)
bool	IsChildWidget (Widget parent, Widget child)
void	SetAnimationRate ()
void	PlaySound (string sound)

Protected Attributes
string	m_sLeftAction
string	m_sRightAction
string	m_sText
int	m_iPageCount
int	m_iPageCurrent
bool	m_bEnabled = true
bool	m_bCanNavigate = true
TextWidget	m_wText
SCR_PagingButtonComponent	m_ButtonLeft
SCR_PagingButtonComponent	m_ButtonRight
Protected Attributes inherited from SCR_WLibComponentBase
string	m_sSoundHovered
string	m_sSoundClicked
float	m_fAnimationTime
bool	m_bMouseOverToFocus
float	m_fDisabledOpacity
float	m_fAnimationRate
Protected Attributes inherited from SCR_ScriptedWidgetComponent
Widget	m_wRoot

Additional Inherited Members
Static Public Attributes inherited from SCR_WLibComponentBase
static const float	START_ANIMATION_RATE = 10001
static const float	START_ANIMATION_PERIOD = 250

Member Function Documentation

GetCurrentIndex()

int SCR_SpinBoxPagingComponent.GetCurrentIndex

(

)

GetPageCount()

int SCR_SpinBoxPagingComponent.GetPageCount

(

)

GetSpinBoxPagingComponent()

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

static

Static method to easily find component by providing name and parent.

Searching all children will go through whole hierarchy, instead of immediate chidren

HandlerAttached()

override void SCR_SpinBoxPagingComponent.HandlerAttached

(

Widget

w

)

Implements SCR_WLibComponentBase.

OnButtonLeft()

void SCR_SpinBoxPagingComponent.OnButtonLeft ( )

protected

OnButtonRight()

void SCR_SpinBoxPagingComponent.OnButtonRight ( )

protected

SetButtonsActive()

void SCR_SpinBoxPagingComponent.SetButtonsActive

(

bool

active

)

SetButtonsVisible()

void SCR_SpinBoxPagingComponent.SetButtonsVisible

(

bool

visible

)

SetCanNavigate()

void SCR_SpinBoxPagingComponent.SetCanNavigate

(

bool

enable

)

SetCurrentItem()

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

SetPageCount()

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

UpdateTextAndButtons()

void SCR_SpinBoxPagingComponent.UpdateTextAndButtons ( bool  animate = true )

protected

Member Data Documentation

m_aElementNames

ref array<string> SCR_SpinBoxPagingComponent.m_aElementNames

m_bCanNavigate

bool SCR_SpinBoxPagingComponent.m_bCanNavigate = true

protected

m_bCycleMode

bool SCR_SpinBoxPagingComponent.m_bCycleMode

m_bEnabled

bool SCR_SpinBoxPagingComponent.m_bEnabled = true

protected

m_ButtonLeft

SCR_PagingButtonComponent SCR_SpinBoxPagingComponent.m_ButtonLeft

protected

m_ButtonRight

SCR_PagingButtonComponent SCR_SpinBoxPagingComponent.m_ButtonRight

protected

m_iPageCount

int SCR_SpinBoxPagingComponent.m_iPageCount

protected

m_iPageCurrent

int SCR_SpinBoxPagingComponent.m_iPageCurrent

protected

m_OnChanged

ref ScriptInvoker SCR_SpinBoxPagingComponent.m_OnChanged = new ScriptInvoker()

m_sLeftAction

string SCR_SpinBoxPagingComponent.m_sLeftAction

protected

m_sRightAction

string SCR_SpinBoxPagingComponent.m_sRightAction

protected

m_sText

string SCR_SpinBoxPagingComponent.m_sText

protected

m_wText

TextWidget SCR_SpinBoxPagingComponent.m_wText

protected

---

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

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