1. Epic GamesDeveloper
  3. FArguments

FArguments

API > API/Runtime > API/Runtime/Slate > API/Runtime/Slate/Widgets > API/Runtime/Slate/Widgets/Input > API/Runtime/Slate/Widgets/Input/SEditableTextBox

Inheritance Hierarchy

References

   
Module Slate
Header /Engine/Source/Runtime/Slate/Public/Widgets/Input/SEditableTextBox.h
Include #include "Widgets/Input/SEditableTextBox.h"

Syntax

struct FArguments : public TSlateBaseNamedArgs< SEditableTextBox >

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function WidgetArgsType &

AllowContextMenu ( const TAttribute< bool >& InAttribute
)

 Whether the context menu can be opened
Public function WidgetArgsType &

BackgroundColor ( const TAttribute< FSlateColor >& InAttribute
)

 The color of the background/border around the editable text (overrides Style)
Public function WidgetArgsType &

ClearKeyboardFocusOnCommit ( const TAttribute< bool >& InAttribute
)

 Whether to clear keyboard focus when pressing enter to commit changes
Public function WidgetArgsType &

ContextMenuExtender ( const FMenuExtensionDelegate& InDelegate
)

 Menu extender for the right-click context menu
Public function WidgetArgsType & Provide a alternative mechanism for error reporting.
Public function WidgetArgsType &

FocusedForegroundColor ( const TAttribute< FSlateColor >& InAttribute
)

 Text color and opacity when this box has keyboard focus (overrides Style)
Public function WidgetArgsType &

Font ( const TAttribute< FSlateFontInfo >& InAttribute
)

 Font color and opacity (overrides Style)
Public function WidgetArgsType &

ForegroundColor ( const TAttribute< FSlateColor >& InAttribute
)

 Text color and opacity (overrides Style)
Public function WidgetArgsType &

HintText ( const TAttribute< FText >& InAttribute
)

 Hint text that appears when there is no text in the text box
Public function WidgetArgsType &

IsCaretMovedWhenGainFocus ( const TAttribute< bool >& InAttribute
)

 Workaround as we loose focus when the auto completion closes.
Public function WidgetArgsType &

IsPassword ( const TAttribute< bool >& InAttribute
)

 Sets whether this text box is for storing a password
Public function WidgetArgsType &

IsReadOnly ( const TAttribute< bool >& InAttribute
)

 Sets whether this text box can actually be modified interactively by the user
Public function WidgetArgsType &

Justification ( const TAttribute< ETextJustify::Type >& InAttribute
)

 How should the value be justified in the editable text field.
Public function WidgetArgsType &

MinDesiredWidth ( const TAttribute< float >& InAttribute
)

 Minimum width that a text block should be
Public function WidgetArgsType &

OnContextMenuOpening ( const FOnContextMenuOpening& InDelegate
)

 Delegate to call before a context menu is opened.
Public function WidgetArgsType &

OnKeyCharHandler ( const FOnKeyChar& InDelegate
)

 Callback delegate to have first chance handling of the OnKeyChar event
Public function WidgetArgsType &

OnKeyDownHandler ( const FOnKeyDown& InDelegate
)

 Callback delegate to have first chance handling of the OnKeyDown event
Public function WidgetArgsType &

OnTextChanged ( const FOnTextChanged& InDelegate
)

 Called whenever the text is changed programmatically or interactively by the user
Public function WidgetArgsType &

OnTextCommitted ( const FOnTextCommitted& InDelegate
)

 Called whenever the text is committed.
Public function WidgetArgsType &

OnVerifyTextChanged ( const FOnVerifyTextChanged& InDelegate
)

 Called whenever the text is changed programmatically or interactively by the user
Public function WidgetArgsType &

OverflowPolicy ( TOptional< ETextOverflowPolicy > InArg
)

 Determines what happens to text that is clipped and doesnt fit within the allotted area for this text box
Public function WidgetArgsType &

Padding ( const TAttribute< FMargin >& InAttribute
)

 Padding between the box/border and the text widget inside (overrides Style)
Public function WidgetArgsType &

ReadOnlyForegroundColor ( const TAttribute< FSlateColor >& InAttribute
)

 Text color and opacity when read-only (overrides Style)
Public function WidgetArgsType &

RevertTextOnEscape ( const TAttribute< bool >& InAttribute
)

 Whether to allow the user to back out of changes when they press the escape key
Public function WidgetArgsType &

SearchText ( const TAttribute< FText >& InAttribute
)

 Text to search for (a new search is triggered whenever this text changes)
Public function WidgetArgsType &

SelectAllTextOnCommit ( const TAttribute< bool >& InAttribute
)

 Whether to select all text when pressing enter to commit changes
Public function WidgetArgsType &

SelectAllTextWhenFocused ( const TAttribute< bool >& InAttribute
)

 Whether to select all text when the user clicks to give focus on the widget
Public function WidgetArgsType &

SelectWordOnMouseDoubleClick ( const TAttribute< bool >& InAttribute
)

 Whether to select word on mouse double click on the widget
Public function WidgetArgsType &

Style ( const FEditableTextBoxStyle* InArg
)

 The styling of the textbox
Public function WidgetArgsType &

Text ( const TAttribute< FText >& InAttribute
)

 Sets the text content for this editable text box widget
Public function WidgetArgsType &

TextFlowDirection ( TOptional< ETextFlowDirection > InArg
)

 Which text flow direction should we use? (unset to use the default returned by GetDefaultTextFlowDirection)
Public function WidgetArgsType &

TextShapingMethod ( TOptional< ETextShapingMethod > InArg
)

 Which text shaping method should we use? (unset to use the default returned by GetDefaultTextShapingMethod)
Public function WidgetArgsType &

VirtualKeyboardDismissAction ( const TAttribute< EVirtualKeyboardDismissAction >& InAttribute
)

 The message action to take when the virtual keyboard is dismissed by the user
Public function WidgetArgsType & Additional options for the virtual keyboard summoned by this widget
Public function WidgetArgsType &

VirtualKeyboardTrigger ( const TAttribute< EVirtualKeyboardTrigger >& InAttribute
)

 The type of event that will trigger the display of the virtual keyboard
Public function WidgetArgsType &

VirtualKeyboardType ( const TAttribute< EKeyboardType >& InAttribute
)

 The type of virtual keyboard to use on mobile devices

Typedefs

Name Description
WidgetArgsType  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page