SCR_ButtonComponent Class Reference

Deprecated button component. Still used in many prefabs, so it works, it's just stripped of most of the functionality. More...

Inheritance diagram for SCR_ButtonComponent:

Protected Member Functions
override void	HandlerAttached (Widget w)
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	ColorizeWidgets (Color colorBackground, Color colorContent, float speed=-1)
void	SetHorizontalAlign (LayoutHorizontalAlign horizontalAlign)
void	SetContent (string text)
void	SetContentFromUIInfo (SCR_UIInfo info)
string	GetContent ()

Static Protected Member Functions
static SCR_ButtonComponent	GetButtonComponent (string name, Widget parent, bool searchAllChildren=true)

Protected Attributes
LocalizedString	m_sContent
Widget	m_wOverlay
Widget	m_wContent
ref Color	COLOR_BACKGROUND_DEFAULT = UIColors.BACKGROUND_DEFAULT
ref Color	COLOR_BACKGROUND_HOVERED = UIColors.BACKGROUND_HOVERED
ref Color	COLOR_BACKGROUND_FOCUSED = UIColors.BACKGROUND_HOVERED
ref Color	COLOR_BACKGROUND_CLICKED = UIColors.BACKGROUND_HOVERED
ref Color	COLOR_CONTENT_DEFAULT = Color.White
ref Color	COLOR_CONTENT_HOVERED = Color.White
ref Color	COLOR_CONTENT_FOCUSED = Color.White
ref Color	COLOR_CONTENT_CLICKED = Color.White
ref ScriptInvoker	m_OnHover = new ScriptInvoker()
ref ScriptInvoker< Widget >	m_OnHoverLeave = new ScriptInvoker()

Detailed Description

Deprecated button component. Still used in many prefabs, so it works, it's just stripped of most of the functionality.

Definition at line 4 of file SCR_ButtonComponent.c.

Member Function Documentation

ColorizeWidgets()

void SCR_ButtonComponent::ColorizeWidgets ( Color colorBackground, Color colorContent, float speed = -1 )

inlineprotected

Definition at line 129 of file SCR_ButtonComponent.c.

GetButtonComponent()

SCR_ButtonComponent SCR_ButtonComponent::GetButtonComponent ( string name, Widget parent, bool searchAllChildren = true )

inlinestaticprotected

Static method to easily find component by providing name and parent. Searching all children will go through whole hierarchy, instead of immediate chidren

Definition at line 189 of file SCR_ButtonComponent.c.

GetContent()

string SCR_ButtonComponent::GetContent ( )

inlineprotected

Definition at line 181 of file SCR_ButtonComponent.c.

HandlerAttached()

override void SCR_ButtonComponent::HandlerAttached ( Widget w )

inlineprotected

Definition at line 27 of file SCR_ButtonComponent.c.

OnFocus()

override bool SCR_ButtonComponent::OnFocus ( Widget w, int x, int y )

inlineprotected

Definition at line 114 of file SCR_ButtonComponent.c.

OnFocusLost()

override bool SCR_ButtonComponent::OnFocusLost ( Widget w, int x, int y )

inlineprotected

Definition at line 122 of file SCR_ButtonComponent.c.

OnMouseEnter()

override bool SCR_ButtonComponent::OnMouseEnter ( Widget w, int x, int y )

inlineprotected

Definition at line 92 of file SCR_ButtonComponent.c.

OnMouseLeave()

override bool SCR_ButtonComponent::OnMouseLeave ( Widget w, Widget enterW, int x, int y )

inlineprotected

Definition at line 103 of file SCR_ButtonComponent.c.

SetContent()

void SCR_ButtonComponent::SetContent ( string text )

inlineprotected

Definition at line 150 of file SCR_ButtonComponent.c.

SetContentFromUIInfo()

void SCR_ButtonComponent::SetContentFromUIInfo ( SCR_UIInfo info )

inlineprotected

Definition at line 171 of file SCR_ButtonComponent.c.

SetHorizontalAlign()

void SCR_ButtonComponent::SetHorizontalAlign ( LayoutHorizontalAlign horizontalAlign )

inlineprotected

Definition at line 139 of file SCR_ButtonComponent.c.

Member Data Documentation

COLOR_BACKGROUND_CLICKED

ref Color SCR_ButtonComponent::COLOR_BACKGROUND_CLICKED = UIColors.BACKGROUND_HOVERED

protected

Definition at line 15 of file SCR_ButtonComponent.c.

COLOR_BACKGROUND_DEFAULT

ref Color SCR_ButtonComponent::COLOR_BACKGROUND_DEFAULT = UIColors.BACKGROUND_DEFAULT

protected

Definition at line 12 of file SCR_ButtonComponent.c.

COLOR_BACKGROUND_FOCUSED

ref Color SCR_ButtonComponent::COLOR_BACKGROUND_FOCUSED = UIColors.BACKGROUND_HOVERED

protected

Definition at line 14 of file SCR_ButtonComponent.c.

COLOR_BACKGROUND_HOVERED

ref Color SCR_ButtonComponent::COLOR_BACKGROUND_HOVERED = UIColors.BACKGROUND_HOVERED

protected

Definition at line 13 of file SCR_ButtonComponent.c.

COLOR_CONTENT_CLICKED

ref Color SCR_ButtonComponent::COLOR_CONTENT_CLICKED = Color.White

protected

Definition at line 20 of file SCR_ButtonComponent.c.

COLOR_CONTENT_DEFAULT

ref Color SCR_ButtonComponent::COLOR_CONTENT_DEFAULT = Color.White

protected

Definition at line 17 of file SCR_ButtonComponent.c.

COLOR_CONTENT_FOCUSED

ref Color SCR_ButtonComponent::COLOR_CONTENT_FOCUSED = Color.White

protected

Definition at line 19 of file SCR_ButtonComponent.c.

COLOR_CONTENT_HOVERED

ref Color SCR_ButtonComponent::COLOR_CONTENT_HOVERED = Color.White

protected

Definition at line 18 of file SCR_ButtonComponent.c.

m_OnHover

ref ScriptInvoker SCR_ButtonComponent::m_OnHover = new ScriptInvoker()

protected

Definition at line 23 of file SCR_ButtonComponent.c.

m_OnHoverLeave

ref ScriptInvoker<Widget> SCR_ButtonComponent::m_OnHoverLeave = new ScriptInvoker()

protected

Definition at line 24 of file SCR_ButtonComponent.c.

m_sContent

LocalizedString SCR_ButtonComponent::m_sContent

protected

Definition at line 7 of file SCR_ButtonComponent.c.

m_wContent

Widget SCR_ButtonComponent::m_wContent

protected

Definition at line 10 of file SCR_ButtonComponent.c.

m_wOverlay

Widget SCR_ButtonComponent::m_wOverlay

protected

Definition at line 9 of file SCR_ButtonComponent.c.

---

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

• scripts/Game/UI/Components/WidgetLibrary/SCR_ButtonComponent.c