Navigation
API > API/Developer > API/Developer/WidgetRegistration
BuilderInput is the input representation for Builders and provides conversions to the various Slate types for inputs.
| Name | FBuilderInput |
| Type | class |
| Header File | /Engine/Source/Developer/WidgetRegistration/Public/Inputs/BuilderInput.h |
| Include Path | #include "Inputs/BuilderInput.h" |
Syntax
class FBuilderInput : public UE::DisplayBuilders::FLabelAndIconArgs
Inheritance Hierarchy
- FLabelAndIconArgs → FBuilderInput
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FBuilderInput
(
FName InName, |
Inputs/BuilderInput.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
~FBuilderInput() |
The destructor, destroys any command related information | Inputs/BuilderInput.h |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| NullInput | FBuilderInput | For use when we need a null state | Inputs/BuilderInput.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| ActiveChords | TArray< TSharedRef< FInputChord > > | Input commands that executes this action | Inputs/BuilderInput.h | |
| BindingContext | FName | The context in which the UI command is active | Inputs/BuilderInput.h | |
| Bundle | FName | The bundle to group the UI command into. | Inputs/BuilderInput.h | |
| ButtonArgs | FButtonArgs | FButtonArgs, a type which can be used to create buttons with FToolbarBuilder | Inputs/BuilderInput.h | |
| DefaultChords | FInputChord | The default input chords for the UI command (can be invalid) | Inputs/BuilderInput.h | |
| Description | FText | Localized help text for the UI command | Inputs/BuilderInput.h | |
| Index | int32 | The index of the BuilderInput in whatever container it is in | Inputs/BuilderInput.h | |
| Name | FName | Name of the Input | Inputs/BuilderInput.h | |
| Tooltip | FText | The tooltip for the input | Inputs/BuilderInput.h | |
| UICommandInfo | TSharedPtr< FUICommandInfo > | FUICommandInfo, the basic Slate Class for defining user-facing commands, including their appearance and behavior in the UI | Inputs/BuilderInput.h | |
| UIStyle | FName | Brush name for icon to use in tool bars and menu items to represent the UI command in its toggled on (checked) state | Inputs/BuilderInput.h | |
| UserInterfaceType | EUserInterfaceActionType | The type of user interface to associated with this action | Inputs/BuilderInput.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool IsNameNone() |
Inputs/BuilderInput.h |