SCR_ToolboxComponent Interface Reference

Inheritance diagram for SCR_ToolboxComponent:

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)
void	OnElementClicked (SCR_ButtonBaseComponent comp)
void	OnElementChanged (SCR_ButtonBaseComponent comp, bool state)
override bool	SetCurrentItem (int i, bool playSound=false, bool animate=false)
override bool	OnMouseEnter (Widget w, int x, int y)
int	GetItems (notnull array< SCR_ButtonBaseComponent > elements)
SCR_ButtonBaseComponent	GetItem (int index)
override int	AddItem (string item, bool last=false, Managed data=null)
override void	ClearAll ()
override void	RemoveItem (int item, bool last=false)
bool	IsItemSelected (int index)
void	SetItemSelected (int index, bool select, bool animate=true)
void	SetFocusedItem (int index, bool animate=true)
void	SetFocusedItem (SCR_ButtonBaseComponent element, bool animate=true)
int	GetFocusedItem ()
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_ToolboxComponent	GetToolboxComponent (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.

Public Attributes
bool	m_bAllowMultiselection
ResourceName	m_ElementLayout
float	m_fElementSpacing
bool	m_bCycleMode
ref array< SCR_ButtonBaseComponent >	m_aSelectionElements = new array<SCR_ButtonBaseComponent>
SCR_ButtonBaseComponent	m_FocusedElement
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

Protected Member Functions
void	CreateWidgets ()
void	ClearWidgets ()
void	SetInitialState ()
void	OnMenuSelect ()
SCR_ButtonBaseComponent	GetFirstSelectedIndex ()
void	OnMenuLeft ()
void	OnMenuRight ()
int	GetNextValidItem (bool toLeft)
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
Widget	m_wButtonRow
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

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

AddItem()

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

Implements SCR_SelectionWidgetComponent.

ClearAll()

override void SCR_ToolboxComponent.ClearAll

(

)

Implements SCR_SelectionWidgetComponent.

ClearWidgets()

void SCR_ToolboxComponent.ClearWidgets ( )

protected

CreateWidgets()

void SCR_ToolboxComponent.CreateWidgets ( )

protected

Implemented in SCR_ToolboxMultilineComponent.

GetFirstSelectedIndex()

SCR_ButtonBaseComponent SCR_ToolboxComponent.GetFirstSelectedIndex ( )

protected

GetFocusedItem()

int SCR_ToolboxComponent.GetFocusedItem

(

)

GetItem()

SCR_ButtonBaseComponent SCR_ToolboxComponent.GetItem

(

int

index

)

GetItems()

int SCR_ToolboxComponent.GetItems

(

notnull array< SCR_ButtonBaseComponent >

elements

)

GetNextValidItem()

int SCR_ToolboxComponent.GetNextValidItem ( bool  toLeft )

protected

GetToolboxComponent()

static SCR_ToolboxComponent SCR_ToolboxComponent.GetToolboxComponent ( 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_ToolboxComponent.HandlerAttached

(

Widget

w

)

Implements SCR_ChangeableComponentBase.

Implemented in SCR_ToolboxMultilineComponent.

IsItemSelected()

bool SCR_ToolboxComponent.IsItemSelected

(

int

index

)

OnElementChanged()

void SCR_ToolboxComponent.OnElementChanged	(	SCR_ButtonBaseComponent	comp,
		bool	state
	)

Implemented in SCR_CheckboxComponent.

OnElementClicked()

void SCR_ToolboxComponent.OnElementClicked

(

SCR_ButtonBaseComponent

comp

)

OnFocus()

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

Implements SCR_ChangeableComponentBase.

OnFocusLost()

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

Implements SCR_ChangeableComponentBase.

OnMenuLeft()

void SCR_ToolboxComponent.OnMenuLeft ( )

protected

OnMenuRight()

void SCR_ToolboxComponent.OnMenuRight ( )

protected

OnMenuSelect()

void SCR_ToolboxComponent.OnMenuSelect ( )

protected

OnMouseEnter()

override bool SCR_ToolboxComponent.OnMouseEnter	(	Widget	w,
		int	x,
		int	y
	)

Implements SCR_ChangeableComponentBase.

RemoveItem()

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

Implements SCR_SelectionWidgetComponent.

SetCurrentItem()

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

Implements SCR_SelectionWidgetComponent.

SetFocusedItem() [1/2]

void SCR_ToolboxComponent.SetFocusedItem	(	int	index,
		bool	animate = true
	)

SetFocusedItem() [2/2]

void SCR_ToolboxComponent.SetFocusedItem	(	SCR_ButtonBaseComponent	element,
		bool	animate = true
	)

SetInitialState()

void SCR_ToolboxComponent.SetInitialState ( )

protected

SetItemSelected()

void SCR_ToolboxComponent.SetItemSelected	(	int	index,
		bool	select,
		bool	animate = true
	)

Member Data Documentation

m_aSelectionElements

ref array<SCR_ButtonBaseComponent> SCR_ToolboxComponent.m_aSelectionElements = new array<SCR_ButtonBaseComponent>

m_bAllowMultiselection

bool SCR_ToolboxComponent.m_bAllowMultiselection

m_bCycleMode

bool SCR_ToolboxComponent.m_bCycleMode

m_ElementLayout

ResourceName SCR_ToolboxComponent.m_ElementLayout

m_fElementSpacing

float SCR_ToolboxComponent.m_fElementSpacing

m_FocusedElement

SCR_ButtonBaseComponent SCR_ToolboxComponent.m_FocusedElement

m_wButtonRow

Widget SCR_ToolboxComponent.m_wButtonRow

protected

---

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

• Game/UI/Components/WidgetLibrary/SCR_Toolbox/SCR_ToolboxComponent.c