FUIAction Struct Reference

#include <UIAction.h>

Public Member Functions
SLATE_API	FUIAction ()
SLATE_API	FUIAction (FExecuteAction InitExecuteAction, EUIActionRepeatMode InitRepeatMode=EUIActionRepeatMode::RepeatDisabled)
SLATE_API	FUIAction (FExecuteAction InitExecuteAction, FCanExecuteAction InitCanExecuteAction, EUIActionRepeatMode InitRepeatMode=EUIActionRepeatMode::RepeatDisabled)
SLATE_API	FUIAction (FExecuteAction InitExecuteAction, FCanExecuteAction InitCanExecuteAction, FIsActionChecked InitIsCheckedDelegate, EUIActionRepeatMode InitRepeatMode=EUIActionRepeatMode::RepeatDisabled)
SLATE_API	FUIAction (FExecuteAction InitExecuteAction, FCanExecuteAction InitCanExecuteAction, FGetActionCheckState InitGetActionCheckStateDelegate, EUIActionRepeatMode InitRepeatMode=EUIActionRepeatMode::RepeatDisabled)
SLATE_API	FUIAction (FExecuteAction InitExecuteAction, FCanExecuteAction InitCanExecuteAction, FIsActionChecked InitIsCheckedDelegate, FIsActionButtonVisible InitIsActionVisibleDelegate, EUIActionRepeatMode InitRepeatMode=EUIActionRepeatMode::RepeatDisabled)
SLATE_API	FUIAction (FExecuteAction InitExecuteAction, FCanExecuteAction InitCanExecuteAction, FGetActionCheckState InitGetActionCheckStateDelegate, FIsActionButtonVisible InitIsActionVisibleDelegate, EUIActionRepeatMode InitRepeatMode=EUIActionRepeatMode::RepeatDisabled)
bool	CanExecute () const
bool	Execute () const
ECheckBoxState	GetCheckState () const
bool	IsBound () const
EVisibility	IsVisible () const
bool	CanRepeat () const

Static Public Member Functions
static ECheckBoxState	IsActionCheckedPassthrough (FIsActionChecked InDelegate)

Public Attributes
FExecuteAction	ExecuteAction
FCanExecuteAction	CanExecuteAction
FGetActionCheckState	GetActionCheckState
FIsActionButtonVisible	IsActionVisibleDelegate
EUIActionRepeatMode	RepeatMode

Detailed Description

Implements an UI action.

Constructor & Destructor Documentation

FUIAction() [1/7]

FUIAction::FUIAction

(

)

Default constructor.

FUIAction() [2/7]

FUIAction::FUIAction	(	FExecuteAction	InitExecuteAction,
		EUIActionRepeatMode	InitRepeatMode = EUIActionRepeatMode::RepeatDisabled
	)

Constructor that takes delegates to initialize the action with

Parameters

ExecuteAction	The delegate to call when the action should be executed
RepeatMode	Can this action can be repeated if the chord used to call it is held down?

FUIAction() [3/7]

FUIAction::FUIAction	(	FExecuteAction	InitExecuteAction,
		FCanExecuteAction	InitCanExecuteAction,
		EUIActionRepeatMode	InitRepeatMode = EUIActionRepeatMode::RepeatDisabled
	)

Constructor that takes delegates to initialize the action with

Parameters

ExecuteAction	The delegate to call when the action should be executed
CanExecuteAction	The delegate to call to see if the action can be executed
RepeatMode	Can this action can be repeated if the chord used to call it is held down?

FUIAction() [4/7]

FUIAction::FUIAction	(	FExecuteAction	InitExecuteAction,
		FCanExecuteAction	InitCanExecuteAction,
		FIsActionChecked	InitIsCheckedDelegate,
		EUIActionRepeatMode	InitRepeatMode = EUIActionRepeatMode::RepeatDisabled
	)

Constructor that takes delegates to initialize the action with

Parameters

ExecuteAction	The delegate to call when the action should be executed
CanExecuteAction	The delegate to call to see if the action can be executed
IsCheckedDelegate	The delegate to call to see if the action should appear checked when visualized
RepeatMode	Can this action can be repeated if the chord used to call it is held down?

FUIAction() [5/7]

FUIAction::FUIAction	(	FExecuteAction	InitExecuteAction,
		FCanExecuteAction	InitCanExecuteAction,
		FGetActionCheckState	InitGetActionCheckStateDelegate,
		EUIActionRepeatMode	InitRepeatMode = EUIActionRepeatMode::RepeatDisabled
	)

Constructor that takes delegates to initialize the action with

Parameters

ExecuteAction	The delegate to call when the action should be executed
CanExecuteAction	The delegate to call to see if the action can be executed
GetActionCheckState	The delegate to call to see what the check state of the action should be
RepeatMode	Can this action can be repeated if the chord used to call it is held down?

FUIAction() [6/7]

FUIAction::FUIAction	(	FExecuteAction	InitExecuteAction,
		FCanExecuteAction	InitCanExecuteAction,
		FIsActionChecked	InitIsCheckedDelegate,
		FIsActionButtonVisible	InitIsActionVisibleDelegate,
		EUIActionRepeatMode	InitRepeatMode = EUIActionRepeatMode::RepeatDisabled
	)

Constructor that takes delegates to initialize the action with

Parameters

ExecuteAction	The delegate to call when the action should be executed
CanExecuteAction	The delegate to call to see if the action can be executed
IsCheckedDelegate	The delegate to call to see if the action should appear checked when visualized
IsActionVisible	The delegate to call to see if the action should be visible
RepeatMode	Can this action can be repeated if the chord used to call it is held down?

FUIAction() [7/7]

FUIAction::FUIAction	(	FExecuteAction	InitExecuteAction,
		FCanExecuteAction	InitCanExecuteAction,
		FGetActionCheckState	InitGetActionCheckStateDelegate,
		FIsActionButtonVisible	InitIsActionVisibleDelegate,
		EUIActionRepeatMode	InitRepeatMode = EUIActionRepeatMode::RepeatDisabled
	)

Constructor that takes delegates to initialize the action with

Parameters

ExecuteAction	The delegate to call when the action should be executed
CanExecuteAction	The delegate to call to see if the action can be executed
GetActionCheckState	The delegate to call to see what the check state of the action should be
IsActionVisible	The delegate to call to see if the action should be visible
RepeatMode	Can this action can be repeated if the chord used to call it is held down?

Member Function Documentation

CanExecute()

bool FUIAction::CanExecute ( ) const

inline

Checks to see if its currently safe to execute this action.

Returns

True if this action can be executed and we should reflect that state visually in the UI

CanRepeat()

bool FUIAction::CanRepeat ( ) const

inline

Checks whether this action can be repeated if the chord used to call it is held down.

Returns

true if the delegate can be repeated, false otherwise.

Execute()

bool FUIAction::Execute ( ) const

inline

Executes this action

GetCheckState()

ECheckBoxState FUIAction::GetCheckState ( ) const

inline

Queries the checked state for this action. This is only valid for actions that are toggleable!

Returns

Checked state for this action

IsActionCheckedPassthrough()

static ECheckBoxState FUIAction::IsActionCheckedPassthrough ( FIsActionChecked  InDelegate )

inlinestatic

Passthrough function to convert the result from an FIsActionChecked delegate into something that works with a FGetActionCheckState delegate

IsBound()

bool FUIAction::IsBound ( ) const

inline

Checks whether this action's execution delegate is bound.

Returns

true if the delegate is bound, false otherwise.

IsVisible()

EVisibility FUIAction::IsVisible ( ) const

inline

Queries the visibility for this action.

Returns

Visibility state for this action

Member Data Documentation

CanExecuteAction

FCanExecuteAction FUIAction::CanExecuteAction

Holds a delegate that is executed when determining whether this action can execute.

ExecuteAction

FExecuteAction FUIAction::ExecuteAction

Holds a delegate that is executed when this action is activated.

GetActionCheckState

FGetActionCheckState FUIAction::GetActionCheckState

Holds a delegate that is executed when determining the check state of this action.

IsActionVisibleDelegate

FIsActionButtonVisible FUIAction::IsActionVisibleDelegate

Holds a delegate that is executed when determining whether this action is visible.

RepeatMode

EUIActionRepeatMode FUIAction::RepeatMode

Can this action can be repeated if the chord used to call it is held down?

---

The documentation for this struct was generated from the following files:

• Engine/Source/Runtime/Slate/Public/Framework/Commands/UIAction.h
• Engine/Source/Runtime/Slate/Private/Framework/Commands/UIAction.cpp