SInlineEditableTextBlock

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

API > API/Runtime > API/Runtime/Slate

Slate's InlineEditableTextBlock's are double selectable to go from a STextBlock to become SEditableTextBox.

   
Name SInlineEditableTextBlock
Type class
Header File /Engine/Source/Runtime/Slate/Public/Widgets/Text/SInlineEditableTextBlock.h
Include Path #include "Widgets/Text/SInlineEditableTextBlock.h"

Syntax

class SInlineEditableTextBlock : public SCompoundWidget

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

SInlineEditableTextBlock()

   Widgets/Text/SInlineEditableTextBlock.h  

Destructors

Name Remarks Include Path Unreal Specifiers

~SInlineEditableTextBlock()

   Widgets/Text/SInlineEditableTextBlock.h  

Structs

Name Remarks
FArguments  

Typedefs

Name Type Remarks Include Path
PrivateParentType SCompoundWidget   Widgets/Text/SInlineEditableTextBlock.h
PrivateThisType SInlineEditableTextBlock   Widgets/Text/SInlineEditableTextBlock.h
Super SCompoundWidget   Widgets/Text/SInlineEditableTextBlock.h
ThisClass SInlineEditableTextBlock   Widgets/Text/SInlineEditableTextBlock.h

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
ActiveTimerHandle TWeakPtr< FActiveTimerHandle > The handle to the active timer Widgets/Text/SInlineEditableTextBlock.h  
bNeedsMaximumLengthChecked bool   Widgets/Text/SInlineEditableTextBlock.h  
MaximumLengthAttribute TSlateAttribute< int32 > Maximum text length that will be accepted by the widget Widgets/Text/SInlineEditableTextBlock.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void Construct ( const FArguments& InArgs
)

 Construct this widget. Called by the SNew()Slate macro. Widgets/Text/SInlineEditableTextBlock.h  

void EnterEditingMode()

 Switches the widget to editing mode Widgets/Text/SInlineEditableTextBlock.h  

void ExitEditingMode()

 Switches the widget to label mode. Widgets/Text/SInlineEditableTextBlock.h  

TSlateAttributeRef< int32 > GetMaximumLengthAttribute()

   Widgets/Text/SInlineEditableTextBlock.h  

FText GetText()

 Return the current text Widgets/Text/SInlineEditableTextBlock.h  

bool IsInEditMode()

 Checks if the widget is in edit mode Widgets/Text/SInlineEditableTextBlock.h  

void SetHighlightText ( const TAttribute< FText >& InText
)

   Widgets/Text/SInlineEditableTextBlock.h  

void SetHintText ( const TAttribute< FText >& InHintText
)

   Widgets/Text/SInlineEditableTextBlock.h  

void SetMaximumLength ( TAttribute< int32 > InMaximumLength
)

 Sets the maximum text length that will be accepted by the widget Widgets/Text/SInlineEditableTextBlock.h  

void SetOnEnterEditingMode ( FSimpleDelegate InOnEnterEditingMode
)

   Widgets/Text/SInlineEditableTextBlock.h  

void SetOnExitEditingMode ( FIsSelected InIsSelected
)

   Widgets/Text/SInlineEditableTextBlock.h  

void SetOnExitEditingMode ( FSimpleDelegate InOnExitEditingMode
)

   Widgets/Text/SInlineEditableTextBlock.h  

void SetOnTextCommitted ( FOnTextCommitted InOnTextCommitted
)

   Widgets/Text/SInlineEditableTextBlock.h  

void SetOnVerifyTextChanged ( FOnVerifyTextChanged InOnVerifyTextChanged
)

   Widgets/Text/SInlineEditableTextBlock.h  

void SetOverflowPolicy ( TOptional< ETextOverflowPolicy > InOverflowPolicy
)

 Sets the overflow policy for this text block Widgets/Text/SInlineEditableTextBlock.h  

void SetReadOnly ( const TAttribute< bool >& bInIsReadOnly
)

   Widgets/Text/SInlineEditableTextBlock.h  

void SetText ( const TAttribute< FText >& InText
)

   Widgets/Text/SInlineEditableTextBlock.h  

void SetText ( const FString& InText
)

   Widgets/Text/SInlineEditableTextBlock.h  

void SetWrapTextAt ( const TAttribute< float >& InWrapTextAt
)

 Sets the wrap text at attribute. See WrapTextAt attribute Widgets/Text/SInlineEditableTextBlock.h  

Public Virtual

Overridden from SWidget

Name Remarks Include Path Unreal Specifiers

virtual FReply OnDragOver ( const FGeometry& MyGeometry,
const FDragDropEvent& DragDropEvent
)

   Widgets/Text/SInlineEditableTextBlock.h  

virtual FReply OnKeyDown ( const FGeometry& MyGeometry,
const FKeyEvent& InKeyEvent
)

   Widgets/Text/SInlineEditableTextBlock.h  

virtual FReply OnMouseButtonDoubleClick ( const FGeometry& InMyGeometry,
const FPointerEvent& InMouseEvent
)

   Widgets/Text/SInlineEditableTextBlock.h  

virtual FReply OnMouseButtonDown ( const FGeometry& MyGeometry,
const FPointerEvent& MouseEvent
)

   Widgets/Text/SInlineEditableTextBlock.h  

virtual int32 OnPaint ( const FPaintArgs& Args,
const FGeometry& AllottedGeometry,
const FSlateRect& MyCullingRect,
FSlateWindowElementList& OutDrawElements,
int32 LayerId,
const FWidgetStyle& InWidgetStyle,
bool bParentEnabled
) const

   Widgets/Text/SInlineEditableTextBlock.h  

virtual bool SupportsKeyboardFocus()

 See SWidget::SupportsKeyboardFocus(). Widgets/Text/SInlineEditableTextBlock.h  

Overridden from FSlateControlledConstruction

Name Remarks Include Path Unreal Specifiers

virtual const FSlateWidgetClassData & GetWidgetClass()

   Widgets/Text/SInlineEditableTextBlock.h  

Protected

Name Remarks Include Path Unreal Specifiers

void CancelEditMode()

 Cancels the edit mode and switches back to label mode Widgets/Text/SInlineEditableTextBlock.h  

bool IsTextAllowed ( const FText& InText,
FText& OutErrorMessage
) const

 Validate the given text by verifying its length and by calling OnVerifyTextChanged if bound. Widgets/Text/SInlineEditableTextBlock.h  

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

 Callback when the text box is committed, switches back to label mode. Widgets/Text/SInlineEditableTextBlock.h  

void OnTextChanged ( const FText& InText
)

 Callback for the text box's OnTextChanged event Widgets/Text/SInlineEditableTextBlock.h  

Static

Name Remarks Include Path Unreal Specifiers

static const FSlateWidgetClassData & GetPrivateWidgetClass()

   Widgets/Text/SInlineEditableTextBlock.h  

static SLATE_API void PrivateRegisterAttributes ( FSlateAttributeInitializer&
)

   Widgets/Text/SInlineEditableTextBlock.h  

static const FSlateWidgetClassData & StaticWidgetClass()

   Widgets/Text/SInlineEditableTextBlock.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page