Navigation
API > API/Runtime > API/Runtime/Slate > API/Runtime/Slate/SEditableTextBox
| Name | FArguments |
| Type | struct |
| Header File | /Engine/Source/Runtime/Slate/Public/Widgets/Input/SEditableTextBox.h |
| Include Path | #include "Widgets/Input/SEditableTextBox.h" |
Syntax
struct FArguments : public TSlateBaseNamedArgs< SEditableTextBox >
Inheritance Hierarchy
- FSlateBaseNamedArgs → TSlateBaseNamedArgs → SEditableTextBox::FArguments
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FArguments() |
Widgets/Input/SEditableTextBox.h |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| WidgetArgsType | FArguments | Widgets/Input/SEditableTextBox.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
WidgetArgsType & AllowContextMenu
(
const TAttribute< bool >& InAttribute |
Whether the context menu can be opened | Widgets/Input/SEditableTextBox.h | |
WidgetArgsType & BackgroundColor
(
const TAttribute< FSlateColor >& InAttribute |
The color of the background/border around the editable text (overrides Style) | Widgets/Input/SEditableTextBox.h | |
WidgetArgsType & ClearKeyboardFocusOnCommit
(
const TAttribute< bool >& InAttribute |
Whether to clear keyboard focus when pressing enter to commit changes | Widgets/Input/SEditableTextBox.h | |
WidgetArgsType & ContextMenuExtender
(
const FMenuExtensionDelegate& InDelegate |
Menu extender for the right-click context menu | Widgets/Input/SEditableTextBox.h | |
WidgetArgsType & ErrorReporting
(
TSharedPtr< class IErrorReportingWidget > InArg |
Provide a alternative mechanism for error reporting. | Widgets/Input/SEditableTextBox.h | |
WidgetArgsType & FocusedForegroundColor
(
const TAttribute< FSlateColor >& InAttribute |
Text color and opacity when this box has keyboard focus (overrides Style) | Widgets/Input/SEditableTextBox.h | |
WidgetArgsType & Font
(
const TAttribute< FSlateFontInfo >& InAttribute |
Font color and opacity (overrides Style) | Widgets/Input/SEditableTextBox.h | |
WidgetArgsType & ForegroundColor
(
const TAttribute< FSlateColor >& InAttribute |
Text color and opacity (overrides Style) | Widgets/Input/SEditableTextBox.h | |
WidgetArgsType & HintText
(
const TAttribute< FText >& InAttribute |
Hint text that appears when there is no text in the text box | Widgets/Input/SEditableTextBox.h | |
WidgetArgsType & IsCaretMovedWhenGainFocus
(
const TAttribute< bool >& InAttribute |
Workaround as we loose focus when the auto completion closes. | Widgets/Input/SEditableTextBox.h | |
WidgetArgsType & IsPassword
(
const TAttribute< bool >& InAttribute |
Sets whether this text box is for storing a password | Widgets/Input/SEditableTextBox.h | |
WidgetArgsType & IsReadOnly
(
const TAttribute< bool >& InAttribute |
Sets whether this text box can actually be modified interactively by the user | Widgets/Input/SEditableTextBox.h | |
WidgetArgsType & Justification
(
const TAttribute< ETextJustify::Type >& InAttribute |
How should the value be justified in the editable text field. | Widgets/Input/SEditableTextBox.h | |
WidgetArgsType & MaximumLength
(
const TAttribute< int32 >& InAttribute |
Maximum length of the text. Input will refuse text longer than that. | Widgets/Input/SEditableTextBox.h | |
WidgetArgsType & MinDesiredWidth
(
const TAttribute< float >& InAttribute |
Minimum width that a text block should be | Widgets/Input/SEditableTextBox.h | |
WidgetArgsType & OnContextMenuOpening
(
const FOnContextMenuOpening& InDelegate |
Delegate to call before a context menu is opened. | Widgets/Input/SEditableTextBox.h | |
WidgetArgsType & OnKeyCharHandler
(
const FOnKeyChar& InDelegate |
Callback delegate to have first chance handling of the OnKeyChar event | Widgets/Input/SEditableTextBox.h | |
WidgetArgsType & OnKeyDownHandler
(
const FOnKeyDown& InDelegate |
Callback delegate to have first chance handling of the OnKeyDown event | Widgets/Input/SEditableTextBox.h | |
WidgetArgsType & OnTextChanged
(
const FOnTextChanged& InDelegate |
Called whenever the text is changed programmatically or interactively by the user | Widgets/Input/SEditableTextBox.h | |
WidgetArgsType & OnTextCommitted
(
const FOnTextCommitted& InDelegate |
Called whenever the text is committed. | Widgets/Input/SEditableTextBox.h | |
WidgetArgsType & OnVerifyTextChanged
(
const FOnVerifyTextChanged& InDelegate |
Called whenever the text is changed programmatically or interactively by the user | Widgets/Input/SEditableTextBox.h | |
WidgetArgsType & OverflowPolicy
(
TOptional< ETextOverflowPolicy > InArg |
Determines what happens to text that is clipped and doesnt fit within the allotted area for this text box | Widgets/Input/SEditableTextBox.h | |
WidgetArgsType & Padding
(
const TAttribute< FMargin >& InAttribute |
Padding between the box/border and the text widget inside (overrides Style) | Widgets/Input/SEditableTextBox.h | |
WidgetArgsType & ReadOnlyForegroundColor
(
const TAttribute< FSlateColor >& InAttribute |
Text color and opacity when read-only (overrides Style) | Widgets/Input/SEditableTextBox.h | |
WidgetArgsType & RevertTextOnEscape
(
const TAttribute< bool >& InAttribute |
Whether to allow the user to back out of changes when they press the escape key | Widgets/Input/SEditableTextBox.h | |
WidgetArgsType & SearchText
(
const TAttribute< FText >& InAttribute |
Text to search for (a new search is triggered whenever this text changes) | Widgets/Input/SEditableTextBox.h | |
WidgetArgsType & SelectAllTextOnCommit
(
const TAttribute< bool >& InAttribute |
Whether to select all text when pressing enter to commit changes | Widgets/Input/SEditableTextBox.h | |
WidgetArgsType & SelectAllTextWhenFocused
(
const TAttribute< bool >& InAttribute |
Whether to select all text when the user clicks to give focus on the widget | Widgets/Input/SEditableTextBox.h | |
WidgetArgsType & SelectWordOnMouseDoubleClick
(
const TAttribute< bool >& InAttribute |
Whether to select word on mouse double click on the widget | Widgets/Input/SEditableTextBox.h | |
WidgetArgsType & Style
(
const FEditableTextBoxStyle* InArg |
The styling of the textbox | Widgets/Input/SEditableTextBox.h | |
WidgetArgsType & Text
(
const TAttribute< FText >& InAttribute |
Sets the text content for this editable text box widget | Widgets/Input/SEditableTextBox.h | |
WidgetArgsType & TextFlowDirection
(
TOptional< ETextFlowDirection > InArg |
Which text flow direction should we use? (unset to use the default returned by GetDefaultTextFlowDirection) | Widgets/Input/SEditableTextBox.h | |
WidgetArgsType & TextShapingMethod
(
TOptional< ETextShapingMethod > InArg |
Which text shaping method should we use? (unset to use the default returned by GetDefaultTextShapingMethod) | Widgets/Input/SEditableTextBox.h | |
WidgetArgsType & VirtualKeyboardDismissAction
(
const TAttribute< EVirtualKeyboardDismissAction >& InAttribute |
The message action to take when the virtual keyboard is dismissed by the user | Widgets/Input/SEditableTextBox.h | |
WidgetArgsType & VirtualKeyboardOptions
(
FVirtualKeyboardOptions InArg |
Additional options for the virtual keyboard summoned by this widget | Widgets/Input/SEditableTextBox.h | |
WidgetArgsType & VirtualKeyboardTrigger
(
const TAttribute< EVirtualKeyboardTrigger >& InAttribute |
The type of event that will trigger the display of the virtual keyboard | Widgets/Input/SEditableTextBox.h | |
WidgetArgsType & VirtualKeyboardType
(
const TAttribute< EKeyboardType >& InAttribute |
The type of virtual keyboard to use on mobile devices | Widgets/Input/SEditableTextBox.h |