Navigation
API > API/Runtime > API/Runtime/Slate > API/Runtime/Slate/Widgets > API/Runtime/Slate/Widgets/Text
Inheritance Hierarchy
- FSlateControlledConstruction
- TSharedFromThis
- SWidget
- SCompoundWidget
- SInlineEditableTextBlock
References
| Module | Slate |
| Header | /Engine/Source/Runtime/Slate/Public/Widgets/Text/SInlineEditableTextBlock.h |
| Include | #include "Widgets/Text/SInlineEditableTextBlock.h" |
Syntax
class SInlineEditableTextBlock : public SCompoundWidget
Remarks
Slate's InlineEditableTextBlock's are double selectable to go from a STextBlock to become SEditableTextBox.
Variables
| Type | Name | Description | |
|---|---|---|---|
| uint8: 1 | bIsMultiLine | Attribute to look up if the widget is multiline | |
| TAttribute< bool > | bIsReadOnly | Attribute to look up if the widget is read-only | |
| float | DoubleSelectDelay | When selection of widget is managed by another widget, this delays the "double select" from occurring immediately, offering a chance for double clicking to take action. | |
| TSharedPtr< SHorizontalBox > | HorizontalBox | Main horizontal box, used to dynamically add and remove the editable slot. | |
| FIsSelected | IsSelected | Delegate to execute to check the status of if the widget is selected or not Only needs to be hooked up if an external widget is managing selection, such as a SListView or STreeView. | |
| TSharedPtr< SMultiLineEditableTextBox > | MultiLineTextBox | The widget used when in editing mode | |
| FOnBeginTextEdit | OnBeginTextEditDelegate | Delegate to execute when the text starts to be edited | |
| FSimpleDelegate | OnEnterEditingMode | ||
| FSimpleDelegate | OnExitEditingMode | ||
| FOnTextCommitted | OnTextCommittedDelegate | Delegate to execute when editing mode text is committed. | |
| FOnVerifyTextChanged | OnVerifyTextChanged | Callback to verify text when changed. Will return an error message to denote problems. | |
| TAttribute< FText > | Text | Attribute for the text to use for the widget | |
| TSharedPtr< STextBlock > | TextBlock | The widget used when in label mode | |
| TSharedPtr< SEditableTextBox > | TextBox | The widget used when in editing mode | |
| TWeakPtr< SWidget > | WidgetToFocus | Widget to focus when we finish editing |
Destructors
| Type | Name | Description | |
|---|---|---|---|
Functions
| Type | Name | Description | |
|---|---|---|---|
| void | Cancels the edit mode and switches back to label mode | ||
| void | Construct
(
const FArguments& InArgs |
Construct this widget. Called by the SNew()Slate macro. | |
| void | Switches the widget to editing mode | ||
| void | Switches the widget to label mode. | ||
| bool | IsInEditMode () |
Checks if the widget is in edit mode | |
| void | OnTextBoxCommitted
(
const FText& InText, |
Callback when the text box is committed, switches back to label mode. | |
| void | OnTextChanged
(
const FText& InText |
Callback for the text box's OnTextChanged event | |
| void | SetOverflowPolicy
(
TOptional< ETextOverflowPolicy > InOverflowPolicy |
Sets the overflow policy for this text block | |
| void | SetReadOnly
(
bool bInIsReadOnly |
||
| void | SetText
(
const TAttribute< FText >& InText |
||
| void | |||
| void | SetWrapTextAt
(
const TAttribute< float >& InWrapTextAt |
Sets the wrap text at attribute. See WrapTextAt attribute |
Overridden from SWidget
| Type | Name | Description | |
|---|---|---|---|
| FReply | OnDragOver
(
const FGeometry& MyGeometry, |
Called during drag and drop when the the mouse is being dragged over a widget. | |
| FReply | Called after a key is pressed when this widget has focus (this event bubbles if not handled) | ||
| FReply | OnMouseButtonDoubleClick
(
const FGeometry& InMyGeometry, |
Called when a mouse button is double clicked. Override this in derived classes. | |
| FReply | OnMouseButtonDown
(
const FGeometry& MyGeometry, |
MOUSE INPUT The system calls this method to notify the widget that a mouse button was pressed within it. | |
| bool | See SWidget::SupportsKeyboardFocus(). |
Classes
| Type | Name | Description | |
|---|---|---|---|
| FArguments |