SCR_ToolboxMultilineComponent Interface Reference

Inheritance diagram for SCR_ToolboxMultilineComponent:

Public Member Functions
override void	HandlerAttached (Widget w)
void	SetMaxItemsInRow (int maxItems)
int	GetMaxItemsInRow ()
SizeLayoutWidget	FindSizeWidget (Widget root)
Public Member Functions inherited from SCR_ToolboxComponent
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	GetCurrentIndex ()
string	GetCurrentItem ()
Managed	GetCurrentItemData ()
string	GetItemName (int item)
Managed	GetItemData (int item)
int	GetNumItems ()
Public Member Functions inherited from SCR_ChangeableComponentBase
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 bool	OnClick (Widget w, int x, int y, int button)
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)
void	SetData (Managed data)
	Store custom data.
Managed	GetData ()
	Get stored data.
Public Member Functions inherited from SCR_ScriptedWidgetComponent
Widget	GetRootWidget ()
bool	IsVisible ()

Public Attributes
float	m_fElementHeight
Public Attributes inherited from SCR_ToolboxComponent
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
override void	CreateWidgets ()
void	RemoveWidgets ()
Protected Member Functions inherited from SCR_ToolboxComponent
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
int	m_iMaxItemsInRow
Protected Attributes inherited from SCR_ToolboxComponent
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
string	m_sSoundContainerClosed
float	m_fAnimationTime
bool	m_bMouseOverToFocus
float	m_fDisabledOpacity
float	m_fAnimationRate
ref Managed	m_UserData
Protected Attributes inherited from SCR_ScriptedWidgetComponent
Widget	m_wRoot

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

Member Function Documentation

CreateWidgets()

override void SCR_ToolboxMultilineComponent.CreateWidgets ( )

protected

Implements SCR_ToolboxComponent.

FindSizeWidget()

SizeLayoutWidget SCR_ToolboxMultilineComponent.FindSizeWidget

(

Widget

root

)

GetMaxItemsInRow()

int SCR_ToolboxMultilineComponent.GetMaxItemsInRow

(

)

HandlerAttached()

override void SCR_ToolboxMultilineComponent.HandlerAttached

(

Widget

w

)

Implements SCR_ToolboxComponent.

RemoveWidgets()

void SCR_ToolboxMultilineComponent.RemoveWidgets ( )

protected

SetMaxItemsInRow()

void SCR_ToolboxMultilineComponent.SetMaxItemsInRow

(

int

maxItems

)

Member Data Documentation

m_fElementHeight

float SCR_ToolboxMultilineComponent.m_fElementHeight

m_iMaxItemsInRow

int SCR_ToolboxMultilineComponent.m_iMaxItemsInRow

protected

---

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

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