SCR_ButtonBaseComponent Interface Reference

Base class for any button, regardless its own content. More...

Inheritance diagram for SCR_ButtonBaseComponent:

Public Member Functions
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_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_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	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
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

Base class for any button, regardless its own content.

Member Function Documentation

ColorizeBackground()

void SCR_ButtonBaseComponent.ColorizeBackground

(

bool

animate = true

)

FindParentMenu()

void SCR_ButtonBaseComponent.FindParentMenu ( )

protected

Finds the parent menu of this component.

GetButtonBase()

static SCR_ButtonBaseComponent SCR_ButtonBaseComponent.GetButtonBase ( string  name, Widget  parent, bool  searchAllChildren = true  )

static

GetToggleable()

bool SCR_ButtonBaseComponent.GetToggleable

(

)

HandlerAttached()

override void SCR_ButtonBaseComponent.HandlerAttached

(

Widget

w

)

Implements SCR_WLibComponentBase.

Implemented in SCR_GroupFlagImageComponent, SCR_ToolMenuButtonComponent, SCR_TaskListEntryHandler, SCR_TaskPlayerListEntryHandler, SCR_ModdedScenarioComponent, SCR_ButtonImageComponent, SCR_ButtonTextComponent, SCR_ButtonComponent, SCR_ButtonSplitComponent, SCR_ButtonCheckerComponent, SCR_InputButtonComponent, SCR_MultipleStatesButtonComponent, SCR_PagingButtonComponent, SCR_SelectableButtonComponent, SCR_SelectableTileButtonComponent, SCR_ContentEntryComponent, SCR_ModEntryComponent, SCR_DeployButton, SCR_DeployButtonBase, SCR_FactionButton, SCR_GroupButton, and SCR_LoadoutButton.

IsBorderShown()

bool SCR_ButtonBaseComponent.IsBorderShown

(

)

IsParentMenuFocused()

bool SCR_ButtonBaseComponent.IsParentMenuFocused ( )

protected

Returns true if parent menu is focused, or if there is no parent menu.

IsToggled()

bool SCR_ButtonBaseComponent.IsToggled

(

)

MenuSelectBase()

void SCR_ButtonBaseComponent.MenuSelectBase ( )

protected

OnClick()

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

Implements SCR_WLibComponentBase.

Implemented in SCR_GroupTileButton, SCR_TaskListEntryHandler, SCR_InventoryNavigationButtonBack, SCR_ButtonCheckerComponent, SCR_InputButtonComponent, SCR_MultipleStatesButtonComponent, SCR_PagingButtonComponent, SCR_SelectableButtonComponent, SCR_SelectableTileButtonComponent, and SCR_DeployButtonBase.

OnFocus()

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

Implements SCR_WLibComponentBase.

Implemented in SCR_GroupTileButton, SCR_TaskListEntryHandler, SCR_TaskPlayerListEntryHandler, SCR_ModdedScenarioComponent, SCR_ButtonComponent, SCR_MultipleStatesButtonComponent, SCR_SelectableButtonComponent, SCR_SelectableTileButtonComponent, SCR_ModEntryComponent, SCR_DeployButtonBase, and SCR_LoadoutButton.

OnFocusLost()

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

Implemented in SCR_TaskListEntryHandler, SCR_TaskPlayerListEntryHandler, SCR_ButtonComponent, SCR_MultipleStatesButtonComponent, SCR_SelectableButtonComponent, SCR_SelectableTileButtonComponent, SCR_ModEntryComponent, SCR_DeployButtonBase, and SCR_LoadoutButton.

OnMenuSelect()

void SCR_ButtonBaseComponent.OnMenuSelect ( )

protected

Implemented in SCR_MultipleStatesButtonComponent, SCR_PagingButtonComponent, SCR_SelectableButtonComponent, and SCR_SelectableTileButtonComponent.

OnMouseEnter()

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

Implements SCR_WLibComponentBase.

Implemented in SCR_TaskPlayerListEntryHandler, SCR_ButtonImageComponent, SCR_ButtonTextComponent, SCR_ButtonComponent, SCR_ButtonSplitComponent, SCR_InputButtonComponent, SCR_MultipleStatesButtonComponent, SCR_PagingButtonComponent, SCR_SelectableButtonComponent, and SCR_SelectableTileButtonComponent.

OnMouseLeave()

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

Implemented in SCR_TaskPlayerListEntryHandler, SCR_InventoryNavigationButtonBack, SCR_ButtonImageComponent, SCR_ButtonTextComponent, SCR_ButtonComponent, SCR_ButtonSplitComponent, SCR_InputButtonComponent, SCR_MultipleStatesButtonComponent, SCR_PagingButtonComponent, SCR_SelectableButtonComponent, and SCR_SelectableTileButtonComponent.

SetBackgroundColors()

void SCR_ButtonBaseComponent.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.

SetToggleable()

void SCR_ButtonBaseComponent.SetToggleable

(

bool

togglable

)

SetToggled()

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

Implemented in SCR_ButtonTextComponent, and SCR_ButtonCheckerComponent.

ShowBorder()

void SCR_ButtonBaseComponent.ShowBorder	(	bool	show,
		bool	animate = true
	)

Member Data Documentation

m_BackgroundClicked

ref Color SCR_ButtonBaseComponent.m_BackgroundClicked

m_BackgroundDefault

ref Color SCR_ButtonBaseComponent.m_BackgroundDefault

m_BackgroundHovered

ref Color SCR_ButtonBaseComponent.m_BackgroundHovered

m_BackgroundSelected

ref Color SCR_ButtonBaseComponent.m_BackgroundSelected

m_BackgroundSelectedHovered

ref Color SCR_ButtonBaseComponent.m_BackgroundSelectedHovered

m_bCanBeToggled

bool SCR_ButtonBaseComponent.m_bCanBeToggled

m_bIsToggled

bool SCR_ButtonBaseComponent.m_bIsToggled

protected

m_bNoBackgroundAnimation

bool SCR_ButtonBaseComponent.m_bNoBackgroundAnimation

m_bNoBorderAnimation

bool SCR_ButtonBaseComponent.m_bNoBorderAnimation

m_bShowBackgroundOnFocus

bool SCR_ButtonBaseComponent.m_bShowBackgroundOnFocus

m_bShowBorderOnFocus

bool SCR_ButtonBaseComponent.m_bShowBorderOnFocus

m_bShowBorderOnHover

bool SCR_ButtonBaseComponent.m_bShowBorderOnHover

m_bUseColorization

bool SCR_ButtonBaseComponent.m_bUseColorization

m_OnClicked

ref ScriptInvoker SCR_ButtonBaseComponent.m_OnClicked = new ScriptInvoker()

m_OnFocus

ref ScriptInvoker<Widget> SCR_ButtonBaseComponent.m_OnFocus = new ScriptInvoker<Widget>()

m_OnFocusLost

ref ScriptInvoker<Widget> SCR_ButtonBaseComponent.m_OnFocusLost = new ScriptInvoker<Widget>()

m_OnShowBorder

ref ScriptInvoker SCR_ButtonBaseComponent.m_OnShowBorder = new ScriptInvoker()

m_OnToggled

ref ScriptInvoker SCR_ButtonBaseComponent.m_OnToggled = new ScriptInvoker()

m_ParentMenu

MenuBase SCR_ButtonBaseComponent.m_ParentMenu

protected

m_ParentSubMenu

SCR_SubMenuBase SCR_ButtonBaseComponent.m_ParentSubMenu

protected

m_wBackground

Widget SCR_ButtonBaseComponent.m_wBackground

m_wBorder

Widget SCR_ButtonBaseComponent.m_wBorder

---

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

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