SInlineEditableTextBlock

Slate's InlineEditableTextBlock's are double selectable to go from a [STextBlock](API\Runtime\Slate\Widgets\Text\STextBlock) to become [SEditableTextBox](API\Runtime\Slate\Widgets\Input\SEditableTextBox).

Windows
MacOS
Linux

Inheritance Hierarchy

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

Name Description

Protected variable

uint8: 1

 

bIsMultiLine

Attribute to look up if the widget is multiline

Protected variable

TAttribute< boo...

 

bIsReadOnly

Attribute to look up if the widget is read-only

Protected variable

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.

Protected variable

TSharedPtr< SHo...

 

HorizontalBox

Main horizontal box, used to dynamically add and remove the editable slot.

Protected variable

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.

Protected variable

TSharedPtr< SMu...

 

MultiLineTextBox

The widget used when in editing mode

Protected variable

FOnBeginTextEdi...

 

OnBeginTextEditDelegate

Delegate to execute when the text starts to be edited

Protected variable

FSimpleDelegate

 

OnEnterEditingMode

Protected variable

FSimpleDelegate

 

OnExitEditingMode

Protected variable

FOnTextCommitte...

 

OnTextCommittedDelegate

Delegate to execute when editing mode text is committed.

Protected variable

FOnVerifyTextCh...

 

OnVerifyTextChanged

Callback to verify text when changed. Will return an error message to denote problems.

Protected variable

TAttribute< FTe...

 

Text

Attribute for the text to use for the widget

Protected variable

TSharedPtr< STe...

 

TextBlock

The widget used when in label mode

Protected variable

TSharedPtr< SEd...

 

TextBox

The widget used when in editing mode

Protected variable

TWeakPtr< SWidg...

 

WidgetToFocus

Widget to focus when we finish editing

Destructors

Name Description

Public function

~SInlineEditableTextBlock()

Functions

Name Description

Protected function

void

 

CancelEditMode()

Cancels the edit mode and switches back to label mode

Public function

void

 

Construct

(
    const FArguments& InArgs
)

Construct this widget. Called by the SNew()Slate macro.

Public function

void

 

EnterEditingMode()

Switches the widget to editing mode

Public function

void

 

ExitEditingMode()

Switches the widget to label mode.

Public function Const

bool

 

IsInEditMode()

Checks if the widget is in edit mode

Protected function

void

 

OnTextBoxCommitted

(
    const FText& InText,
    ETextCommit::Type InCommitType
)

Callback when the text box is committed, switches back to label mode.

Protected function

void

 

OnTextChanged

(
    const FText& InText
)

Callback for the text box's OnTextChanged event

Public function

void

 

SetReadOnly

(
    bool bInIsReadOnly
)

Public function

void

 

SetText

(
    const TAttribute< FText >& InText
)

Public function

void

 

SetText

(
    const FString& InText
)

Public function

void

 

SetWrapTextAt

(
    const TAttribute< float >& InWrapT...
)

Sets the wrap text at attribute. See WrapTextAt attribute

Overridden from SWidget

Name Description

Public function Virtual

FReply

 

OnDragOver

(
    const FGeometry& MyGeometry,
    const FDragDropEvent& DragDropEven...
)

Called during drag and drop when the the mouse is being dragged over a widget.

Public function Virtual

FReply

 

OnKeyDown

(
    const FGeometry& MyGeometry,
    const FKeyEvent& InKeyEvent
)

Called after a key is pressed when this widget has focus (this event bubbles if not handled)

Public function Virtual

FReply

 

OnMouseButtonDoubleClick

(
    const FGeometry& InMyGeometry,
    const FPointerEvent& InMouseEvent
)

Called when a mouse button is double clicked. Override this in derived classes.

Public function Virtual

FReply

 

OnMouseButtonDown

(
    const FGeometry& MyGeometry,
    const FPointerEvent& MouseEvent
)

MOUSE INPUT The system calls this method to notify the widget that a mouse button was pressed within it.

Public function Virtual Const

bool

 

SupportsKeyboardFocus()

See SWidget::SupportsKeyboardFocus().

Classes

Name

Description

Public struct

FArguments

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss