SCR_PagingButtonComponent Interface Reference

Inheritance diagram for SCR_PagingButtonComponent:

Public Member Functions
override void	HandlerAttached (Widget w)
override bool	OnClick (Widget w, int x, int y, int button)
override void	SetEnabled (bool enabled, bool animate=true)
bool	IsPositive ()
void	SetPositive (bool positive)
void	SetAction (string name)
override bool	OnMouseEnter (Widget w, int x, int y)
override bool	OnMouseLeave (Widget w, Widget enterW, int x, int y)
string	GetAction ()
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_PagingButtonComponent	GetPagingButtonComponent (string name, Widget parent, bool searchAllChildren=true)
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_bUseActionHint
string	m_sActionName
ref ScriptInvoker	m_OnActivated = 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
void	FlipImage (bool flip)
override void	OnMenuSelect ()
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
bool	m_bIsPositive
string	m_sBackgroundImageName = "BackgroundImage"
string	m_sFrontImageName = "Panel"
string	m_sActionTextName = "ActionText"
ImageWidget	m_wPanel
TextWidget	m_wText
Widget	m_wBackgroundImage
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

FlipImage()

void SCR_PagingButtonComponent.FlipImage ( bool  flip )

protected

GetAction()

string SCR_PagingButtonComponent.GetAction

(

)

GetPagingButtonComponent()

static SCR_PagingButtonComponent SCR_PagingButtonComponent.GetPagingButtonComponent ( string  name, Widget  parent, bool  searchAllChildren = true  )

static

HandlerAttached()

override void SCR_PagingButtonComponent.HandlerAttached

(

Widget

w

)

Implements SCR_ButtonBaseComponent.

IsPositive()

bool SCR_PagingButtonComponent.IsPositive

(

)

OnClick()

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

Implements SCR_ButtonBaseComponent.

OnMenuSelect()

override void SCR_PagingButtonComponent.OnMenuSelect ( )

protected

Implements SCR_ButtonBaseComponent.

OnMouseEnter()

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

Implements SCR_ButtonBaseComponent.

OnMouseLeave()

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

Implements SCR_ButtonBaseComponent.

SetAction()

void SCR_PagingButtonComponent.SetAction

(

string

name

)

SetEnabled()

override void SCR_PagingButtonComponent.SetEnabled	(	bool	enabled,
		bool	animate = true
	)

Implements SCR_WLibComponentBase.

SetPositive()

void SCR_PagingButtonComponent.SetPositive

(

bool

positive

)

Member Data Documentation

m_bIsPositive

bool SCR_PagingButtonComponent.m_bIsPositive

protected

m_bUseActionHint

bool SCR_PagingButtonComponent.m_bUseActionHint

m_OnActivated

ref ScriptInvoker SCR_PagingButtonComponent.m_OnActivated = new ScriptInvoker()

m_sActionName

string SCR_PagingButtonComponent.m_sActionName

m_sActionTextName

string SCR_PagingButtonComponent.m_sActionTextName = "ActionText"

protected

m_sBackgroundImageName

string SCR_PagingButtonComponent.m_sBackgroundImageName = "BackgroundImage"

protected

m_sFrontImageName

string SCR_PagingButtonComponent.m_sFrontImageName = "Panel"

protected

m_wBackgroundImage

Widget SCR_PagingButtonComponent.m_wBackgroundImage

protected

m_wPanel

ImageWidget SCR_PagingButtonComponent.m_wPanel

protected

m_wText

TextWidget SCR_PagingButtonComponent.m_wText

protected

---

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

• Game/UI/Components/WidgetLibrary/SCR_PagingButton/SCR_PagingButtonComponent.c