className
stringlengths
1
167
headerPath
stringlengths
14
166
description
stringlengths
0
1.62k
module
stringlengths
0
76
code
stringlengths
0
11.4k
variables
listlengths
0
395
SEditableText::GetSlateWidget
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SEditableText.h
Get the Slate widget this interface is representing (may not be called during destruction)
Slate
virtual [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) > GetSlateWidget()
[]
SEditableText::GetSlateWidgetPtr
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SEditableText.h
Get the Slate widget this interface is representing (may be null during destruction)
Slate
virtual [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) > GetSlateWidgetPtr()
[]
SEditableText::GetVirtualKeyboardDismissAction
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SEditableText.h
Get the message action to take when the virtual keyboard is dismissed by the user
Slate
virtual EVirtualKeyboardDismissAction GetVirtualKeyboardDismissAction() const
[]
SEditableText::GetVirtualKeyboardOptions
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SEditableText.h
Get the options for the virtual keyboard used for this widget
Slate
virtual [FVirtualKeyboardOptions](API\Runtime\Slate\Widgets\Input\FVirtualKeyboardOptions) GetVirtualKeyboardOptions() const
[]
SEditableText::GetVirtualKeyboardTrigger
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SEditableText.h
Get the type of event that will trigger the display of the virtual keyboard
Slate
virtual EVirtualKeyboardTrigger GetVirtualKeyboardTrigger() const
[]
SEditableText::GoTo
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SEditableText.h
Move the cursor to the given location in the document (will also scroll to this point)
Slate
void GoTo ( const [FTextLocation](API\Runtime\Slate\Framework\Text\FTextLocation) & NewLocation )
[]
SEditableText::GetVirtualKeyboardType
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SEditableText.h
Get the type of virtual keyboard to use for this widget
Slate
virtual EKeyboardType GetVirtualKeyboardType() const
[]
SEditableText::GoTo
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SEditableText.h
Move the cursor specified location
Slate
void GoTo ( const ETextLocation NewLocation )
[]
SEditableText::IsInteractable
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SEditableText.h
Is this widget interactive or not? Defaults to false
Slate
virtual bool IsInteractable() const
[]
SEditableText::IsMultiLineTextEdit
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SEditableText.h
Is the text edit multi-line aware?
Slate
virtual bool IsMultiLineTextEdit() const
[]
SEditableText::IsTextPassword
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SEditableText.h
Is the text displaying a password and should be obscured?
Slate
virtual bool IsTextPassword() const
[]
SEditableText::IsTextReadOnly
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SEditableText.h
Is the text currently read-only?
Slate
virtual bool IsTextReadOnly() const
[]
SEditableText::OnArrangeChildren
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SEditableText.h
Compute the Geometry of all the children and add populate the ArrangedChildren list with their values. Each type of Layout panel should arrange children based on desired behavior.
Slate
virtual void OnArrangeChildren ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & AllottedGeometry, [FArrangedChildren](API\Runtime\SlateCore\Layout\FArrangedChildren) & ArrangedChildren ) const
[]
SEditableText::OnCursorMoved
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SEditableText.h
Called when the cursor is moved within the text area
Slate
virtual void OnCursorMoved ( const [FTextLocation](API\Runtime\Slate\Framework\Text\FTextLocation) & InLocation )
[]
SEditableText::OnCursorQuery
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SEditableText.h
The system asks each widget under the mouse to provide a cursor. This event is bubbled.FCursorReply::Unhandled()if the event is not handled; returnFCursorReply::Cursor()otherwise.
Slate
virtual [FCursorReply](API\Runtime\SlateCore\Input\FCursorReply) OnCursorQuery ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FPointerEvent](API\Runtime\SlateCore\Input\FPointerEvent) & CursorEvent ) const
[]
SEditableText::OnDragOver
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SEditableText.h
Called during drag and drop when the the mouse is being dragged over a widget. A reply that indicated whether this event was handled.
Slate
virtual [FReply](API\Runtime\SlateCore\Input\FReply) OnDragOver ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FDragDropEvent](API\Runtime\SlateCore\Input\FDragDropEvent) & DragDropEvent )
[]
SEditableText::OnDrop
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SEditableText.h
Called when the user is dropping something onto a widget; terminates drag and drop. A reply that indicated whether this event was handled.
Slate
virtual [FReply](API\Runtime\SlateCore\Input\FReply) OnDrop ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FDragDropEvent](API\Runtime\SlateCore\Input\FDragDropEvent) & DragDropEvent )
[]
SEditableText::OnFocusReceived
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SEditableText.h
KEY INPUT Called when focus is given to this widget. This event does not bubble. Returns whether the event was handled, along with other possible actions
Slate
virtual [FReply](API\Runtime\SlateCore\Input\FReply) OnFocusReceived ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FFocusEvent](API\Runtime\SlateCore\Input\FFocusEvent) & InFocusEvent )
[]
SEditableText::OnFocusLost
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SEditableText.h
Called when this widget loses focus. This event does not bubble.
Slate
virtual void OnFocusLost ( const [FFocusEvent](API\Runtime\SlateCore\Input\FFocusEvent) & InFocusEvent )
[]
SEditableText::OnKeyChar
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SEditableText.h
Called after a character is entered while this widget has keyboard focus Returns whether the event was handled, along with other possible actions
Slate
virtual [FReply](API\Runtime\SlateCore\Input\FReply) OnKeyChar ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FCharacterEvent](API\Runtime\SlateCore\Input\FCharacterEvent) & InCharacterEvent )
[]
SEditableText::OnKeyUp
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SEditableText.h
Called after a key is released when this widget has focus Returns whether the event was handled, along with other possible actions
Slate
virtual [FReply](API\Runtime\SlateCore\Input\FReply) OnKeyUp ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FKeyEvent](API\Runtime\SlateCore\Input\FKeyEvent) & InKeyEvent )
[]
SEditableText::OnMouseButtonDoubleClick
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SEditableText.h
Called when a mouse button is double clicked. Override this in derived classes. Returns whether the event was handled, along with other possible actions
Slate
virtual [FReply](API\Runtime\SlateCore\Input\FReply) OnMouseButtonDoubleClick ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & InMyGeometry, const [FPointerEvent](API\Runtime\SlateCore\Input\FPointerEvent) & InMouseEvent )
[]
SEditableText::OnMouseButtonDown
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SEditableText.h
MOUSE INPUT The system calls this method to notify the widget that a mouse button was pressed within it. This event is bubbled. Whether the event was handled along with possible requests for the system to take action.
Slate
virtual [FReply](API\Runtime\SlateCore\Input\FReply) OnMouseButtonDown ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FPointerEvent](API\Runtime\SlateCore\Input\FPointerEvent) & MouseEvent )
[]
SEditableText::OnMouseButtonUp
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SEditableText.h
The system calls this method to notify the widget that a mouse button was release within it. This event is bubbled. Whether the event was handled along with possible requests for the system to take action.
Slate
virtual [FReply](API\Runtime\SlateCore\Input\FReply) OnMouseButtonUp ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FPointerEvent](API\Runtime\SlateCore\Input\FPointerEvent) & MouseEvent )
[]
SEditableText::OnMouseMove
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SEditableText.h
The system calls this method to notify the widget that a mouse moved within it. This event is bubbled. Whether the event was handled along with possible requests for the system to take action.
Slate
virtual [FReply](API\Runtime\SlateCore\Input\FReply) OnMouseMove ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FPointerEvent](API\Runtime\SlateCore\Input\FPointerEvent) & MouseEvent )
[]
SEditableText::OnPaint
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SEditableText.h
The widget should respond by populating the OutDrawElements array with FDrawElements that represent it and any of its children. Called by the non-virtual OnPaint to enforce pre/post conditions during OnPaint. The maximum layer ID attained by this widget or any of its children.
Slate
virtual int32 OnPaint ( const [FPaintArgs](API\Runtime\SlateCore\Types\FPaintArgs) & Args, const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & AllottedGeometry, const [FSlateRect](API\Runtime\SlateCore\Layout\FSlateRect) & MyCullingRect, [FSlateWindowElementList](API\Runtime\SlateCore\Rendering\FSlateWindowElementList) & OutDrawElements, int32 LayerId, const [FWidgetStyle](API\Runtime\SlateCore\Styling\FWidgetStyle) & InWidgetStyle, bool bParentEnabled ) const
[]
SEditableText::OnTextChanged
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SEditableText.h
Called when the text has been changed by an edit operation
Slate
virtual void OnTextChanged ( const [FText](API\Runtime\Core\Internationalization\FText) & InText )
[]
SEditableText::OnTextCommitted
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SEditableText.h
Called when the text control has committed its current edit changes
Slate
virtual void OnTextCommitted ( const [FText](API\Runtime\Core\Internationalization\FText) & InText, const [ETextCommit::Type](API\Runtime\SlateCore\Types\ETextCommit__Type) InTextAction )
[]
SEditableText::ScrollTo
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SEditableText.h
Scroll to the given location in the document (without moving the cursor)
Slate
void ScrollTo ( const [FTextLocation](API\Runtime\Slate\Framework\Text\FTextLocation) & NewLocation )
[]
SEditableText::ScrollTo
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SEditableText.h
Scroll to the given location in the document (without moving the cursor)
Slate
void ScrollTo ( const ETextLocation NewLocation )
[]
SEditableText::OnKeyDown
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SEditableText.h
Called after a key is pressed when this widget has focus (this event bubbles if not handled) Returns whether the event was handled, along with other possible actions
Slate
virtual [FReply](API\Runtime\SlateCore\Input\FReply) OnKeyDown ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FKeyEvent](API\Runtime\SlateCore\Input\FKeyEvent) & InKeyEvent )
[]
SEditableText::SelectAllText
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SEditableText.h
Select all the text in the document
Slate
void SelectAllText()
[]
SEditableText::SetAllowContextMenu
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SEditableText.h
See the AllowContextMenu attribute
Slate
void SetAllowContextMenu ( const [TAttribute](API\Runtime\Core\Misc\TAttribute)< bool > & InAllowContextMenu )
[]
SEditableText::SetClearKeyboardFocusOnCommit
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SEditableText.h
Sets whether to clear keyboard focus when pressing enter to commit changes
Slate
void SetClearKeyboardFocusOnCommit ( const [TAttribute](API\Runtime\Core\Misc\TAttribute)< bool > & InClearKeyboardFocusOnCommit )
[]
SEditableText::SetColorAndOpacity
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SEditableText.h
See the ColorAndOpacity attribute
Slate
void SetColorAndOpacity ( [TAttribute](API\Runtime\Core\Misc\TAttribute)< [FSlateColor](API\Runtime\SlateCore\Styling\FSlateColor) > Color )
[]
SEditableText::SetFont
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SEditableText.h
Sets the font used to draw the text
Slate
void SetFont ( const [TAttribute](API\Runtime\Core\Misc\TAttribute)< [FSlateFontInfo](API\Runtime\SlateCore\Fonts\FSlateFontInfo) > & InNewFont )
[]
SEditableText::SetHintText
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SEditableText.h
See the HintText attribute
Slate
void SetHintText ( const [TAttribute](API\Runtime\Core\Misc\TAttribute)< [FText](API\Runtime\Core\Internationalization\FText) > & InHintText )
[]
SEditableText::SetIsCaretMovedWhenGainFocus
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SEditableText.h
Workaround as we loose focus when the auto completion closes.
Slate
void SetIsCaretMovedWhenGainFocus ( const [TAttribute](API\Runtime\Core\Misc\TAttribute)< bool > & InIsCaretMovedWhenGainFocus )
[]
SEditableText::SetIsPassword
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SEditableText.h
See the IsPassword attribute
Slate
void SetIsPassword ( [TAttribute](API\Runtime\Core\Misc\TAttribute)< bool > InIsPassword )
[]
SEditableText::SetIsReadOnly
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SEditableText.h
See the IsReadOnly attribute
Slate
void SetIsReadOnly ( [TAttribute](API\Runtime\Core\Misc\TAttribute)< bool > InIsReadOnly )
[]
SEditableText::SetJustification
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SEditableText.h
See Justification attribute
Slate
void SetJustification ( const [TAttribute](API\Runtime\Core\Misc\TAttribute)< [ETextJustify::Type](API\Runtime\Slate\Framework\Text\ETextJustify__Type) > & InJustification )
[]
SEditableText::SetMinDesiredWidth
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SEditableText.h
Sets the minimum width that a text block should be.
Slate
void SetMinDesiredWidth ( const [TAttribute](API\Runtime\Core\Misc\TAttribute)< float > & InMinDesiredWidth )
[]
SEditableText::SetOnKeyCharHandler
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SEditableText.h
Sets the OnKeyCharHandler to provide first chance handling of the OnKeyChar event
Slate
void SetOnKeyCharHandler ( FOnKeyChar InOnKeyCharHandler )
[]
SEditableText::SetOnKeyDownHandler
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SEditableText.h
Sets the OnKeyDownHandler to provide first chance handling of the OnKeyDown event
Slate
void SetOnKeyDownHandler ( FOnKeyDown InOnKeyDownHandler )
[]
SEditableText::SetOverflowPolicy
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SEditableText.h
Sets the overflow policy for this text block
Slate
void SetOverflowPolicy ( [TOptional](API\Runtime\Core\IO\TOptional)< ETextOverflowPolicy > InOverflowPolicy )
[]
SEditableText::SetRevertTextOnEscape
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SEditableText.h
Sets whether to allow the user to back out of changes when they press the escape key
Slate
void SetRevertTextOnEscape ( const [TAttribute](API\Runtime\Core\Misc\TAttribute)< bool > & InRevertTextOnEscape )
[]
SEditableText::SetSearchText
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SEditableText.h
Set the text that is currently being searched for (if any)
Slate
void SetSearchText ( const [TAttribute](API\Runtime\Core\Misc\TAttribute)< [FText](API\Runtime\Core\Internationalization\FText) > & InSearchText )
[]
SEditableText::SetSelectAllTextOnCommit
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SEditableText.h
Sets whether to select all text when pressing enter to commit changes
Slate
void SetSelectAllTextOnCommit ( const [TAttribute](API\Runtime\Core\Misc\TAttribute)< bool > & InSelectAllTextOnCommit )
[]
SEditableText::SetSelectAllTextWhenFocused
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SEditableText.h
Sets whether to select all text when the user clicks to give focus on the widget
Slate
void SetSelectAllTextWhenFocused ( const [TAttribute](API\Runtime\Core\Misc\TAttribute)< bool > & InSelectAllTextWhenFocused )
[]
SEditableText::SetSelectWordOnMouseDoubleClick
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SEditableText.h
Sets whether to select word on the mouse double click
Slate
void SetSelectWordOnMouseDoubleClick ( const [TAttribute](API\Runtime\Core\Misc\TAttribute)< bool > & InSelectWordOnMouseDoubleClick )
[]
SEditableText::SetTextBlockStyle
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SEditableText.h
TextStyle Sets the text block style used to draw the text
Slate
void SetTextBlockStyle ( const [FTextBlockStyle](API\Runtime\SlateCore\Styling\FTextBlockStyle) * InTextStyle )
[]
SEditableText::SetTextFlowDirection
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SEditableText.h
See TextFlowDirection attribute
Slate
void SetTextFlowDirection ( const [TOptional](API\Runtime\Core\IO\TOptional)< ETextFlowDirection > & InTextFlowDirection )
[]
SEditableText::SetTextShapingMethod
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SEditableText.h
See TextShapingMethod attribute
Slate
void SetTextShapingMethod ( const [TOptional](API\Runtime\Core\IO\TOptional)< ETextShapingMethod > & InTextShapingMethod )
[]
SEditableText::SetTextStyle
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SEditableText.h
Sets the text style used to draw the text
Slate
void SetTextStyle ( const [FEditableTextStyle](API\Runtime\SlateCore\Styling\FEditableTextStyle) & InNewTextStyle )
[]
SEditableText::SetVirtualKeyboardDismissAction
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SEditableText.h
Set the VirtualKeyboardDismissAction attribute
Slate
void SetVirtualKeyboardDismissAction ( [TAttribute](API\Runtime\Core\Misc\TAttribute)< EVirtualKeyboardDismissAction > InVirtualKeyboardDismissAction )
[]
SEditableText::ShouldClearKeyboardFocusOnCommit
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SEditableText.h
Should we clear the keyboard focus when the user commits text to this widget?
Slate
virtual bool ShouldClearKeyboardFocusOnCommit() const
[]
SEditableText::ShouldClearTextSelectionOnFocusLoss
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SEditableText.h
Should the text clear its selection the widget loses focus?
Slate
virtual bool ShouldClearTextSelectionOnFocusLoss() const
[]
SEditableText::ShouldJumpCursorToEndWhenFocused
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SEditableText.h
Should the cursor be jumped to the end of the document when the widget gains focus?
Slate
virtual bool ShouldJumpCursorToEndWhenFocused() const
[]
SEditableText::ShouldRevertTextOnEscape
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SEditableText.h
Should we revert the text back to its original state when the user presses escape?
Slate
virtual bool ShouldRevertTextOnEscape() const
[]
SEditableText::ShouldSelectAllTextOnCommit
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SEditableText.h
Should we select all text when the user commits text to this widget?
Slate
virtual bool ShouldSelectAllTextOnCommit() const
[]
SEditableText::SetText
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SEditableText.h
Sets the text currently being edited
Slate
void SetText ( const [TAttribute](API\Runtime\Core\Misc\TAttribute)< [FText](API\Runtime\Core\Internationalization\FText) > & InNewText )
[]
SEditableText::ShouldSelectAllTextWhenFocused
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SEditableText.h
Should the text be selected when the widget gains focus?
Slate
virtual bool ShouldSelectAllTextWhenFocused() const
[]
SEditableText::ShouldSelectWordOnMouseDoubleClick
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SEditableText.h
Should we select word on mouse double click?
Slate
virtual bool ShouldSelectWordOnMouseDoubleClick() const
[]
SEditableText::SupportsKeyboardFocus
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SEditableText.h
Checks to see if this widget supports keyboard focus. Override this in derived classes. True if this widget can take keyboard focus
Slate
virtual bool SupportsKeyboardFocus() const
[]
SEditableText::SynchronizeTextStyle
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SEditableText.h
Synchronize the text style currently set (including from overrides) and update the text layout if required
Slate
void SynchronizeTextStyle()
[]
SEditableText::Tick
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SEditableText.h
Ticks this widget with Geometry. Override in derived classes, but always call the parent implementation.
Slate
virtual void Tick ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & AllottedGeometry, const double InCurrentTime, const float InDeltaTime )
[]
SEditableText::UpdateAndClampHorizontalScrollBar
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SEditableText.h
Called when the fraction and offset of the horizontal scroll area has been recalculated. This function should apply the new values to any scrollbars, and return a clamped horizontal scroll value
Slate
virtual float UpdateAndClampHorizontalScrollBar ( const float InViewOffset, const float InViewFraction, const [EVisibility](API\Runtime\SlateCore\Layout\EVisibility) InVisiblityOverride )
[]
SEditableText::UpdateAndClampVerticalScrollBar
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SEditableText.h
Called when the fraction and offset of the vertical scroll area has been recalculated. This function should apply the new values to any scrollbars, and return a clamped vertical scroll value
Slate
virtual float UpdateAndClampVerticalScrollBar ( const float InViewOffset, const float InViewFraction, const [EVisibility](API\Runtime\SlateCore\Layout\EVisibility) InVisiblityOverride )
[]
SEditableText::SEditableText
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SEditableText.h
Constructor
Slate
SEditableText()
[]
SEditableText::~SEditableText
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SEditableText.h
Destructor
Slate
~SEditableText()
[]
SEditableText
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SEditableText.h
Editable text widget
Slate
class SEditableText : public [SWidget](API\Runtime\SlateCore\Widgets\SWidget), public [ISlateEditableTextWidget](API\Runtime\Slate\Widgets\Text\ISlateEditableTextWidget)
[ { "type": "TWeakPtr< FActi...", "name": "ActiveTickTimer", "description": "The timer that is actively driving this widget toTick()even when Slate is idle" }, { "type": "TAttribute< con...", "name": "BackgroundImageSelected", "description": "Background image for the selected text" }, { "type": "TAttribute< boo...", "name": "bAllowContextMenu", "description": "Whether to disable the context menu" }, { "type": "TAttribute< boo...", "name": "bClearKeyboardFocusOnCommit", "description": "Whether to clear keyboard focus when pressing enter to commit changes" }, { "type": "TAttribute< boo...", "name": "bIsCaretMovedWhenGainFocus", "description": "Workaround as we loose focus when the auto completion closes." }, { "type": "TAttribute< boo...", "name": "bIsPassword", "description": "Sets whether this text box is for storing a password" }, { "type": "TAttribute< boo...", "name": "bIsReadOnly", "description": "Sets whether this text box can actually be modified interactively by the user" }, { "type": "TAttribute< boo...", "name": "bRevertTextOnEscape", "description": "Whether to allow the user to back out of changes when they press the escape key" }, { "type": "TAttribute< boo...", "name": "bSelectAllTextOnCommit", "description": "Whether to select all text when pressing enter to commit changes" }, { "type": "TAttribute< boo...", "name": "bSelectAllTextWhenFocused", "description": "Whether to select all text when the user clicks to give focus on the widget" }, { "type": "TAttribute< boo...", "name": "bSelectWordOnMouseDoubleClick", "description": "Whether to select word on mouse double click" }, { "type": "TAttribute<FSl...", "name": "ColorAndOpacity", "description": "Text color and opacity" }, { "type": "TUniquePtr<FSl...", "name": "EditableTextLayout", "description": "The text layout that deals with the editable text" }, { "type": "TAttribute<FSl...", "name": "Font", "description": "The font used to draw the text" }, { "type": "TSharedPtr<FEx...", "name": "MenuExtender", "description": "Menu extender for right-click context menu" }, { "type": "TAttribute< flo...", "name": "MinDesiredWidth", "description": "Prevents the editable text from being smaller than desired in certain cases (e.g. when it is empty)" }, { "type": "FOnContextMenuO...", "name": "OnContextMenuOpening", "description": "Delegate to call before a context menu is opened" }, { "type": "FOnIsTypedCharV...", "name": "OnIsTypedCharValid", "description": "Called when a character is typed and we want to know if the text field supports typing this character." }, { "type": "FOnKeyChar", "name": "OnKeyCharHandler", "description": "Callback delegate to have first chance handling of the OnKeyChar event" }, { "type": "FOnKeyDown", "name": "OnKeyDownHandler", "description": "Callback delegate to have first chance handling of the OnKeyDown event" }, { "type": "FOnTextChanged", "name": "OnTextChangedCallback", "description": "Called whenever the text is changed programmatically or interactively by the user" }, { "type": "FOnTextCommitte...", "name": "OnTextCommittedCallback", "description": "Called whenever the text is committed." }, { "type": "TSharedPtr<FPl...", "name": "PlainTextMarshaller", "description": "Text marshaller used by the editable text layout" }, { "type": "TAttribute< EVi...", "name": "VirtualKeyboardDismissAction", "description": "The message action to take when the virtual keyboard is dismissed by the user" }, { "type": "FVirtualKeyboar...", "name": "VirtualKeyboardOptions", "description": "Additional options used by the virtual keyboard summoned by this widget" }, { "type": "TAttribute< EVi...", "name": "VirtualKeyboardTrigger", "description": "The type of event that will trigger the display of the virtual keyboard" }, { "type": "TAttribute< EKe...", "name": "VirtualKeyboardType", "description": "The type of virtual keyboard to use for editing this text on mobile" }, { "type": "TSharedPtr<IBr...", "name": "WordBreakIterator", "description": "The iterator to use to detect word boundaries" } ]
SEditableTextBox::AdvanceSearch
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SEditableTextBox.h
Advance the current search to the next match (does nothing if not currently searching)
Slate
void AdvanceSearch ( const bool InReverse )
[]
SEditableTextBox::AnyTextSelected
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SEditableTextBox.h
Query to see if any text is selected within the document
Slate
bool AnyTextSelected() const
[]
SEditableTextBox::BeginSearch
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SEditableTextBox.h
Begin a new text search (this is called automatically when the bound search text changes)
Slate
void BeginSearch ( const [FText](API\Runtime\Core\Internationalization\FText) & InSearchText, const [ESearchCase::Type](API\Runtime\Core\Misc\ESearchCase__Type) InSearchCase, const bool InReverse )
[]
SEditableTextBox::ClearSelection
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SEditableTextBox.h
Clear the active text selection
Slate
void ClearSelection()
[]
SEditableTextBox::Construct
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SEditableTextBox.h
Construct this widget
Slate
void Construct ( const [FArguments](API\Runtime\Slate\Widgets\Input\SEditableTextBox\FArguments) & InArgs )
[]
SEditableTextBox::CreateAccessibleWidget
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SEditableTextBox.h
Slate
virtual [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< FSlateAccessibleWidget > CreateAccessibleWidget()
[]
SEditableTextBox::EnableTextInputMethodContext
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SEditableTextBox.h
Register and activate the IME context for the text layout of this textbox
Slate
void EnableTextInputMethodContext()
[]
SEditableTextBox::FArguments::AllowContextMenu
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SEditableTextBox.h
Whether the context menu can be opened
Slate
WidgetArgsType & AllowContextMenu &40; const TAttribute< bool > & InAttribute &41;
[]
SEditableTextBox::FArguments::BackgroundColor
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SEditableTextBox.h
The color of the background/border around the editable text (overrides Style)
Slate
WidgetArgsType & BackgroundColor &40; const TAttribute< FSlateColor > & InAttribute &41;
[]
SEditableTextBox::FArguments::ClearKeyboardFocusOnCommit
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SEditableTextBox.h
Whether to clear keyboard focus when pressing enter to commit changes
Slate
WidgetArgsType & ClearKeyboardFocusOnCommit &40; const TAttribute< bool > & InAttribute &41;
[]
SEditableTextBox::FArguments::ContextMenuExtender
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SEditableTextBox.h
Menu extender for the right-click context menu
Slate
WidgetArgsType & ContextMenuExtender &40; const FMenuExtensionDelegate & InDelegate &41;
[]
SEditableTextBox::FArguments::ErrorReporting
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SEditableTextBox.h
Provide a alternative mechanism for error reporting.
Slate
WidgetArgsType & ErrorReporting &40; TSharedPtr< class IErrorReportingWidget > InArg &41;
[]
SEditableTextBox::FArguments::FocusedForegroundColor
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SEditableTextBox.h
Text color and opacity when this box has keyboard focus (overrides Style)
Slate
WidgetArgsType & FocusedForegroundColor &40; const TAttribute< FSlateColor > & InAttribute &41;
[]
SEditableTextBox::FArguments::Font
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SEditableTextBox.h
Font color and opacity (overrides Style)
Slate
WidgetArgsType & Font &40; const TAttribute< FSlateFontInfo > & InAttribute &41;
[]
SEditableTextBox::FArguments::ForegroundColor
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SEditableTextBox.h
Text color and opacity (overrides Style)
Slate
WidgetArgsType & ForegroundColor &40; const TAttribute< FSlateColor > & InAttribute &41;
[]
SEditableTextBox::FArguments::HintText
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SEditableTextBox.h
Hint text that appears when there is no text in the text box
Slate
WidgetArgsType & HintText &40; const TAttribute< FText > & InAttribute &41;
[]
SEditableTextBox::FArguments::IsCaretMovedWhenGainFocus
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SEditableTextBox.h
Workaround as we loose focus when the auto completion closes.
Slate
WidgetArgsType & IsCaretMovedWhenGainFocus &40; const TAttribute< bool > & InAttribute &41;
[]
SEditableTextBox::FArguments::IsPassword
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SEditableTextBox.h
Sets whether this text box is for storing a password
Slate
WidgetArgsType & IsPassword &40; const TAttribute< bool > & InAttribute &41;
[]
SEditableTextBox::FArguments::IsReadOnly
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SEditableTextBox.h
Sets whether this text box can actually be modified interactively by the user
Slate
WidgetArgsType & IsReadOnly &40; const TAttribute< bool > & InAttribute &41;
[]
SEditableTextBox::FArguments::Justification
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SEditableTextBox.h
How should the value be justified in the editable text field.
Slate
WidgetArgsType & Justification &40; const TAttribute< ETextJustify::Type > & InAttribute &41;
[]
SEditableTextBox::FArguments::MinDesiredWidth
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SEditableTextBox.h
Minimum width that a text block should be
Slate
WidgetArgsType & MinDesiredWidth &40; const TAttribute< float > & InAttribute &41;
[]
SEditableTextBox::FArguments::OnContextMenuOpening
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SEditableTextBox.h
Delegate to call before a context menu is opened. User returns the menu content or null to the disable context menu
Slate
WidgetArgsType & OnContextMenuOpening &40; const FOnContextMenuOpening & InDelegate &41;
[]
SEditableTextBox::FArguments::OnKeyCharHandler
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SEditableTextBox.h
Callback delegate to have first chance handling of the OnKeyChar event
Slate
WidgetArgsType & OnKeyCharHandler &40; const FOnKeyChar & InDelegate &41;
[]
SEditableTextBox::FArguments::OnTextChanged
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SEditableTextBox.h
Called whenever the text is changed programmatically or interactively by the user
Slate
WidgetArgsType & OnTextChanged &40; const FOnTextChanged & InDelegate &41;
[]
SEditableTextBox::FArguments::OnTextCommitted
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SEditableTextBox.h
Called whenever the text is committed. This happens when the user presses enter or the text box loses focus.
Slate
WidgetArgsType & OnTextCommitted &40; const FOnTextCommitted & InDelegate &41;
[]
SEditableTextBox::FArguments::OnVerifyTextChanged
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SEditableTextBox.h
Called whenever the text is changed programmatically or interactively by the user
Slate
WidgetArgsType & OnVerifyTextChanged &40; const FOnVerifyTextChanged & InDelegate &41;
[]
SEditableTextBox::FArguments::OverflowPolicy
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SEditableTextBox.h
Determines what happens to text that is clipped and doesnt fit within the allotted area for this text box
Slate
WidgetArgsType & OverflowPolicy &40; TOptional< ETextOverflowPolicy > InArg &41;
[]
SEditableTextBox::FArguments::Padding
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SEditableTextBox.h
Padding between the box/border and the text widget inside (overrides Style)
Slate
WidgetArgsType & Padding &40; const TAttribute< FMargin > & InAttribute &41;
[]
SEditableTextBox::FArguments::ReadOnlyForegroundColor
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SEditableTextBox.h
Text color and opacity when read-only (overrides Style)
Slate
WidgetArgsType & ReadOnlyForegroundColor &40; const TAttribute< FSlateColor > & InAttribute &41;
[]