Inheritance diagram for SCR_SpinBoxComponent:

[legend]

Public Member Functions
override void	HandlerAttached (Widget w)

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

override bool	OnFocusLost (Widget w, int x, int y)

override int	AddItem (string item, bool last=false, Managed data=null)

override void	RemoveItem (int item, bool last=false)

override void	ClearAll ()

override bool	SetCurrentItem (int i, bool playSound=false, bool animate=false)

void	AddActionListeners ()

void	RemoveActionListeners ()

void	SetKeepActionListeners (bool keep)

void	SetCycleMode (bool cycle)

ScriptInvoker	GetOnLeftArrowClick ()

ScriptInvoker	GetOnRightArrowClick ()

Public Member Functions inherited from SCR_SelectionWidgetComponent
int	AddItem (string item, bool last=false, Managed data=null)

void	ClearAll ()

void	RemoveItem (int item, bool last=false)

int	GetCurrentIndex ()

string	GetCurrentItem ()

Managed	GetCurrentItemData ()

string	GetItemName (int item)

Managed	GetItemData (int item)

int	GetNumItems ()

bool	SetCurrentItem (int i, bool playSound=false, bool animate=false)

Public Member Functions inherited from SCR_ChangeableComponentBase
override void	HandlerAttached (Widget w)

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

override bool	OnFocusLost (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)

TextWidget	GetLabel ()

void	SetLabel (string label)

void	UseLabel (bool use)

bool	IsUsingLabel ()

Widget	GetLabelWidget ()
	If label is not used, label widget might not exist at all!

void	SetSizeWithLabel (float size)

void	SetSizeWithoutLabel (float size)

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_SpinBoxComponent	GetSpinBoxComponent (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_SelectionWidgetComponent
static SCR_SelectionWidgetComponent	GetSelectionComponent (string name, Widget parent, bool searchAllChildren=true)

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.

Protected Member Functions
bool	SetCurrentItem_Internal (int i, bool playSound, bool animate, bool invokeOnChanged)

void	CreateHintBar ()

void	UpdateHintBar (int currentIndex, int oldIndex)

void	SetInitialState (bool invokeOnChanged=true)

void	EnableArrows (int selected, bool animate)
	Based on cycle mode set which arrow should be enabled at given selection.

void	OnLeftArrowClick ()

void	OnRightArrowClick ()

void	OnMenuLeft ()

void	OnMenuRight ()

Protected Member Functions inherited from SCR_ChangeableComponentBase
void	SetupLabel ()

void	ClearLabel ()

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
SCR_PagingButtonComponent	m_ButtonLeft

SCR_PagingButtonComponent	m_ButtonRight

TextWidget	m_wText

Widget	m_wContent

Widget	m_wCountBar

ref array< Widget >	m_aHintElements = new array<Widget>()

bool	m_bUseLightArrows

bool	m_bCycleMode

bool	m_bShowHints

float	m_fHintElementWidth

float	m_fHintElementHeight

float	m_fHintSelectedWidthMultiplier

bool	m_fHintFillMode

float	m_fHintSpacing

ResourceName	m_sHintElementTexture

ResourceName	m_sHintElementImage

string	m_sHintBarElementName

ref ScriptInvoker	m_OnLeftArrowClick

ref ScriptInvoker	m_OnRightArrowClick

bool	m_bHasActionListeners

bool	m_bAllowSwitchingWithoutFocus

Protected Attributes inherited from SCR_SelectionWidgetComponent
ref array< ref Managed >	m_aElementData = new array<ref Managed>

Protected Attributes inherited from SCR_ChangeableComponentBase
bool	m_bUseLabel

string	m_sLabel

bool	m_bForceSize

float	m_fSizeWithLabel

float	m_fSizeWithoutLabel

ResourceName	m_sLabelLayout

string	m_sSizeLayout

Widget	m_wBorder

Widget	m_wBackground

Widget	m_wLabelRoot

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

Static Protected Attributes
static const ref Color	COLOR_HINT_SELECTED = UIColors.CONTRAST_COLOR

static const ref Color	COLOR_HINT_DESELECTED = UIColors.WHITE_HOVERED

Additional Inherited Members
Public Attributes inherited from SCR_SelectionWidgetComponent
ref array< string >	m_aElementNames

int	m_iSelectedItem

Public Attributes inherited from SCR_ChangeableComponentBase
ref ScriptInvoker	m_OnChanged = new ScriptInvoker()

Public Attributes inherited from SCR_ScriptedWidgetComponent
ref ScriptInvoker	m_OnClick = new ScriptInvoker

Static Public Attributes inherited from SCR_WLibComponentBase
static const float	START_ANIMATION_RATE = 10001

static const float	START_ANIMATION_PERIOD = 250

Member Function Documentation

◆ AddActionListeners()

void SCR_SpinBoxComponent.AddActionListeners ( )

◆ AddItem()

override int SCR_SpinBoxComponent.AddItem	(	string	item,
		bool	last = `false`,
		Managed	data = `null`
	)

Implements SCR_SelectionWidgetComponent.

◆ ClearAll()

override void SCR_SpinBoxComponent.ClearAll ( )

Implements SCR_SelectionWidgetComponent.

Implemented in SCR_SpawnPointSpinBox.

◆ CreateHintBar()

void SCR_SpinBoxComponent.CreateHintBar ( )

protected

◆ EnableArrows()

void SCR_SpinBoxComponent.EnableArrows	(	int	selected,
		bool	animate
	)

protected

Based on cycle mode set which arrow should be enabled at given selection.

◆ GetOnLeftArrowClick()

ScriptInvoker SCR_SpinBoxComponent.GetOnLeftArrowClick ( )

◆ GetOnRightArrowClick()

ScriptInvoker SCR_SpinBoxComponent.GetOnRightArrowClick ( )

◆ GetSpinBoxComponent()

static SCR_SpinBoxComponent SCR_SpinBoxComponent.GetSpinBoxComponent	(	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_SpinBoxComponent.HandlerAttached ( Widget w )

Implements SCR_ChangeableComponentBase.

Implemented in SCR_InventorySpinBoxComponent.

◆ OnFocus()

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

Implements SCR_ChangeableComponentBase.

Implemented in SCR_InventorySpinBoxComponent, and SCR_SpawnPointSpinBox.

◆ OnFocusLost()

override bool SCR_SpinBoxComponent.OnFocusLost	(	Widget	w,
		int	x,
		int	y
	)

Implements SCR_ChangeableComponentBase.

Implemented in SCR_InventorySpinBoxComponent, and SCR_SpawnPointSpinBox.

◆ OnLeftArrowClick()

void SCR_SpinBoxComponent.OnLeftArrowClick ( )

protected

◆ OnMenuLeft()

void SCR_SpinBoxComponent.OnMenuLeft ( )

protected

Implemented in SCR_InventorySpinBoxComponent.

◆ OnMenuRight()

void SCR_SpinBoxComponent.OnMenuRight ( )

protected

Implemented in SCR_InventorySpinBoxComponent.

◆ OnRightArrowClick()

void SCR_SpinBoxComponent.OnRightArrowClick ( )

protected

◆ RemoveActionListeners()

void SCR_SpinBoxComponent.RemoveActionListeners ( )

◆ RemoveItem()

override void SCR_SpinBoxComponent.RemoveItem	(	int	item,
		bool	last = `false`
	)

Implements SCR_SelectionWidgetComponent.

Implemented in SCR_SpawnPointSpinBox.

◆ SetCurrentItem()

override bool SCR_SpinBoxComponent.SetCurrentItem	(	int	i,
		bool	playSound = `false`,
		bool	animate = `false`
	)

Implements SCR_SelectionWidgetComponent.

Implemented in SCR_TutorialFastTravelSpinBox.

◆ SetCurrentItem_Internal()

bool SCR_SpinBoxComponent.SetCurrentItem_Internal	(	int	i,
		bool	playSound,
		bool	animate,
		bool	invokeOnChanged
	)

protected

◆ SetCycleMode()

void SCR_SpinBoxComponent.SetCycleMode ( bool cycle )

◆ SetInitialState()

void SCR_SpinBoxComponent.SetInitialState ( bool invokeOnChanged = true )

protected

◆ SetKeepActionListeners()

void SCR_SpinBoxComponent.SetKeepActionListeners ( bool keep )

◆ UpdateHintBar()

void SCR_SpinBoxComponent.UpdateHintBar	(	int	currentIndex,
		int	oldIndex
	)

protected

Member Data Documentation

◆ COLOR_HINT_DESELECTED

const ref Color SCR_SpinBoxComponent.COLOR_HINT_DESELECTED = UIColors.WHITE_HOVERED

staticprotected

◆ COLOR_HINT_SELECTED

const ref Color SCR_SpinBoxComponent.COLOR_HINT_SELECTED = UIColors.CONTRAST_COLOR

staticprotected

◆ m_aHintElements

ref array<Widget> SCR_SpinBoxComponent.m_aHintElements = new array<Widget>()

protected

◆ m_bAllowSwitchingWithoutFocus

bool SCR_SpinBoxComponent.m_bAllowSwitchingWithoutFocus

protected

◆ m_bCycleMode

bool SCR_SpinBoxComponent.m_bCycleMode

protected

◆ m_bHasActionListeners

bool SCR_SpinBoxComponent.m_bHasActionListeners

protected

◆ m_bShowHints

bool SCR_SpinBoxComponent.m_bShowHints

protected

◆ m_bUseLightArrows

bool SCR_SpinBoxComponent.m_bUseLightArrows

protected

◆ m_ButtonLeft

SCR_PagingButtonComponent SCR_SpinBoxComponent.m_ButtonLeft

protected

◆ m_ButtonRight

SCR_PagingButtonComponent SCR_SpinBoxComponent.m_ButtonRight

protected

◆ m_fHintElementHeight

float SCR_SpinBoxComponent.m_fHintElementHeight

protected

◆ m_fHintElementWidth

float SCR_SpinBoxComponent.m_fHintElementWidth

protected

◆ m_fHintFillMode

bool SCR_SpinBoxComponent.m_fHintFillMode

protected

◆ m_fHintSelectedWidthMultiplier

float SCR_SpinBoxComponent.m_fHintSelectedWidthMultiplier

protected

◆ m_fHintSpacing

float SCR_SpinBoxComponent.m_fHintSpacing

protected

◆ m_OnLeftArrowClick

ref ScriptInvoker SCR_SpinBoxComponent.m_OnLeftArrowClick

protected

◆ m_OnRightArrowClick

ref ScriptInvoker SCR_SpinBoxComponent.m_OnRightArrowClick

protected

◆ m_sHintBarElementName

string SCR_SpinBoxComponent.m_sHintBarElementName

protected

◆ m_sHintElementImage

ResourceName SCR_SpinBoxComponent.m_sHintElementImage

protected

◆ m_sHintElementTexture

ResourceName SCR_SpinBoxComponent.m_sHintElementTexture

protected

◆ m_wContent

Widget SCR_SpinBoxComponent.m_wContent

protected

◆ m_wCountBar

Widget SCR_SpinBoxComponent.m_wCountBar

protected

◆ m_wText

TextWidget SCR_SpinBoxComponent.m_wText

protected

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

Game/UI/Components/WidgetLibrary/SCR_Slider/SCR_SpinBoxComponent.c

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Additional Inherited Members

Member Function Documentation

◆ AddActionListeners()

◆ AddItem()

◆ ClearAll()

◆ CreateHintBar()

◆ EnableArrows()

◆ GetOnLeftArrowClick()

◆ GetOnRightArrowClick()

◆ GetSpinBoxComponent()

◆ HandlerAttached()

◆ OnFocus()

◆ OnFocusLost()

◆ OnLeftArrowClick()

◆ OnMenuLeft()

◆ OnMenuRight()

◆ OnRightArrowClick()

◆ RemoveActionListeners()

◆ RemoveItem()

◆ SetCurrentItem()

◆ SetCurrentItem_Internal()

◆ SetCycleMode()

◆ SetInitialState()

◆ SetKeepActionListeners()

◆ UpdateHintBar()

Member Data Documentation

◆ COLOR_HINT_DESELECTED

◆ COLOR_HINT_SELECTED

◆ m_aHintElements

◆ m_bAllowSwitchingWithoutFocus

◆ m_bCycleMode

◆ m_bHasActionListeners

◆ m_bShowHints

◆ m_bUseLightArrows

◆ m_ButtonLeft

◆ m_ButtonRight

◆ m_fHintElementHeight

◆ m_fHintElementWidth

◆ m_fHintFillMode

◆ m_fHintSelectedWidthMultiplier

◆ m_fHintSpacing

◆ m_OnLeftArrowClick

◆ m_OnRightArrowClick

◆ m_sHintBarElementName

◆ m_sHintElementImage

◆ m_sHintElementTexture

◆ m_wContent

◆ m_wCountBar

◆ m_wText