SCR_ChangeableComponentBase Interface Reference

Base class for all widgets that can change their internal state as editbox or spinbox. More...

Inheritance diagram for SCR_ChangeableComponentBase:

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 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!
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 ()

Public Attributes
ref ScriptInvoker	m_OnChanged = new ScriptInvoker()
Public Attributes inherited from SCR_ScriptedWidgetComponent
ref ScriptInvoker	m_OnClick = new ScriptInvoker

Protected Member Functions
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
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 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

Detailed Description

Base class for all widgets that can change their internal state as editbox or spinbox.

Member Function Documentation

ClearLabel()

void SCR_ChangeableComponentBase.ClearLabel ( )

protected

GetLabel()

TextWidget SCR_ChangeableComponentBase.GetLabel

(

)

GetLabelWidget()

Widget SCR_ChangeableComponentBase.GetLabelWidget

(

)

If label is not used, label widget might not exist at all!

HandlerAttached()

override void SCR_ChangeableComponentBase.HandlerAttached

(

Widget

w

)

Implements SCR_WLibComponentBase.

Implemented in SCR_ComboBoxComponent, SCR_ComboBoxIconComponent, SCR_EditBoxComponent, SCR_EditBoxSearchComponent, SCR_SliderComponent, SCR_SpinBoxComponent, SCR_ToolboxComponent, SCR_ToolboxMultilineComponent, SCR_InventorySpinBoxComponent, and SCR_ServerSortingComponent.

IsUsingLabel()

bool SCR_ChangeableComponentBase.IsUsingLabel

(

)

OnFocus()

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

Implements SCR_WLibComponentBase.

Implemented in SCR_ComboBoxComponent, SCR_EditBoxComponent, SCR_SliderComponent, SCR_SpinBoxComponent, SCR_ToolboxComponent, SCR_InventorySpinBoxComponent, and SCR_SpawnPointSpinBox.

OnFocusLost()

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

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

OnMouseEnter()

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

Implements SCR_WLibComponentBase.

Implemented in SCR_EditBoxSearchComponent, and SCR_ToolboxComponent.

OnMouseLeave()

override bool SCR_ChangeableComponentBase.OnMouseLeave	(	Widget	w,
		Widget	enterW,
		int	x,
		int	y
	)

SetLabel()

void SCR_ChangeableComponentBase.SetLabel

(

string

label

)

SetupLabel()

void SCR_ChangeableComponentBase.SetupLabel ( )

protected

UseLabel()

void SCR_ChangeableComponentBase.UseLabel

(

bool

use

)

Member Data Documentation

m_bForceSize

bool SCR_ChangeableComponentBase.m_bForceSize

protected

m_bUseLabel

bool SCR_ChangeableComponentBase.m_bUseLabel

protected

m_fSizeWithLabel

float SCR_ChangeableComponentBase.m_fSizeWithLabel

protected

m_fSizeWithoutLabel

float SCR_ChangeableComponentBase.m_fSizeWithoutLabel

protected

m_OnChanged

ref ScriptInvoker SCR_ChangeableComponentBase.m_OnChanged = new ScriptInvoker()

m_sLabel

string SCR_ChangeableComponentBase.m_sLabel

protected

m_sLabelLayout

ResourceName SCR_ChangeableComponentBase.m_sLabelLayout

protected

m_sSizeLayout

string SCR_ChangeableComponentBase.m_sSizeLayout

protected

m_wBackground

Widget SCR_ChangeableComponentBase.m_wBackground

protected

m_wBorder

Widget SCR_ChangeableComponentBase.m_wBorder

protected

m_wLabelRoot

Widget SCR_ChangeableComponentBase.m_wLabelRoot

protected

---

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

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