| FSlateControlledConstruction | ||||||||
| TSharedFromThis
|
Module |
|
Header |
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SMultiLineEditableTextBox.h |
Include |
#include "Widgets/Input/SMultiLineEditableTextBox.h" |
class SMultiLineEditableTextBox : public SBorder
Editable text box widget
Name | Description | ||
---|---|---|---|
|
TAttribute< boo... |
AllowContextMenu |
Whether to disable the context menu |
|
TAttribute< FSl... |
BackgroundColorOverride |
Background color (overrides style) |
|
bHasExternalHScrollBar |
Whether we have an externally supplied horizontal scrollbar or one created internally |
|
|
bHasExternalVScrollBar |
Whether we have an externally supplied vertical scrollbar or one created internally |
|
|
TSharedPtr< SHo... |
Box |
Allows for inserting additional widgets that extend the functionality of the text box |
|
TAttribute< boo... |
bSelectWordOnMouseDoubleClick |
Whether to select work on mouse double click |
|
TSharedPtr< SMu... |
EditableText |
Editable text widget |
|
TSharedPtr< cla... |
ErrorReporting |
SomeWidget reporting |
|
TAttribute< FSl... |
FontOverride |
Font (overrides style) |
|
TAttribute< FSl... |
ForegroundColorOverride |
Foreground color (overrides style) |
|
TSharedPtr< SSc... |
HScrollBar |
Horiz scrollbar |
|
TSharedPtr< SBo... |
HScrollBarPaddingBox |
Box around the horiz scrollbar used for adding padding |
|
TAttribute< FMa... |
HScrollBarPaddingOverride |
Horiz scrollbar padding (overrides style) |
|
TAttribute< FMa... |
PaddingOverride |
Padding (overrides style) |
|
TAttribute< FSl... |
ReadOnlyForegroundColorOverride |
Read-only foreground color (overrides style) |
|
const FEditable... |
Style |
|
|
TSharedPtr< SSc... |
VScrollBar |
Vert scrollbar |
|
TSharedPtr< SBo... |
VScrollBarPaddingBox |
Box around the vert scrollbar used for adding padding |
|
TAttribute< FMa... |
VScrollBarPaddingOverride |
Vert scrollbar padding (overrides style) |
Name | Description | ||
---|---|---|---|
|
AdvanceSearch ( |
Advance the current search to the next match (does nothing if not currently searching) |
|
|
AnyTextSelected() |
Query to see if any text is selected within the document |
|
|
ApplyToSelection ( |
Apply the given style to the currently selected text (or insert a new run at the current cursor position if no text is selected) |
|
|
BeginSearch ( |
Begin a new text search (this is called automatically when the bound search text changes) |
|
|
ClearSelection() |
Clear the active text selection |
|
|
Construct ( |
Construct this widget |
|
|
ForceScroll ( |
||
|
GetCurrentTextLine ( |
Return the text line where the current cursor location is at. |
|
|
GetHintText() |
Returns the hint text string |
|
|
TSharedPtr< ... |
GetHScrollBar() |
Get the horizontal scroll bar widget |
|
GetPlainText() |
Returns the plain text string without richtext formatting |
|
|
TSharedPtr< ... |
GetRunUnderCursor() |
Get the run currently under the cursor, or null if there is no run currently under the cursor |
|
GetSearchText() |
Get the text that is currently being searched for (if any) |
|
|
GetSelectedRuns() |
Get the runs currently that are current selected, some of which may be only partially selected |
|
|
GetSelectedText() |
Get the currently selected text |
|
|
GetText() |
Returns the text string |
|
|
TSharedPtr< ... |
GetVScrollBar() |
Get the vertical scroll bar widget |
|
GoTo ( |
Move the cursor to the specified location |
|
|
GoTo ( |
Move the cursor to the given location in the document |
|
|
InsertRunAtCursor ( |
Insert the given run at the current cursor position |
|
|
InsertTextAtCursor ( |
Insert the given text at the current cursor position, correctly taking into account new line characters |
|
|
InsertTextAtCursor ( |
Insert the given text at the current cursor position, correctly taking into account new line characters |
|
|
Refresh() |
Refresh this text box immediately, rather than wait for the usual caching mechanisms to take affect on the text Tick |
|
|
ScrollTo ( |
Scroll to the given location in the document (without moving the cursor) |
|
|
ScrollTo ( |
Scroll to the given location in the document (without moving the cursor) |
|
|
SelectAllText() |
Select all the text in the document |
|
|
SetAllowContextMenu ( |
See the AllowContextMenu attribute |
|
|
SetAutoWrapText ( |
See AutoWrapText attribute |
|
|
SetError ( |
If InError is a non-empty string the TextBox will the ErrorReporting provided during construction If no error reporting was provided, the TextBox will create a default error reporter. |
|
|
SetError ( |
If InError is a non-empty string the TextBox will the ErrorReporting provided during construction If no error reporting was provided, the TextBox will create a default error reporter. |
|
|
SetHintText ( |
Sets the text that appears when there is no text in the text box |
|
|
SetIsReadOnly ( |
Set the ReadOnly attribute |
|
|
SetJustification ( |
See Justification attribute |
|
|
SetLineHeightPercentage ( |
See LineHeightPercentage attribute |
|
|
SetMargin ( |
See Margin attribute |
|
|
SetOnKeyCharHandler ( |
Sets the OnKeyCharHandler to provide first chance handling of the SMultiLineEditableText's OnKeyChar event |
|
|
SetOnKeyDownHandler ( |
Sets the OnKeyDownHandler to provide first chance handling of the SMultiLineEditableText's OnKeyDown event |
|
|
SetReadOnlyForegroundColor ( |
Sets the text color and opacity when read-only (overrides Style) |
|
|
SetSearchText ( |
Set the text that is currently being searched for (if any) |
|
|
SetSelectWordOnMouseDoubleClick ( |
Sets whether to select word on the mouse double click |
|
|
SetStyle ( |
See attribute Style |
|
|
SetText ( |
Sets the text string currently being edited |
|
|
SetTextBoxBackgroundColor ( |
Sets the color of the background/border around the editable text (overrides Style) |
|
|
SetTextBoxForegroundColor ( |
Sets the text color and opacity (overrides Style) |
|
|
SetTextFlowDirection ( |
See TextFlowDirection attribute |
|
|
SetTextShapingMethod ( |
See TextShapingMethod attribute |
|
|
SetTextStyle ( |
See attribute TextStyle |
|
|
SetVirtualKeyboardDismissAction |
Set the VirtualKeyboardDismissAction attribute |
|
|
SetWrappingPolicy ( |
Set WrappingPolicy attribute |
|
|
SetWrapTextAt ( |
See WrapTextAt attribute |
Name | Description | ||
---|---|---|---|
|
HasKeyboardFocus() |
Checks to see if this widget currently has the keyboard focus |
|
|
OnFocusReceived ( |
KEY INPUT Called when focus is given to this widget. This event does not bubble. |
|
|
OnKeyDown |
Called after a key is pressed when this widget has focus (this event bubbles if not handled) |
|
|
SupportsKeyboardFocus() |
Checks to see if this widget supports keyboard focus. Override this in derived classes. |
Name |
Description |
|
---|---|---|
|
FArguments |