FUICommandInfo Class Reference

#include <UICommandInfo.h>

Public Member Functions
SLATE_API	FUICommandInfo (const FName InBindingContext)
SLATE_API const FText	GetInputText () const
const TSharedRef< const FInputChord >	GetActiveChord (const EMultipleKeyBindingIndex InChordIndex) const
const bool	HasActiveChord (const FInputChord InChord) const
const TSharedRef< const FInputChord >	GetFirstValidChord () const
const bool	HasDefaultChord (const FInputChord InChord) const
const FInputChord &	GetDefaultChord (const EMultipleKeyBindingIndex InChordIndex) const
const FText &	GetLabel () const
const FText &	GetDescription () const
const FSlateIcon &	GetIcon () const
EUserInterfaceActionType	GetUserInterfaceType () const
FName	GetCommandName () const
FName	GetBindingContext () const
FName	GetBundle () const
bool	GetUseLongDisplayName () const
void	SetUseLongDisplayName (const bool bInUseLongDisplayName)
SLATE_API void	SetActiveChord (const FInputChord &NewChord, const EMultipleKeyBindingIndex InChordIndex)
SLATE_API void	RemoveActiveChord (const EMultipleKeyBindingIndex InChordIndex)
SLATE_API TSharedRef< class SToolTip >	MakeTooltip (const TAttribute< FText > &InText=TAttribute< FText >(), const TAttribute< EVisibility > &InToolTipVisibility=TAttribute< EVisibility >()) const

Static Public Member Functions
static SLATE_API void	MakeCommandInfo (const TSharedRef< class FBindingContext > &InContext, TSharedPtr< FUICommandInfo > &OutCommand, const FName InCommandName, const FText &InCommandLabel, const FText &InCommandDesc, const FSlateIcon &InIcon, const EUserInterfaceActionType InUserInterfaceType, const FInputChord &InDefaultChord, const FInputChord &InAlternateDefaultChord=FInputChord(), const FName InBundle=NAME_None)
static SLATE_API void	UnregisterCommandInfo (const TSharedRef< class FBindingContext > &InContext, const TSharedRef< FUICommandInfo > &InCommand)

Friends
class	FInputBindingManager
class	FUICommandInfoDecl

Constructor & Destructor Documentation

FUICommandInfo()

FUICommandInfo::FUICommandInfo

(

const FName

InBindingContext

)

Creates and initializes a new instance.

Parameters

InBindingContext

The name of the binding context to use.

Member Function Documentation

GetActiveChord()

const TSharedRef< const FInputChord > FUICommandInfo::GetActiveChord ( const EMultipleKeyBindingIndex  InChordIndex ) const

inline

Returns

Returns the active chord at the specified index for this command

GetBindingContext()

FName FUICommandInfo::GetBindingContext ( ) const

inline

Returns

The name of the context where the command is valid

GetBundle()

FName FUICommandInfo::GetBundle ( ) const

inline

Returns

The name of the bundle this command is assigned to

GetCommandName()

FName FUICommandInfo::GetCommandName ( ) const

inline

Returns

The name of the command

GetDefaultChord()

const FInputChord & FUICommandInfo::GetDefaultChord ( const EMultipleKeyBindingIndex  InChordIndex ) const

inline

GetDescription()

const FText & FUICommandInfo::GetDescription ( ) const

inline

Returns

The description of this command

GetFirstValidChord()

const TSharedRef< const FInputChord > FUICommandInfo::GetFirstValidChord ( ) const

inline

Returns

Checks if there is an active chord for this command matching the input chord

GetIcon()

const FSlateIcon & FUICommandInfo::GetIcon ( ) const

inline

Returns

The icon to used when this command is displayed in UI that shows icons

GetInputText()

const FText FUICommandInfo::GetInputText

(

)

const

Returns the friendly, localized string name of the first valid chord in the key bindings list that is required to perform the command

Returns

Localized friendly text for the chord

GetLabel()

const FText & FUICommandInfo::GetLabel ( ) const

inline

Returns

The display label for this command

GetUseLongDisplayName()

bool FUICommandInfo::GetUseLongDisplayName ( ) const

inline

Returns

True if should we use long names for when getting text for input chords

GetUserInterfaceType()

EUserInterfaceActionType FUICommandInfo::GetUserInterfaceType ( ) const

inline

Returns

The type of command this is. Used to determine what UI to create for it

HasActiveChord()

const bool FUICommandInfo::HasActiveChord ( const FInputChord  InChord ) const

inline

Returns

Checks if there is an active chord for this command matching the input chord

HasDefaultChord()

const bool FUICommandInfo::HasDefaultChord ( const FInputChord  InChord ) const

inline

Returns

Checks if there is an active chord for this command matching the input chord

MakeCommandInfo()

void FUICommandInfo::MakeCommandInfo ( const TSharedRef< class FBindingContext > &  InContext, TSharedPtr< FUICommandInfo > &  OutCommand, const FName  InCommandName, const FText &  InCommandLabel, const FText &  InCommandDesc, const FSlateIcon &  InIcon, const EUserInterfaceActionType  InUserInterfaceType, const FInputChord &  InDefaultChord, const FInputChord &  InAlternateDefaultChord = FInputChord(), const FName  InBundle = NAME_None  )

static

Utility function to make an FUICommandInfo

MakeTooltip()

TSharedRef< SToolTip > FUICommandInfo::MakeTooltip	(	const TAttribute< FText > &	InText = TAttribute<FText>(),
		const TAttribute< EVisibility > &	InToolTipVisibility = TAttribute<EVisibility>()
	)		const

Makes a tooltip for this command.

Parameters

InText

Optional dynamic text to be displayed in the tooltip.

Returns

The tooltip widget

RemoveActiveChord()

void FUICommandInfo::RemoveActiveChord

(

const EMultipleKeyBindingIndex

InChordIndex

)

Removes the active chord from this command

SetActiveChord()

void FUICommandInfo::SetActiveChord	(	const FInputChord &	NewChord,
		const EMultipleKeyBindingIndex	InChordIndex
	)

Sets the new active chord for this command

SetUseLongDisplayName()

void FUICommandInfo::SetUseLongDisplayName ( const bool  bInUseLongDisplayName )

inline

Sets if we should use a long display name or not

UnregisterCommandInfo()

void FUICommandInfo::UnregisterCommandInfo ( const TSharedRef< class FBindingContext > &  InContext, const TSharedRef< FUICommandInfo > &  InCommand  )

static

Utility function to unregister an FUICommandInfo

Friends And Related Symbol Documentation

FInputBindingManager

friend class FInputBindingManager

friend

FUICommandInfoDecl

friend class FUICommandInfoDecl

friend

---

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

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