Selectable button. More...

Inheritance diagram for SCR_SelectableButtonComponent:

Public 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)

bool	IsSelected ()

void	SetSelected (bool selected, bool notify=true)

Public Member Functions inherited from SCR_ButtonComponent
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 ()

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_SelectableButtonComponent	GetSelectableButtonComponent (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_ButtonComponent
static SCR_ButtonComponent	GetButtonComponent (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_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
ref ScriptInvoker	m_OnChanged = new ScriptInvoker()

Public Attributes inherited from SCR_ButtonComponent
ref ScriptInvoker	m_OnHover = new ScriptInvoker()

ref ScriptInvoker< Widget >	m_OnHoverLeave = new ScriptInvoker()

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
override void	OnMenuSelect ()

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

void	ColorizeCheckWidget ()
	Set color of checked line.

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
ResourceName	m_sImageResource

float	m_fContentPadding

string	WIDGET_CONTET_HLAYOUT = "hLayoutContent"

string	WIDGET_IMAGE = "ImageContent"

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

Protected Attributes inherited from SCR_ButtonComponent
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

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

Detailed Description

Selectable button.

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

Member Function Documentation

◆ ColorizeCheckWidget()

void SCR_SelectableButtonComponent.ColorizeCheckWidget ( )

protected

Set color of checked line.

◆ ColorizeWidgets()

override void SCR_SelectableButtonComponent.ColorizeWidgets	(	Color	colorBackground,
		Color	colorContent,
		float	speed = `-1`
	)

protected

Implements SCR_ButtonComponent.

◆ GetSelectableButtonComponent()

static SCR_SelectableButtonComponent SCR_SelectableButtonComponent.GetSelectableButtonComponent	(	string	name,
		Widget	parent,
		bool	searchAllChildren = `true`
	)

static

Static method to easily find component by providing name and parent.

Searching all children will go through whole hierarchy, instead of immediate chidren

◆ HandlerAttached()

override void SCR_SelectableButtonComponent.HandlerAttached ( Widget w )

Implements SCR_ButtonComponent.

◆ IsSelected()

bool SCR_SelectableButtonComponent.IsSelected ( )

◆ OnClick()

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

Implements SCR_ButtonBaseComponent.

◆ OnFocus()

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

Implements SCR_ButtonComponent.

◆ OnFocusLost()

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

Implements SCR_ButtonComponent.

◆ OnMenuSelect()

override void SCR_SelectableButtonComponent.OnMenuSelect ( )

protected

Implements SCR_ButtonBaseComponent.

◆ OnMouseEnter()

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

Implements SCR_ButtonComponent.

◆ OnMouseLeave()

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

Implements SCR_ButtonComponent.

◆ SetImage()

void SCR_SelectableButtonComponent.SetImage	(	ResourceName	sResource,
		string	sImageName
	)

◆ SetSelected()

void SCR_SelectableButtonComponent.SetSelected	(	bool	selected,
		bool	notify = `true`
	)

Member Data Documentation

◆ COLOR_CHECKED_FALSE

ref Color SCR_SelectableButtonComponent.COLOR_CHECKED_FALSE = UIColors.WHITE_DEFAULT

protected

◆ COLOR_CHECKED_TRUE

ref Color SCR_SelectableButtonComponent.COLOR_CHECKED_TRUE = UIColors.CONTRAST_COLOR

protected

◆ m_bIsSelected

bool SCR_SelectableButtonComponent.m_bIsSelected = false

protected

◆ m_bIsTriggered

bool SCR_SelectableButtonComponent.m_bIsTriggered = true

protected

◆ m_fContentPadding

float SCR_SelectableButtonComponent.m_fContentPadding

protected

◆ m_OnChanged

ref ScriptInvoker SCR_SelectableButtonComponent.m_OnChanged = new ScriptInvoker()

◆ m_sImageResource

ResourceName SCR_SelectableButtonComponent.m_sImageResource

protected

◆ m_wHLayoutContent

Widget SCR_SelectableButtonComponent.m_wHLayoutContent

protected

◆ m_wImageContent

ImageWidget SCR_SelectableButtonComponent.m_wImageContent

protected

◆ WIDGET_CONTET_HLAYOUT

string SCR_SelectableButtonComponent.WIDGET_CONTET_HLAYOUT = "hLayoutContent"

protected

◆ WIDGET_IMAGE

string SCR_SelectableButtonComponent.WIDGET_IMAGE = "ImageContent"

protected

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

Game/UI/Components/WidgetLibrary/SCR_SelectableButtonComponent.c

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ ColorizeCheckWidget()

◆ ColorizeWidgets()

◆ GetSelectableButtonComponent()

◆ HandlerAttached()

◆ IsSelected()

◆ OnClick()

◆ OnFocus()

◆ OnFocusLost()

◆ OnMenuSelect()

◆ OnMouseEnter()

◆ OnMouseLeave()

◆ SetImage()

◆ SetSelected()

Member Data Documentation

◆ COLOR_CHECKED_FALSE

◆ COLOR_CHECKED_TRUE

◆ m_bIsSelected

◆ m_bIsTriggered

◆ m_fContentPadding

◆ m_OnChanged

◆ m_sImageResource

◆ m_wHLayoutContent

◆ m_wImageContent

◆ WIDGET_CONTET_HLAYOUT

◆ WIDGET_IMAGE