FUIAction

Implements an UI action.

Windows
MacOS
Linux

References

Module

Slate

Header

/Engine/Source/Runtime/Slate/Public/Framework/Commands/UIAction.h

Include

#include "Framework/Commands/UIAction.h"

Syntax

struct FUIAction

Remarks

Implements an UI action.

Variables

Name Description

Public variable

FCanExecuteAction

 

CanExecuteAction

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

Public variable

FExecuteAction

 

ExecuteAction

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

Public variable

FGetActionCheckState

 

GetActionCheckState

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

Public variable

FIsActionButtonVisible

 

IsActionVisibleDelegate

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

Public variable

EUIActionRepeatMode

 

RepeatMode

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

Constructors

Name Description

Public function

FUIAction()

Default constructor.

Public function

FUIAction

(
    FExecuteAction InitExecuteAction,
    EUIActionRepeatMode InitRepeatMode
)

Constructor that takes delegates to initialize the action with

Public function

FUIAction

(
    FExecuteAction InitExecuteAction,
    FCanExecuteAction InitCanExecuteAction,
    EUIActionRepeatMode InitRepeatMode
)

Constructor that takes delegates to initialize the action with

Public function

FUIAction

(
    FExecuteAction InitExecuteAction,
    FCanExecuteAction InitCanExecuteAction,
    FIsActionChecked InitIsCheckedDelegate,
    EUIActionRepeatMode InitRepeatMode
)

Constructor that takes delegates to initialize the action with

Public function

FUIAction

(
    FExecuteAction InitExecuteAction,
    FCanExecuteAction InitCanExecuteAction,
    FGetActionCheckState InitGetActionCheckStateDelegate,
    EUIActionRepeatMode InitRepeatMode
)

Constructor that takes delegates to initialize the action with

Public function

FUIAction

(
    FExecuteAction InitExecuteAction,
    FCanExecuteAction InitCanExecuteAction,
    FIsActionChecked InitIsCheckedDelegate,
    FIsActionButtonVisible InitIsActionVisibleDelegate,
    EUIActionRepeatMode InitRepeatMode
)

Constructor that takes delegates to initialize the action with

Public function

FUIAction

(
    FExecuteAction InitExecuteAction,
    FCanExecuteAction InitCanExecuteAction,
    FGetActionCheckState InitGetActionCheckStateDelegate,
    FIsActionButtonVisible InitIsActionVisibleDelegate,
    EUIActionRepeatMode InitRepeatMode
)

Constructor that takes delegates to initialize the action with

Functions

Name Description

Public function Const

bool

 

CanExecute()

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

Public function Const

bool

 

CanRepeat()

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

Public function Const

bool

 

Execute()

Executes this action

Public function Const

ECheckBoxState

 

GetCheckState()

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

Public function Static

ECheckBoxState

 

IsActionCheckedPassthrough

(
    FIsActionChecked InDelegate
)

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

Public function Const

bool

 

IsBound()

Checks whether this action's execution delegate is bound.

Public function Const

EVisibility

 

IsVisible()

Queries the visibility for this action.

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback