SCR_SelectionWidgetComponent Interface Reference

Inheritance diagram for SCR_SelectionWidgetComponent:

Public Member Functions
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_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.

Public Attributes
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

Protected Attributes
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

Additional Inherited Members
Static Public Attributes inherited from SCR_WLibComponentBase
static const float	START_ANIMATION_RATE = 10001
static const float	START_ANIMATION_PERIOD = 250
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)

Member Function Documentation

AddItem()

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

Implemented in SCR_ComboBoxComponent, SCR_ComboBoxIconComponent, SCR_SpinBoxComponent, and SCR_ToolboxComponent.

ClearAll()

void SCR_SelectionWidgetComponent.ClearAll

(

)

Implemented in SCR_ComboBoxComponent, SCR_ComboBoxIconComponent, SCR_SpinBoxComponent, SCR_ToolboxComponent, and SCR_SpawnPointSpinBox.

GetCurrentIndex()

int SCR_SelectionWidgetComponent.GetCurrentIndex

(

)

GetCurrentItem()

string SCR_SelectionWidgetComponent.GetCurrentItem

(

)

GetCurrentItemData()

Managed SCR_SelectionWidgetComponent.GetCurrentItemData

(

)

GetItemData()

Managed SCR_SelectionWidgetComponent.GetItemData

(

int

item

)

GetItemName()

string SCR_SelectionWidgetComponent.GetItemName

(

int

item

)

GetNumItems()

int SCR_SelectionWidgetComponent.GetNumItems

(

)

GetSelectionComponent()

static SCR_SelectionWidgetComponent SCR_SelectionWidgetComponent.GetSelectionComponent ( string  name, Widget  parent, bool  searchAllChildren = true  )

static

RemoveItem()

void SCR_SelectionWidgetComponent.RemoveItem	(	int	item,
		bool	last = false
	)

Implemented in SCR_ComboBoxComponent, SCR_ComboBoxIconComponent, SCR_SpinBoxComponent, SCR_ToolboxComponent, and SCR_SpawnPointSpinBox.

SetCurrentItem()

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

Implemented in SCR_ComboBoxComponent, SCR_SpinBoxComponent, SCR_ToolboxComponent, and SCR_TutorialFastTravelSpinBox.

Member Data Documentation

m_aElementData

ref array<ref Managed> SCR_SelectionWidgetComponent.m_aElementData = new array<ref Managed>

protected

m_aElementNames

ref array<string> SCR_SelectionWidgetComponent.m_aElementNames

m_iSelectedItem

int SCR_SelectionWidgetComponent.m_iSelectedItem

---

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

• Game/UI/Components/WidgetLibrary/SCR_SelectionWidgetComponent.c