SCR_DynamicFooterComponent Interface Reference

Inheritance diagram for SCR_DynamicFooterComponent:

Public Member Functions
override void	HandlerAttached (Widget w)
SCR_InputButtonComponent	CreateButton (ResourceName layout, string tag, string label, string action, SCR_EDynamicFooterButtonAlignment alignment=0, bool visible=true)
SCR_InputButtonComponent	CreateButtonAtPosition (ResourceName layout, string tag, string label, string action, int position, SCR_EDynamicFooterButtonAlignment alignment=0, bool visible=true)
void	RegisterButton (SCR_InputButtonComponent button)
	Caches a button and binds the invoker. Uses the button widget's name as a tag.
SCR_InputButtonComponent	FindButton (string tag)
	Returns a button with given tag.
string	GetButtonTag (SCR_InputButtonComponent button)
	Returns a button's tag.
bool	RemoveButton (string tag)
	Removes an existing button.
void	ClearButtons ()
	Removes all buttons.
array< SCR_InputButtonComponent >	GetButtonsInFooter (SCR_EDynamicFooterButtonAlignment alignment)
	Returns all the buttons that are direct children of the left or right footer.
Widget	GetLeftFooter ()
Widget	GetRightFooter ()
ScriptInvokerString	GetOnButtonActivated ()
	Provides the button's name as a tag to easily identify which button was pressed.
Public Member Functions inherited from SCR_ScriptedWidgetComponent
override bool	OnClick (Widget w, int x, int y, int button)
Widget	GetRootWidget ()
bool	IsVisible ()

Static Public Member Functions
static array< SCR_InputButtonComponent >	FindChildrenButtons (notnull Widget w, bool searchImmediateChildrenOnly=true)
static SCR_DynamicFooterComponent	FindComponentInHierarchy (notnull Widget root)
static SCR_DynamicFooterComponent	FindComponent (notnull Widget w)
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.

Protected Attributes
float	m_fPadding
string	m_sLeftFooter
string	m_sRightFooter
ref map< string, SCR_InputButtonComponent >	m_Buttons = new map<string, SCR_InputButtonComponent>()
Widget	m_wLeftFooter
Widget	m_wRightFooter
ref ScriptInvokerString	m_OnButtonActivated
Protected Attributes inherited from SCR_ScriptedWidgetComponent
Widget	m_wRoot

Additional Inherited Members
Public Attributes inherited from SCR_ScriptedWidgetComponent
ref ScriptInvoker	m_OnClick = new ScriptInvoker

Member Function Documentation

ClearButtons()

void SCR_DynamicFooterComponent.ClearButtons

(

)

Removes all buttons.

CreateButton()

SCR_InputButtonComponent SCR_DynamicFooterComponent.CreateButton	(	ResourceName	layout,
		string	tag,
		string	label,
		string	action,
		SCR_EDynamicFooterButtonAlignment	alignment = 0,
		bool	visible = true )

Decide wrapper layout

Create new button

Button setup

Make sure the right footer is in the correct position if the layout has it as a child of the left footer

CreateButtonAtPosition()

SCR_InputButtonComponent SCR_DynamicFooterComponent.CreateButtonAtPosition	(	ResourceName	layout,
		string	tag,
		string	label,
		string	action,
		int	position,
		SCR_EDynamicFooterButtonAlignment	alignment = 0,
		bool	visible = true )

Decide wrapper layout

Adjust existing buttons' z order to insert new one

Create new button and set it's position

Make sure the right footer is in the correct position if the layout has it as a child of the left footer

FindButton()

SCR_InputButtonComponent SCR_DynamicFooterComponent.FindButton

(

string

tag

)

Returns a button with given tag.

FindChildrenButtons()

static array< SCR_InputButtonComponent > SCR_DynamicFooterComponent.FindChildrenButtons ( notnull Widget w, bool searchImmediateChildrenOnly = true )

static

FindComponent()

static SCR_DynamicFooterComponent SCR_DynamicFooterComponent.FindComponent ( notnull Widget w )

static

FindComponentInHierarchy()

static SCR_DynamicFooterComponent SCR_DynamicFooterComponent.FindComponentInHierarchy ( notnull Widget root )

static

GetButtonsInFooter()

array< SCR_InputButtonComponent > SCR_DynamicFooterComponent.GetButtonsInFooter

(

SCR_EDynamicFooterButtonAlignment

alignment

)

Returns all the buttons that are direct children of the left or right footer.

GetButtonTag()

string SCR_DynamicFooterComponent.GetButtonTag

(

SCR_InputButtonComponent

button

)

Returns a button's tag.

GetLeftFooter()

Widget SCR_DynamicFooterComponent.GetLeftFooter

(

)

GetOnButtonActivated()

ScriptInvokerString SCR_DynamicFooterComponent.GetOnButtonActivated

(

)

Provides the button's name as a tag to easily identify which button was pressed.

GetRightFooter()

Widget SCR_DynamicFooterComponent.GetRightFooter

(

)

HandlerAttached()

override void SCR_DynamicFooterComponent.HandlerAttached

(

Widget

w

)

Start searching from the widget above in case the component is inserted in the footer wrapper

Implements SCR_ScriptedWidgetComponent.

RegisterButton()

void SCR_DynamicFooterComponent.RegisterButton

(

SCR_InputButtonComponent

button

)

Caches a button and binds the invoker. Uses the button widget's name as a tag.

RemoveButton()

bool SCR_DynamicFooterComponent.RemoveButton

(

string

tag

)

Removes an existing button.

Member Data Documentation

m_Buttons

ref map<string, SCR_InputButtonComponent> SCR_DynamicFooterComponent.m_Buttons = new map<string, SCR_InputButtonComponent>()

protected

m_fPadding

float SCR_DynamicFooterComponent.m_fPadding

protected

m_OnButtonActivated

ref ScriptInvokerString SCR_DynamicFooterComponent.m_OnButtonActivated

protected

m_sLeftFooter

string SCR_DynamicFooterComponent.m_sLeftFooter

protected

m_sRightFooter

string SCR_DynamicFooterComponent.m_sRightFooter

protected

m_wLeftFooter

Widget SCR_DynamicFooterComponent.m_wLeftFooter

protected

m_wRightFooter

Widget SCR_DynamicFooterComponent.m_wRightFooter

protected

---

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

• Game/UI/Menu/SCR_DynamicFooterComponent.c