SCR_SelectableButtonComponent Class Reference

Inheritance diagram for SCR_SelectableButtonComponent:

Protected Member Functions
override void	HandlerAttached (Widget w)
void	SetImage (ResourceName sResource, string sImageName)
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	OnMenuSelect ()
void	ColorizeWidgets (Color colorBackground, Color colorContent, float speed=-1)
void	ColorizeCheckWidget ()
	Set color of checked line.
bool	IsSelected ()
void	SetSelected (bool selected, bool notify=true)

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

Protected Attributes
ResourceName	m_sImageResource
float	m_fContentPadding
string	WIDGET_CONTET_HLAYOUT = "hLayoutContent"
string	WIDGET_IMAGE = "ImageContent"
ref ScriptInvoker	m_OnChanged = new ScriptInvoker()
bool	m_bIsSelected = false
bool	m_bIsTriggered = true
Widget	m_wHLayoutContent
ImageWidget	m_wImageContent
ref Color	COLOR_CHECKED_TRUE = UIColors.CONTRAST_COLOR
ref Color	COLOR_CHECKED_FALSE = UIColors.WHITE_DEFAULT

Detailed Description

Selectable button. Supported states: Disaled, hovered, focused, selected, deselected Works with WLib_SelectableButton widget prefab

Definition at line 5 of file SCR_SelectableButtonComponent.c.

Member Function Documentation

ColorizeCheckWidget()

void SCR_SelectableButtonComponent::ColorizeCheckWidget ( )

inlineprotected

Set color of checked line.

Definition at line 157 of file SCR_SelectableButtonComponent.c.

ColorizeWidgets()

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

inlineprotected

Definition at line 147 of file SCR_SelectableButtonComponent.c.

GetSelectableButtonComponent()

SCR_SelectableButtonComponent SCR_SelectableButtonComponent::GetSelectableButtonComponent ( 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_SelectableButtonComponent.c.

HandlerAttached()

override void SCR_SelectableButtonComponent::HandlerAttached ( Widget w )

inlineprotected

Definition at line 32 of file SCR_SelectableButtonComponent.c.

IsSelected()

bool SCR_SelectableButtonComponent::IsSelected ( )

inlineprotected

Definition at line 167 of file SCR_SelectableButtonComponent.c.

OnClick()

override bool SCR_SelectableButtonComponent::OnClick ( Widget w, int x, int y, int button )

inlineprotected

Definition at line 80 of file SCR_SelectableButtonComponent.c.

OnFocus()

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

inlineprotected

Definition at line 114 of file SCR_SelectableButtonComponent.c.

OnFocusLost()

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

inlineprotected

Definition at line 123 of file SCR_SelectableButtonComponent.c.

OnMenuSelect()

void SCR_SelectableButtonComponent::OnMenuSelect ( )

inlineprotected

Definition at line 137 of file SCR_SelectableButtonComponent.c.

OnMouseEnter()

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

inlineprotected

Definition at line 91 of file SCR_SelectableButtonComponent.c.

OnMouseLeave()

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

inlineprotected

Definition at line 105 of file SCR_SelectableButtonComponent.c.

SetImage()

void SCR_SelectableButtonComponent::SetImage ( ResourceName sResource, string sImageName )

inlineprotected

Definition at line 63 of file SCR_SelectableButtonComponent.c.

SetSelected()

void SCR_SelectableButtonComponent::SetSelected ( bool selected, bool notify = true )

inlineprotected

Definition at line 173 of file SCR_SelectableButtonComponent.c.

Member Data Documentation

COLOR_CHECKED_FALSE

ref Color SCR_SelectableButtonComponent::COLOR_CHECKED_FALSE = UIColors.WHITE_DEFAULT

protected

Definition at line 29 of file SCR_SelectableButtonComponent.c.

COLOR_CHECKED_TRUE

ref Color SCR_SelectableButtonComponent::COLOR_CHECKED_TRUE = UIColors.CONTRAST_COLOR

protected

Definition at line 28 of file SCR_SelectableButtonComponent.c.

m_bIsSelected

bool SCR_SelectableButtonComponent::m_bIsSelected = false

protected

Definition at line 21 of file SCR_SelectableButtonComponent.c.

m_bIsTriggered

bool SCR_SelectableButtonComponent::m_bIsTriggered = true

protected

Definition at line 22 of file SCR_SelectableButtonComponent.c.

m_fContentPadding

float SCR_SelectableButtonComponent::m_fContentPadding

protected

Definition at line 14 of file SCR_SelectableButtonComponent.c.

m_OnChanged

ref ScriptInvoker SCR_SelectableButtonComponent::m_OnChanged = new ScriptInvoker()

protected

Definition at line 20 of file SCR_SelectableButtonComponent.c.

m_sImageResource

ResourceName SCR_SelectableButtonComponent::m_sImageResource

protected

Definition at line 8 of file SCR_SelectableButtonComponent.c.

m_wHLayoutContent

Widget SCR_SelectableButtonComponent::m_wHLayoutContent

protected

Definition at line 25 of file SCR_SelectableButtonComponent.c.

m_wImageContent

ImageWidget SCR_SelectableButtonComponent::m_wImageContent

protected

Definition at line 26 of file SCR_SelectableButtonComponent.c.

WIDGET_CONTET_HLAYOUT

string SCR_SelectableButtonComponent::WIDGET_CONTET_HLAYOUT = "hLayoutContent"

protected

Definition at line 17 of file SCR_SelectableButtonComponent.c.

WIDGET_IMAGE

string SCR_SelectableButtonComponent::WIDGET_IMAGE = "ImageContent"

protected

Definition at line 18 of file SCR_SelectableButtonComponent.c.

---

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

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