Navigation
API > API/Runtime > API/Runtime/Slate > API/Runtime/Slate/Framework > API/Runtime/Slate/Framework/Commands
Inheritance Hierarchy
- FSharedFromThisBase
- TSharedFromThis
- FBindingContext
- TCommands
- FAvaLevelViewportCommands
- FAvaSceneRigEditorCommands
- FCameraAssetEditorCommands
- FCameraRigAssetEditorCommands
- FCameraRigTransitionEditorCommands
- FCameraVariableCollectionEditorCommands
- FContextualAnimAssetEditorCommands
- FDashboardAssetCommands
- FDatabaseEditorCommands
- FEditPivotCommands
- FGameplayCamerasDebuggerCommands
- FGenericCommands
- FGeometryCollectionSelectionCommands
- FGroomEditorCommands
- FGroomViewportLODCommands
- FHairModelingToolCommands
- FIKRetargetCommands
- FIKRigCommands
- FIKRigSkeletonCommands
- FMeshPaintEditorModeCommands
- FMLDeformerInputBonesWidgetCommands
- FMLDeformerInputCurvesWidgetCommands
- FModelingModeActionCommands
- FModelingToolsManagerCommands
- FMotionTrailCommands
- FPListEditorCommands
- FScriptableToolsEditorModeManagerCommands
- FSVGImporterEditorCommands
- FTabCommands
- FUVEditorCommands
References
| Module | Slate |
| Header | /Engine/Source/Runtime/Slate/Public/Framework/Commands/Commands.h |
| Include | #include "Framework/Commands/Commands.h" |
Syntax
template<typename CommandContextType>
class TCommands : public FBindingContext
Remarks
A base class for a set of commands. Inherit from it to make a set of commands. See MainFrameActions for an example.
Constructors
| Type | Name | Description | |
|---|---|---|---|
| Construct a set of commands; call this from your custom commands class. |
Destructors
| Type | Name | Description | |
|---|---|---|---|
~TCommands () |
Functions
| Type | Name | Description | |
|---|---|---|---|
| FORCENOINLINE const CommandContextType & | Get () |
Get the singleton instance of this set of commands. | |
| FORCENOINLINE const FBindingContext & | GetContext () |
Get the BindingContext for this set of commands. | |
| FORCENOINLINE bool | IsRegistered () |
||
| FORCENOINLINE void | Register () |
Use this method to register commands. Usually done in StartupModule(). | |
| void | Pure virtual to override; describe and instantiate the commands in here by using the UI COMMAND macro. | ||
| FORCENOINLINE void | Unregister () |
Use this method to clean up any resources used by the command set. Usually done in ShutdownModule() |
Constants
| Name | Description |
|---|---|
| Instance | A static instance of the command set. |