SCR_ButtonTextComponent Interface Reference

Inheritance diagram for SCR_ButtonTextComponent:

Public Member Functions
override void	HandlerAttached (Widget w)
override void	SetToggled (bool toggled, bool animate=true, bool invokeChange=true, bool instant=false)
override bool	OnMouseEnter (Widget w, int x, int y)
override bool	OnMouseLeave (Widget w, Widget enterW, int x, int y)
void	SetText (string text)
void	SetTextWithParam (string text, string param1, string param2)
string	GetText ()
TextWidget	GetTextWidget ()
ScriptInvokerVoid	GetOnMouseEnter ()
ScriptInvokerVoid	GetOnMouseLeave ()
Public Member Functions inherited from SCR_ButtonBaseComponent
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	OnMouseLeave (Widget w, Widget enterW, int x, int y)
override bool	OnFocus (Widget w, int x, int y)
override bool	OnFocusLost (Widget w, int x, int y)
void	SetToggled (bool toggled, bool animate=true, bool invokeChange=true, bool instant=false)
bool	IsToggled ()
void	SetToggleable (bool togglable)
bool	GetToggleable ()
void	ShowBorder (bool show, bool animate=true)
bool	IsBorderShown ()
void	SetBackgroundColors (Color defColor=null, Color hoverColor=null, Color selectColor=null, Color selectHoverColor=null, Color clickColor=null)
	Alternate way of setting button background colors through script.
void	ColorizeBackground (bool animate=true)
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_ButtonTextComponent	GetButtonText (string name, Widget parent, bool searchAllChildren=true)
static SCR_ButtonTextComponent	FindButtonTextComponent (notnull Widget w)
Static Public Member Functions inherited from SCR_ButtonBaseComponent
static SCR_ButtonBaseComponent	GetButtonBase (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_bUseTextColorization
ref Color	m_TextDefault
ref Color	m_TextToggled
Public Attributes inherited from SCR_ButtonBaseComponent
bool	m_bCanBeToggled
bool	m_bUseColorization
ref Color	m_BackgroundDefault
ref Color	m_BackgroundHovered
ref Color	m_BackgroundSelected
ref Color	m_BackgroundSelectedHovered
ref Color	m_BackgroundClicked
bool	m_bShowBorderOnFocus
bool	m_bShowBackgroundOnFocus
bool	m_bNoBorderAnimation
bool	m_bNoBackgroundAnimation
bool	m_bShowBorderOnHover
Widget	m_wBackground
Widget	m_wBorder
ref ScriptInvoker	m_OnClicked = new ScriptInvoker()
ref ScriptInvoker	m_OnToggled = new ScriptInvoker()
ref ScriptInvoker< Widget >	m_OnFocus = new ScriptInvoker<Widget>()
ref ScriptInvoker< Widget >	m_OnFocusLost = new ScriptInvoker<Widget>()
ref ScriptInvoker	m_OnShowBorder = new ScriptInvoker()
Public Attributes inherited from SCR_ScriptedWidgetComponent
ref ScriptInvoker	m_OnClick = new ScriptInvoker

Protected Member Functions
void	ColorizeText (bool animate=true)
Protected Member Functions inherited from SCR_ButtonBaseComponent
void	OnMenuSelect ()
void	MenuSelectBase ()
void	FindParentMenu ()
	Finds the parent menu of this component.
bool	IsParentMenuFocused ()
	Returns true if parent menu is focused, or if there is no parent menu.
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
LocalizedString	m_sTextWidgetName
LocalizedString	m_sText
TextWidget	m_wText
ref ScriptInvokerVoid	m_OnMouseEnter
ref ScriptInvokerVoid	m_OnMouseLeave
Protected Attributes inherited from SCR_ButtonBaseComponent
bool	m_bIsToggled
MenuBase	m_ParentMenu
SCR_SubMenuBase	m_ParentSubMenu
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

ColorizeText()

void SCR_ButtonTextComponent.ColorizeText ( bool  animate = true )

protected

FindButtonTextComponent()

static SCR_ButtonTextComponent SCR_ButtonTextComponent.FindButtonTextComponent ( notnull Widget  w )

static

GetButtonText()

static SCR_ButtonTextComponent SCR_ButtonTextComponent.GetButtonText ( string  name, Widget  parent, bool  searchAllChildren = true  )

static

GetOnMouseEnter()

ScriptInvokerVoid SCR_ButtonTextComponent.GetOnMouseEnter

(

)

GetOnMouseLeave()

ScriptInvokerVoid SCR_ButtonTextComponent.GetOnMouseLeave

(

)

GetText()

string SCR_ButtonTextComponent.GetText

(

)

GetTextWidget()

TextWidget SCR_ButtonTextComponent.GetTextWidget

(

)

HandlerAttached()

override void SCR_ButtonTextComponent.HandlerAttached

(

Widget

w

)

Implements SCR_ButtonBaseComponent.

Implemented in SCR_ButtonCheckerComponent.

OnMouseEnter()

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

Implements SCR_ButtonBaseComponent.

OnMouseLeave()

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

Implements SCR_ButtonBaseComponent.

SetText()

void SCR_ButtonTextComponent.SetText

(

string

text

)

SetTextWithParam()

void SCR_ButtonTextComponent.SetTextWithParam	(	string	text,
		string	param1,
		string	param2
	)

SetToggled()

override void SCR_ButtonTextComponent.SetToggled	(	bool	toggled,
		bool	animate = true,
		bool	invokeChange = true,
		bool	instant = false
	)

Implements SCR_ButtonBaseComponent.

Implemented in SCR_ButtonCheckerComponent.

Member Data Documentation

m_bUseTextColorization

bool SCR_ButtonTextComponent.m_bUseTextColorization

m_OnMouseEnter

ref ScriptInvokerVoid SCR_ButtonTextComponent.m_OnMouseEnter

protected

m_OnMouseLeave

ref ScriptInvokerVoid SCR_ButtonTextComponent.m_OnMouseLeave

protected

m_sText

LocalizedString SCR_ButtonTextComponent.m_sText

protected

m_sTextWidgetName

LocalizedString SCR_ButtonTextComponent.m_sTextWidgetName

protected

m_TextDefault

ref Color SCR_ButtonTextComponent.m_TextDefault

m_TextToggled

ref Color SCR_ButtonTextComponent.m_TextToggled

m_wText

TextWidget SCR_ButtonTextComponent.m_wText

protected

---

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

• Game/UI/Components/WidgetLibrary/Button/SCR_ButtonTextComponent.c