Choose your operating system:
Windows
macOS
Linux
| FSlateBaseNamedArgs
|
Module |
|
Header |
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SMultiLineEditableTextBox.h |
Include |
#include "Widgets/Input/SMultiLineEditableTextBox.h" |
struct FArguments : public TSlateBaseNamedArgs< SMultiLineEditableTextBox >
Name | Description | |
---|---|---|
|
FArguments() |
Name | Description | ||
---|---|---|---|
|
WidgetArgsTy... |
AllowContextMenu ( |
Whether the context menu can be opened |
|
WidgetArgsTy... |
AllowMultiLine ( |
Whether to allow multi-line text |
|
WidgetArgsTy... |
AlwaysShowScrollbars ( |
Should we always show the scrollbars (only affects internally created scroll bars) |
|
WidgetArgsTy... |
AutoWrapText ( |
Whether to wrap text automatically based on the widget's computed horizontal space. |
|
WidgetArgsTy... |
BackgroundColor ( |
The color of the background/border around the editable text (overrides Style) |
|
WidgetArgsTy... |
ClearKeyboardFocusOnCommit ( |
Whether to clear keyboard focus when pressing enter to commit changes |
|
WidgetArgsTy... |
ClearTextSelectionOnFocusLoss ( |
Whether to clear text selection when focus is lost |
|
WidgetArgsTy... |
ContextMenuExtender ( |
Menu extender for the right-click context menu |
|
WidgetArgsTy... |
CreateSlateTextLayout ( |
Delegate used to create text layouts for this widget. |
|
WidgetArgsTy... |
ErrorReporting ( |
Provide a alternative mechanism for error reporting. |
|
WidgetArgsTy... |
FocusedForegroundColor ( |
Text color and opacity when this box has keyboard focus (overrides Style) |
|
WidgetArgsTy... |
Font ( |
Font color and opacity (overrides Style) |
|
WidgetArgsTy... |
ForegroundColor ( |
Text color and opacity (overrides Style) |
|
WidgetArgsTy... |
HintText ( |
Hint text that appears when there is no text in the text box |
|
WidgetArgsTy... |
HScrollBar ( |
The horizontal scroll bar widget, or null to create one internally |
|
WidgetArgsTy... |
HScrollBarPadding ( |
Padding around the horizontal scrollbar (overrides Style) |
|
WidgetArgsTy... |
IsCaretMovedWhenGainFocus ( |
Workaround as we loose focus when the auto completion closes. |
|
WidgetArgsTy... |
IsReadOnly ( |
Sets whether this text box can actually be modified interactively by the user |
|
WidgetArgsTy... |
Justification ( |
How the text should be aligned with the margin. |
|
WidgetArgsTy... |
LineHeightPercentage ( |
The amount to scale each lines height by. |
|
WidgetArgsTy... |
Margin ( |
The amount of blank space left around the edges of text area. |
|
WidgetArgsTy... |
Marshaller ( |
The marshaller used to get/set the raw text to/from the text layout. |
|
WidgetArgsTy... |
ModiferKeyForNewLine ( |
The optional modifier key necessary to create a newline when typing into the editor. |
|
WidgetArgsTy... |
OnContextMenuOpening ( |
Delegate to call before a context menu is opened. |
|
WidgetArgsTy... |
OnCursorMoved ( |
Called when the cursor is moved within the text area |
|
WidgetArgsTy... |
OnHScrollBarUserScrolled ( |
Called whenever the horizontal scrollbar is moved by the user |
|
WidgetArgsTy... |
OnIsTypedCharValid ( |
This is NOT for validating input! |
|
WidgetArgsTy... |
OnKeyCharHandler ( |
Callback delegate to have first chance handling of the OnKeyChar event |
|
WidgetArgsTy... |
OnKeyDownHandler ( |
Callback delegate to have first chance handling of the OnKeyDown event |
|
WidgetArgsTy... |
OnTextChanged ( |
Called whenever the text is changed programmatically or interactively by the user |
|
WidgetArgsTy... |
OnTextCommitted ( |
Called whenever the text is committed. |
|
WidgetArgsTy... |
OnVScrollBarUserScrolled ( |
Called whenever the vertical scrollbar is moved by the user |
|
WidgetArgsTy... |
OverflowPolicy ( |
Determines what happens to text that is clipped and doesn't fit within the allotted area for this widget |
|
WidgetArgsTy... |
Padding ( |
Padding between the box/border and the text widget inside (overrides Style) |
|
WidgetArgsTy... |
ReadOnlyForegroundColor ( |
Text color and opacity when read-only (overrides Style) |
|
WidgetArgsTy... |
RevertTextOnEscape ( |
Whether to allow the user to back out of changes when they press the escape key |
|
WidgetArgsTy... |
SearchText ( |
Text to search for (a new search is triggered whenever this text changes) |
|
WidgetArgsTy... |
SelectAllTextOnCommit ( |
Whether to select all text when pressing enter to commit changes |
|
WidgetArgsTy... |
SelectAllTextWhenFocused ( |
Whether to select all text when the user clicks to give focus on the widget |
|
WidgetArgsTy... |
SelectWordOnMouseDoubleClick ( |
Whether to select word on mouse double click on the widget |
|
WidgetArgsTy... |
Style ( |
The styling of the textbox |
|
WidgetArgsTy... |
Text ( |
Sets the text content for this editable text box widget |
|
WidgetArgsTy... |
TextFlowDirection ( |
Which text flow direction should we use? (unset to use the default returned by GetDefaultTextFlowDirection) |
|
WidgetArgsTy... |
TextShapingMethod ( |
Which text shaping method should we use? (unset to use the default returned by GetDefaultTextShapingMethod) |
|
WidgetArgsTy... |
TextStyle ( |
Pointer to a style of the text block, which dictates the font, color, and shadow options. |
|
WidgetArgsTy... |
VirtualKeyboardDismissAction ( |
The message action to take when the virtual keyboard is dismissed by the user |
|
WidgetArgsTy... |
VirtualKeyboardOptions ( |
Additional options used by the virtual keyboard summoned by this widget |
|
WidgetArgsTy... |
VirtualKeyboardTrigger ( |
The type of event that will trigger the display of the virtual keyboard |
|
WidgetArgsTy... |
VScrollBar ( |
The vertical scroll bar widget, or null to create one internally |
|
WidgetArgsTy... |
VScrollBarPadding ( |
Padding around the vertical scrollbar (overrides Style) |
|
WidgetArgsTy... |
WrappingPolicy ( |
The wrapping policy to use |
|
WidgetArgsTy... |
WrapTextAt ( |
Whether text wraps onto a new line when it's length exceeds this width; if this value is zero or negative, no wrapping occurs. |
Name |
Description |
---|---|
WidgetArgsType |