ButtonActionComponent Interface Reference

Component to execute action when the button or its shortcut is pressed. More...

Inheritance diagram for ButtonActionComponent:

Public Member Functions
ScriptInvoker	GetOnAction ()
	Get invoker called when the button or its shortcut is pressed.
int	GetMouseButton ()
	Get mouse button this component is tracking.
override bool	OnClick (Widget w, int x, int y, int button)
override void	HandlerAttached (Widget w)
override void	HandlerDeattached (Widget w)

Static Public Member Functions
static ScriptInvoker	GetOnAction (Widget w, string buttonName, bool canCreateComponent=false, int mouseButton=0)
	Get invoker called when the button or its shortcut is pressed.
static ScriptInvoker	GetOnAction (Widget button, bool canCreateComponent=false, int mouseButton=0)
	Get invoker called when the button or its shortcut is pressed.

Protected Member Functions
void	Execute (float value, EActionTrigger reason)
void	OnAction (float value, EActionTrigger reason)

Detailed Description

Component to execute action when the button or its shortcut is pressed.

Member Function Documentation

Execute()

void ButtonActionComponent.Execute ( float value, EActionTrigger reason )

protected

GetMouseButton()

int ButtonActionComponent.GetMouseButton

(

)

Get mouse button this component is tracking.

Returns

Mouse button ID

GetOnAction() [1/3]

ScriptInvoker ButtonActionComponent.GetOnAction

(

)

Get invoker called when the button or its shortcut is pressed.

Returns

Script invoker

GetOnAction() [2/3]

static ScriptInvoker ButtonActionComponent.GetOnAction ( Widget button, bool canCreateComponent = false, int mouseButton = 0 )

static

Get invoker called when the button or its shortcut is pressed.

Example of use:

ScriptInvoker onButtonPressed = ButtonActionComponent.GetOnAction(buttonWidget);
if (onButtonPressed)
    onButtonPressed.Insert(OnButtonPressed);

Parameters

[in]	button	button widget
[in]	canCreateComponent	When true, new ButtonActionComponent will be created for the widget when none exists
[in]	mouseButton	ID of mouse button which the component should track

Returns

Script invoker

GetOnAction() [3/3]

static ScriptInvoker ButtonActionComponent.GetOnAction ( Widget w, string buttonName, bool canCreateComponent = false, int mouseButton = 0 )

static

Get invoker called when the button or its shortcut is pressed.

Example of use:

ScriptInvoker onButtonPressed = ButtonActionComponent.GetOnAction(w, "MyButton");
if (onButtonPressed)
    onButtonPressed.Insert(OnButtonPressed);

Parameters

[in]	w	Parent widget
[in]	buttonName	Button whose invoker is looked for
[in]	canCreateComponent	when true, new ButtonActionComponent will be created for the widget when none exists
[in]	mouseButton

Returns

Script invoker

HandlerAttached()

override void ButtonActionComponent.HandlerAttached

(

Widget

w

)

HandlerDeattached()

override void ButtonActionComponent.HandlerDeattached

(

Widget

w

)

OnAction()

void ButtonActionComponent.OnAction ( float value, EActionTrigger reason )

protected

OnClick()

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

---

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

• Game/UI/Components/ButtonComponents/ButtonActionComponent.c