Commands.h File Reference

#include "CoreMinimal.h"
#include "Framework/Commands/UICommandInfo.h"
#include "Framework/Commands/InputBindingManager.h"

Go to the source code of this file.

Classes
class	TCommands< CommandContextType >

Macros
#define	LOC_DEFINE_REGION
#define	UI_COMMAND_EXT(BindingContext, OutUICommandInfo, CommandIdName, FriendlyName, InDescription, CommandType, InDefaultChord, ...)    MakeUICommand_InternalUseOnly( BindingContext, OutUICommandInfo, TEXT(LOCTEXT_NAMESPACE), TEXT(CommandIdName), TEXT(CommandIdName) TEXT("_ToolTip"), "." CommandIdName, TEXT(FriendlyName), TEXT(InDescription), CommandType, InDefaultChord, ## __VA_ARGS__ );
#define	UI_COMMAND(CommandId, FriendlyName, InDescription, CommandType, InDefaultChord, ...)    MakeUICommand_InternalUseOnly( this, CommandId, TEXT(LOCTEXT_NAMESPACE), TEXT(#CommandId), TEXT(#CommandId) TEXT("_ToolTip"), "." #CommandId, TEXT(FriendlyName), TEXT(InDescription), CommandType, InDefaultChord, ## __VA_ARGS__ );
#define	UE_DECLARE_TCOMMANDS(Type, Api)   template<> Api TWeakPtr<Type>& TCommands<Type>::GetInstance();
#define	UE_DEFINE_TCOMMANDS(Type)   template<> TWeakPtr<Type>& TCommands<Type>::GetInstance() { static TWeakPtr<Type> Inst; return Inst; }

Functions
SLATE_API void	MakeUICommand_InternalUseOnly (FBindingContext *This, TSharedPtr< FUICommandInfo > &OutCommand, const TCHAR *InSubNamespace, const TCHAR *InCommandName, const TCHAR *InCommandNameUnderscoreTooltip, const ANSICHAR *DotCommandName, const TCHAR *FriendlyName, const TCHAR *InDescription, const EUserInterfaceActionType CommandType, const FInputChord &InDefaultChord, const FInputChord &InAlternateDefaultChord=FInputChord())

Macro Definition Documentation

LOC_DEFINE_REGION

#define LOC_DEFINE_REGION

UE_DECLARE_TCOMMANDS

#define UE_DECLARE_TCOMMANDS	(		Type,
			Api
	)		template<> Api TWeakPtr<Type>& TCommands<Type>::GetInstance();

UE_DEFINE_TCOMMANDS

#define UE_DEFINE_TCOMMANDS

(

Type

)

template<> TWeakPtr<Type>& TCommands<Type>::GetInstance() { static TWeakPtr<Type> Inst; return Inst; }

UI_COMMAND

#define UI_COMMAND	(		CommandId,
			FriendlyName,
			InDescription,
			CommandType,
			InDefaultChord,
			...
	)		MakeUICommand_InternalUseOnly( this, CommandId, TEXT(LOCTEXT_NAMESPACE), TEXT(#CommandId), TEXT(#CommandId) TEXT("_ToolTip"), "." #CommandId, TEXT(FriendlyName), TEXT(InDescription), CommandType, InDefaultChord, ## __VA_ARGS__ );

UI_COMMAND_EXT

#define UI_COMMAND_EXT	(		BindingContext,
			OutUICommandInfo,
			CommandIdName,
			FriendlyName,
			InDescription,
			CommandType,
			InDefaultChord,
			...
	)		MakeUICommand_InternalUseOnly( BindingContext, OutUICommandInfo, TEXT(LOCTEXT_NAMESPACE), TEXT(CommandIdName), TEXT(CommandIdName) TEXT("_ToolTip"), "." CommandIdName, TEXT(FriendlyName), TEXT(InDescription), CommandType, InDefaultChord, ## __VA_ARGS__ );

Function Documentation

MakeUICommand_InternalUseOnly()

SLATE_API void MakeUICommand_InternalUseOnly	(	FBindingContext *	This,
		TSharedPtr< FUICommandInfo > &	OutCommand,
		const TCHAR *	InSubNamespace,
		const TCHAR *	InCommandName,
		const TCHAR *	InCommandNameUnderscoreTooltip,
		const ANSICHAR *	DotCommandName,
		const TCHAR *	FriendlyName,
		const TCHAR *	InDescription,
		const EUserInterfaceActionType	CommandType,
		const FInputChord &	InDefaultChord,
		const FInputChord &	InAlternateDefaultChord = FInputChord()
	)

Internal function used by the UI_COMMAND macros to build the command. Do not call this directly as only the macros are gathered for localization; instead use FUICommandInfo::MakeCommandInfo for dynamic content