description: Called when the cursor is moved within the text area

code: WidgetArgsType & OnCursorMoved &40; const SMultiLineEditableText::FOnCursorMoved & InDelegate &41;


description: Called whenever the horizontal scrollbar is moved by the user

module: Slate

code: WidgetArgsType & OnHScrollBarUserScrolled &40; const FOnUserScrolled & InDelegate &41;


description: Called whenever a character is typed. Not called for copy, paste, or any other text changes!

code: WidgetArgsType & OnIsTypedCharValid &40; const FOnIsTypedCharValid & InDelegate &41;


description: Callback delegate to have first chance handling of the OnKeyChar event

code: WidgetArgsType & OnKeyCharHandler &40; const FOnKeyChar & InDelegate &41;


description: Callback delegate to have first chance handling of the OnKeyDown event

code: WidgetArgsType & OnKeyDownHandler &40; const FOnKeyDown & InDelegate &41;


description: Called whenever the text is committed. This happens when the user presses enter or the text box loses focus.

code: WidgetArgsType & OnTextCommitted &40; const FOnTextCommitted & InDelegate &41;


description: Called whenever the text is changed programmatically or interactively by the user

code: WidgetArgsType & OnTextChanged &40; const FOnTextChanged & InDelegate &41;


code: WidgetArgsType & OnVerifyTextChanged &40; const FOnVerifyTextChanged & InDelegate &41;


description: Called whenever the vertical scrollbar is moved by the user

code: WidgetArgsType & OnVScrollBarUserScrolled &40; const FOnUserScrolled & InDelegate &41;


description: Determines what happens to text that is clipped and doesn't fit within the allotted area for this widget

code: WidgetArgsType & OverflowPolicy &40; TOptional< ETextOverflowPolicy > InArg &41;


description: Padding between the box/border and the text widget inside (overrides Style)

code: WidgetArgsType & Padding &40; const TAttribute< FMargin > & InAttribute &41;


description: Text color and opacity when read-only (overrides Style)

code: WidgetArgsType & ReadOnlyForegroundColor &40; const TAttribute< FSlateColor > & InAttribute &41;


description: Whether to allow the user to back out of changes when they press the escape key

code: WidgetArgsType & RevertTextOnEscape &40; const TAttribute< bool > & InAttribute &41;


description: Text to search for (a new search is triggered whenever this text changes)

code: WidgetArgsType & SearchText &40; const TAttribute< FText > & InAttribute &41;


description: Whether to select all text when pressing enter to commit changes

code: WidgetArgsType & SelectAllTextOnCommit &40; const TAttribute< bool > & InAttribute &41;


description: Whether to select all text when the user clicks to give focus on the widget

code: WidgetArgsType & SelectAllTextWhenFocused &40; const TAttribute< bool > & InAttribute &41;


description: Whether to select word on mouse double click on the widget

code: WidgetArgsType & SelectWordOnMouseDoubleClick &40; const TAttribute< bool > & InAttribute &41;


description: The styling of the textbox

code: WidgetArgsType & Style &40; const FEditableTextBoxStyle &42; InArg &41;


description: Sets the text content for this editable text box widget

code: WidgetArgsType & Text &40; const TAttribute< FText > & InAttribute &41;


description: Which text flow direction should we use? (unset to use the default returned by GetDefaultTextFlowDirection)

code: WidgetArgsType & TextFlowDirection &40; TOptional< ETextFlowDirection > InArg &41;


description: Which text shaping method should we use? (unset to use the default returned by GetDefaultTextShapingMethod)

code: WidgetArgsType & TextShapingMethod &40; TOptional< ETextShapingMethod > InArg &41;


code: WidgetArgsType & TextStyle &40; const class USlateWidgetStyleAsset &42;const InSlateStyleAsset &41;


code: WidgetArgsType & TextStyle &40; const TWeakObjectPtr< const class USlateWidgetStyleAsset > & InSlateStyleAsset &41;


code: WidgetArgsType & TextStyle &40; const class ISlateStyle &42; InSlateStyle, const FName & StyleName, const ANSICHAR &42; Specifier &41;


code: WidgetArgsType & TextStyle &40; const class ISlateStyle & InSlateStyle, const FName & StyleName, const ANSICHAR &42; Specifier &41;


code: WidgetArgsType & TextStyle &40; const TWeakObjectPtr< const class ISlateStyle > & InSlateStyle, const FName & StyleName, const ANSICHAR &42; Specifier &41;


code: WidgetArgsType & TextStyle &40; const TSharedPtr< const class ISlateStyle > & InSlateStyle, const FName & StyleName, const ANSICHAR &42; Specifier &41;


description: The message action to take when the virtual keyboard is dismissed by the user

code: WidgetArgsType & VirtualKeyboardDismissAction &40; const TAttribute< EVirtualKeyboardDismissAction > & InAttribute &41;


description: Additional options used by the virtual keyboard summoned by this widget

code: WidgetArgsType & VirtualKeyboardOptions &40; FVirtualKeyboardOptions InArg &41;


description: The type of event that will trigger the display of the virtual keyboard

code: WidgetArgsType & VirtualKeyboardTrigger &40; const TAttribute< EVirtualKeyboardTrigger > & InAttribute &41;


description: The vertical scroll bar widget, or null to create one internally

code: WidgetArgsType & VScrollBar &40; TSharedPtr< SScrollBar > InArg &41;


description: Padding around the vertical scrollbar (overrides Style)

code: WidgetArgsType & VScrollBarPadding &40; const TAttribute< FMargin > & InAttribute &41;


description: The wrapping policy to use

code: WidgetArgsType & WrappingPolicy &40; const TAttribute< ETextWrappingPolicy > & InAttribute &41;


description: Whether text wraps onto a new line when it's length exceeds this width; if this value is zero or negative, no wrapping occurs.

code: WidgetArgsType & WrapTextAt &40; const TAttribute< float > & InAttribute &41;


code: void ForceScroll ( int32 UserIndex, float ScrollAxisMagnitude )


description: Return the text line where the current cursor location is at.

code: void GetCurrentTextLine ( [FString](API\Runtime\Core\Containers\FString) & OutTextLine ) const


description: Get the interaction position of the cursor (where to insert, delete, etc, text from/to)


className: WidgetArgsType

code: typedef FArguments WidgetArgsType


description:
Returns the hint text string
Hint text string


description: Get the horizontal scroll bar widget

code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< const [SScrollBar](API\Runtime\Slate\Widgets\Layout\SScrollBar) > GetHScrollBar() const


description:
Returns the plain text string without richtext formatting
Text string


description: Get the run currently under the cursor, or null if there is no run currently under the cursor

code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< const [IRun](API\Runtime\Slate\Framework\Text\IRun) > GetRunUnderCursor() const


description: Get the text that is currently being searched for (if any)


className: FArguments

code: struct FArguments : public [TSlateBaseNamedArgs< SMultiLineEditableTextBox >](API\Runtime\SlateCore\Widgets\TSlateBaseNamedArgs)

type: constFTextBloc...

description: Pointer to a style of the text block, which dictates the font, color, and shadow options.


description: Get the runs currently that are current selected, some of which may be only partially selected

code: [TArray](API\Runtime\Core\Containers\TArray)< [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< const [IRun](API\Runtime\Slate\Framework\Text\IRun) > > GetSelectedRuns() const


description: Get the currently selected text


description:
Returns the text string
Text string


description: Get the vertical scroll bar widget

code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< const [SScrollBar](API\Runtime\Slate\Widgets\Layout\SScrollBar) > GetVScrollBar() const


description: Move the cursor to the given location in the document

code: void GoTo ( const [FTextLocation](API\Runtime\Slate\Framework\Text\FTextLocation) & NewLocation )


description: Move the cursor to the specified location

code: void GoTo ( const ETextLocation NewLocation )


description:
Checks to see if this widget currently has the keyboard focus
True if this widget has keyboard focus

code: virtual bool HasKeyboardFocus() const


description: Insert the given text at the current cursor position, correctly taking into account new line characters

code: void InsertTextAtCursor ( const [FText](API\Runtime\Core\Internationalization\FText) & InText )


description: Insert the given run at the current cursor position

code: void InsertRunAtCursor ( [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [IRun](API\Runtime\Slate\Framework\Text\IRun) > InRun )


code: void InsertTextAtCursor ( const [FString](API\Runtime\Core\Containers\FString) & InString )


description: Callback for the editable text's OnTextChanged event

code: void OnEditableTextChanged ( const [FText](API\Runtime\Core\Internationalization\FText) & InText )


description: Callback when the editable text is committed.

code: void OnEditableTextCommitted ( const [FText](API\Runtime\Core\Internationalization\FText) & InText, [ETextCommit::Type](API\Runtime\SlateCore\Types\ETextCommit__Type) InCommitType )


description:
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

code: virtual [FReply](API\Runtime\SlateCore\Input\FReply) OnFocusReceived ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FFocusEvent](API\Runtime\SlateCore\Input\FFocusEvent) & InFocusEvent )


description:
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

code: virtual [FReply](API\Runtime\SlateCore\Input\FReply) OnKeyDown ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FKeyEvent](API\Runtime\SlateCore\Input\FKeyEvent) & InKeyEvent )


description: Refresh this text box immediately, rather than wait for the usual caching mechanisms to take affect on the text Tick

code: void Refresh()


description: Scroll to the given location in the document (without moving the cursor)

code: void ScrollTo ( const [FTextLocation](API\Runtime\Slate\Framework\Text\FTextLocation) & NewLocation )


code: void ScrollTo ( const ETextLocation NewLocation )


description: Select all the text in the document

code: void SelectAllText()


description: See the AllowContextMenu attribute

code: void SetAllowContextMenu ( const [TAttribute](API\Runtime\Core\Misc\TAttribute)< bool > & InAllowContextMenu )


description: See AutoWrapText attribute

code: void SetAutoWrapText ( const [TAttribute](API\Runtime\Core\Misc\TAttribute)< bool > & InAutoWrapText )


description: If InError is a non-empty string the TextBox will the ErrorReporting provided during construction If no error reporting was provided, the TextBox will create a default error reporter.

code: void SetError ( const [FText](API\Runtime\Core\Internationalization\FText) & InError )


code: void SetError ( const [FString](API\Runtime\Core\Containers\FString) & InError )


description: Sets the text that appears when there is no text in the text box

code: void SetHintText ( const [TAttribute](API\Runtime\Core\Misc\TAttribute)< [FText](API\Runtime\Core\Internationalization\FText) > & InHintText )


description: Set the ReadOnly attribute

code: void SetIsReadOnly ( const [TAttribute](API\Runtime\Core\Misc\TAttribute)< bool > & InIsReadOnly )


description: See Justification attribute

code: void SetJustification ( const [TAttribute](API\Runtime\Core\Misc\TAttribute)< [ETextJustify::Type](API\Runtime\Slate\Framework\Text\ETextJustify__Type) > & InJustification )


description: See LineHeightPercentage attribute

code: void SetLineHeightPercentage ( const [TAttribute](API\Runtime\Core\Misc\TAttribute)< float > & InLineHeightPercentage )


description: See Margin attribute

code: void SetMargin ( const [TAttribute](API\Runtime\Core\Misc\TAttribute)< [FMargin](API\Runtime\SlateCore\Layout\FMargin) > & InMargin )


description: Sets the OnKeyDownHandler to provide first chance handling of theSMultiLineEditableText's OnKeyDown event

code: void SetOnKeyDownHandler ( FOnKeyDown InOnKeyDownHandler )


description: Sets the OnKeyCharHandler to provide first chance handling of theSMultiLineEditableText's OnKeyChar event

code: void SetOnKeyCharHandler ( FOnKeyChar InOnKeyCharHandler )


description: Sets the overflow policy for this text block

code: void SetOverflowPolicy ( [TOptional](API\Runtime\Core\IO\TOptional)< ETextOverflowPolicy > InOverflowPolicy )


description: Set the text that is currently being searched for (if any)

code: void SetSearchText ( const [TAttribute](API\Runtime\Core\Misc\TAttribute)< [FText](API\Runtime\Core\Internationalization\FText) > & InSearchText )


description: Sets whether to select word on the mouse double click

code: void SetSelectWordOnMouseDoubleClick ( const [TAttribute](API\Runtime\Core\Misc\TAttribute)< bool > & InSelectWordOnMouseDoubleClick )


description: See attribute Style

code: void SetStyle ( const [FEditableTextBoxStyle](API\Runtime\SlateCore\Styling\FEditableTextBoxStyle) * InStyle )


description: Sets the text string currently being edited

code: void SetText ( const [TAttribute](API\Runtime\Core\Misc\TAttribute)< [FText](API\Runtime\Core\Internationalization\FText) > & InNewText )


description: Sets the text color and opacity (overrides Style)

code: void SetTextBoxForegroundColor ( const [TAttribute](API\Runtime\Core\Misc\TAttribute)< [FSlateColor](API\Runtime\SlateCore\Styling\FSlateColor) > & InForegroundColor )


description: Sets the color of the background/border around the editable text (overrides Style)

code: void SetTextBoxBackgroundColor ( const [TAttribute](API\Runtime\Core\Misc\TAttribute)< [FSlateColor](API\Runtime\SlateCore\Styling\FSlateColor) > & InBackgroundColor )


description: Sets the text color and opacity when read-only (overrides Style)

code: void SetReadOnlyForegroundColor ( const [TAttribute](API\Runtime\Core\Misc\TAttribute)< [FSlateColor](API\Runtime\SlateCore\Styling\FSlateColor) > & InReadOnlyForegroundColor )


description: See TextFlowDirection attribute

code: void SetTextFlowDirection ( const [TOptional](API\Runtime\Core\IO\TOptional)< ETextFlowDirection > & InTextFlowDirection )


description: See TextShapingMethod attribute

code: void SetTextShapingMethod ( const [TOptional](API\Runtime\Core\IO\TOptional)< ETextShapingMethod > & InTextShapingMethod )


description: Set the VirtualKeyboardDismissAction attribute

code: void SetVirtualKeyboardDismissAction ( [TAttribute](API\Runtime\Core\Misc\TAttribute)< EVirtualKeyboardDismissAction > InVirtualKeyboardDismissAction )


description: See attribute TextStyle

code: void SetTextStyle ( const [FTextBlockStyle](API\Runtime\SlateCore\Styling\FTextBlockStyle) * InTextStyle )


description: Set WrappingPolicy attribute

code: void SetWrappingPolicy ( const [TAttribute](API\Runtime\Core\Misc\TAttribute)< ETextWrappingPolicy > & InWrappingPolicy )


description: See WrapTextAt attribute

code: void SetWrapTextAt ( const [TAttribute](API\Runtime\Core\Misc\TAttribute)< float > & InWrapTextAt )


description:
Checks to see if this widget supports keyboard focus. Override this in derived classes.
True if this widget can take keyboard focus

code: virtual bool SupportsKeyboardFocus() const


code: void Construct ( const [FArguments](API\Runtime\Slate\Widgets\Input\SNumericDropDown\FArguments) & InArgs )


className: SMultiLineEditableTextBox

description: Editable text box widget

code: class SMultiLineEditableTextBox : public [SBorder](API\Runtime\Slate\Widgets\Layout\SBorder)

AllowContextMenu

type: TAttribute< boo...

description: Whether to disable the context menu

BackgroundColorOverride

type: TAttribute<FSl...

description: Background color (overrides style)

bHasExternalHScrollBar

type: bool

description: Whether we have an externally supplied horizontal scrollbar or one created internally

bHasExternalVScrollBar

description: Whether we have an externally supplied vertical scrollbar or one created internally

Box

type: TSharedPtr<SHo...

description: Allows for inserting additional widgets that extend the functionality of the text box

bSelectWordOnMouseDoubleClick

description: Whether to select work on mouse double click

EditableText

type: TSharedPtr<SMu...

description: Editable text widget

ErrorReporting

type: TSharedPtr< cla...

description: SomeWidget reporting

FocusedForegroundColorOverride

description: Focused foreground color (overrides style)

FontOverride

description: Font (overrides style)

ForegroundColorOverride

description: Foreground color (overrides style)

HScrollBar

type: TSharedPtr<SSc...

description: Horiz scrollbar

HScrollBarPaddingBox

type: TSharedPtr<SBo...

description: Box around the horiz scrollbar used for adding padding

HScrollBarPaddingOverride

type: TAttribute<FMa...

description: Horiz scrollbar padding (overrides style)

OnTextChanged

type: FOnTextChanged

description: Called when the text is changed interactively

OnTextCommitted

type: FOnTextCommitte...

description: Called when the user commits their change to the editable text control

OnVerifyTextChanged

type: FOnVerifyTextCh...

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

PaddingOverride

description: Padding (overrides style)

ReadOnlyForegroundColorOverride

description: Read-only foreground color (overrides style)

Style

type: constFEditable...

VScrollBar

description: Vert scrollbar

VScrollBarPaddingBox

description: Box around the vert scrollbar used for adding padding

VScrollBarPaddingOverride

description: Vert scrollbar padding (overrides style)


description: Toggle to show the drop down text value if the value matches the numeric value.

code: WidgetArgsType & bShowNamedValue &40; const TAttribute< bool > & InAttribute &41;


description: The values which are used to populate the drop down menu.

code: WidgetArgsType & DropDownValues &40; TArray< FNamedValue > InArg &41;


description: Controls the minimum width for the text box portion of the control.

code: WidgetArgsType & MinDesiredValueWidth &40; const TAttribute< float > & InAttribute &41;


description: The text which is displayed in the label next to the control.

code: WidgetArgsType & LabelText &40; const TAttribute< FText > & InAttribute &41;


description: The callback for when the value changes.

code: WidgetArgsType & OnValueChanged &40; const FOnValueChanged & InDelegate &41;


description: Controls the label placement for the control. Vertical will place the label above, horizontal will place the label to the left.

code: WidgetArgsType & Orientation &40; const TAttribute< EOrientation > & InAttribute &41;


description: The value displayed by the control.

code: WidgetArgsType & Value &40; const TAttribute< NumericType > & InAttribute &41;


code: typedef FArguments WidgetArgsType


code: struct FArguments : public [TSlateBaseNamedArgs< SNumericDropDown< NumericType > >](API\Runtime\SlateCore\Widgets\TSlateBaseNamedArgs)


description: Creates a newFNamedValueThe numeric value to be assigned  The display text for the value in the UI  The description of the value used in tooltips or wherever a longer description is needed.

code: FNamedValue &40; NumericType InValue, FText InName, FText InDescription &41;


className: FNamedValue

description: Represents a named numeric value for display in the drop down menu.

code: class FNamedValue


className: FOnValueChanged

code: typedef TBaseDelegate_OneParam< void, NumericType > FOnValueChanged


className: SNumericDropDown

description: A widget which allows the user to enter a digit or choose a number from a drop down menu.

code: template<typename NumericType> class SNumericDropDown : public [SCompoundWidget](API\Runtime\SlateCore\Widgets\SCompoundWidget)


code: void Construct ( const [FArguments](API\Runtime\Slate\Widgets\Input\SRichTextHyperlink\FArguments) & InArgs, const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FSlateHyperlinkRun::FWidgetViewModel](API\Runtime\Slate\Framework\Text\FSlateHyperlinkRun\FWidgetViewModel) > & InViewModel )


code: WidgetArgsType & OnNavigate &40; const FSimpleDelegate & InDelegate &41;


code: WidgetArgsType & Style &40; const FHyperlinkStyle &42; InArg &41;


code: WidgetArgsType & Text &40; const TAttribute< FText > & InAttribute &41;


code: WidgetArgsType & TextFlowDirection &40; TOptional< ETextFlowDirection > InArg &41;


code: WidgetArgsType & TextShapingMethod &40; TOptional< ETextShapingMethod > InArg &41;


code: struct FArguments : public [TSlateBaseNamedArgs< SRichTextHyperlink >](API\Runtime\SlateCore\Widgets\TSlateBaseNamedArgs)


description:
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.

code: virtual [FReply](API\Runtime\SlateCore\Input\FReply) OnMouseButtonDown ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FPointerEvent](API\Runtime\SlateCore\Input\FPointerEvent) & MouseEvent )


description:
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.

code: virtual [FReply](API\Runtime\SlateCore\Input\FReply) OnMouseButtonUp ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FPointerEvent](API\Runtime\SlateCore\Input\FPointerEvent) & MouseEvent )


description: The system will use this event to notify a widget that the cursor has entered it. This event is uses a custom bubble strategy.

code: virtual void OnMouseEnter ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FPointerEvent](API\Runtime\SlateCore\Input\FPointerEvent) & MouseEvent )


description: The system will use this event to notify a widget that the cursor has left it. This event is uses a custom bubble strategy.

code: virtual void OnMouseLeave ( const [FPointerEvent](API\Runtime\SlateCore\Input\FPointerEvent) & MouseEvent )


className: SRichTextHyperlink

code: class SRichTextHyperlink : public [SHyperlink](API\Runtime\Slate\Widgets\Input\SHyperlink)


code: void Construct ( const [FArguments](API\Runtime\Slate\Widgets\Input\SSearchBox\FArguments) & InArgs )


description: Whether the SearchBox should delay notifying listeners of text changed events until the user is done typing

code: WidgetArgsType & DelayChangeNotificationsWhileTyping &40; const TAttribute< bool > & InAttribute &41;


description: If we're delaying change notifications how many seconds should we wait?

code: WidgetArgsType & DelayChangeNotificationsWhileTypingSeconds &40; const TAttribute< float > & InAttribute &41;


description: The text displayed in the SearchBox when no text has been entered

code: WidgetArgsType & HintText &40; const TAttribute< FText > & InAttribute &41;


description: The text displayed in the SearchBox when it's created

code: WidgetArgsType & InitialText &40; const TAttribute< FText > & InAttribute &41;


description: Whether or not an external search is currently running.

code: WidgetArgsType & IsSearching &40; const TAttribute< bool > & InAttribute &41;


description: Minimum width that a text block should be

code: WidgetArgsType & MinDesiredWidth &40; const TAttribute< float > & InAttribute &41;


description: Callback delegate to have first chance handling of the OnKeyDown event

code: WidgetArgsType & OnKeyDownHandler &40; const FOnKeyDown & InDelegate &41;


description: This will add a next and previous button to your search box

code: WidgetArgsType & OnSearch &40; const FOnSearch & InDelegate &41;


description: Optional callback to allow for special functionality to be invoked when the search glass button is clicked

code: WidgetArgsType & OnSearchGlassClicked &40; const FOnClicked & InDelegate &41;


description: Invoked whenever the text changes

code: WidgetArgsType & OnTextChanged &40; const FOnTextChanged & InDelegate &41;


description: Invoked whenever the text is committed (e.g. user presses enter)

code: WidgetArgsType & OnTextCommitted &40; const FOnTextCommitted & InDelegate &41;


description: Called whenever the text is changed programmatically or interactively by the user

code: WidgetArgsType & OnVerifyTextChanged &40; const FOnVerifyTextChanged & InDelegate &41;


description: Optional search result data to be shown in the search bar.

code: WidgetArgsType & SearchResultData &40; const TAttribute< TOptional< FSearchResultData > > & InAttribute &41;


description: Whether to select all text when the user clicks to give focus on the widget

code: WidgetArgsType & SelectAllTextWhenFocused &40; const TAttribute< bool > & InAttribute &41;


description: Style used to draw this search box

code: WidgetArgsType & Style &40; const FSearchBoxStyle &42; InArg &41;


code: typedef FArguments WidgetArgsType


code: struct FArguments : public [TSlateBaseNamedArgs< SSearchBox >](API\Runtime\SlateCore\Widgets\TSlateBaseNamedArgs)


className: FOnSearch

code: typedef TBaseDelegate_OneParam< void, [SSearchBox::SearchDirection](API\Runtime\Slate\Widgets\Input\SSearchBox\SearchDirection) > FOnSearch


className: FSearchResultData

description: Data for external search results to be shown in the search box.

code: struct FSearchResultData

CurrentSearchResultIndex

description: The index of the currently focused search result.

NumSearchResults

description: The total number of search results.


className: SearchDirection

description: Which direction to go when searching

code: enum SearchDirection { Previous, Next, }


className: SSearchBox

description: A text box that is used for searching. Meant to be as easy to use as possible with as few options as possible.

code: class SSearchBox : public [SEditableTextBox](API\Runtime\Slate\Widgets\Input\SEditableTextBox)


code: [FScopedWidgetSlotArguments](API\Runtime\Slate\Widgets\Input\SSegmentedControl\FScopedWidgetSlotArguments) AddSlot ( const OptionType & InValue, bool bRebuildChildren )


code: void Construct ( const [FArguments](API\Runtime\Slate\Widgets\Input\SSegmentedControl\FArguments) & InArgs )


code: static [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [SSegmentedControl](API\Runtime\Slate\Widgets\Input\SSegmentedControl)< OptionType > > Create ( const [TArray](API\Runtime\Core\Containers\TArray)< OptionType > & InKeys, const [TArray](API\Runtime\Core\Containers\TArray)< [FText](API\Runtime\Core\Internationalization\FText) > & InLabels, const [TArray](API\Runtime\Core\Containers\TArray)< [FText](API\Runtime\Core\Internationalization\FText) > & InTooltips, const [TAttribute](API\Runtime\Core\Misc\TAttribute)< [TArray](API\Runtime\Core\Containers\TArray)< OptionType >> & InValues, bool bSupportsMultiSelection, [FOnValuesChanged](API\Runtime\Slate\Widgets\Input\SSegmentedControl\FOnValuesChanged) OnValuesChanged )


description: Optional maximum number of segments per line before the control wraps vertically to the next line. If this value is <= 0 no wrapping happens

code: WidgetArgsType & MaxSegmentsPerLine &40; int32 InArg &41;


description: Called when the (primary) value is changed

code: WidgetArgsType & OnValueChanged &40; const FOnValueChanged & InDelegate &41;


description: Called when the value is changed (useful for multi selection)

code: WidgetArgsType & OnValueChecked &40; const FOnValueChecked & InDelegate &41;


description: Called when the any value is changed

code: WidgetArgsType & OnValuesChanged &40; const FOnValuesChanged & InDelegate &41;


code: WidgetArgsType & operator&43; &40; typename FSlot::FSlotArguments && SlotToAdd &41;


code: WidgetArgsType & operator&43; &40; typename FSlot::FSlotArguments & SlotToAdd &41;


description: Styling for this control

code: WidgetArgsType & Style &40; const FSegmentedControlStyle &42; InArg &41;


description: If enabled the widget will support an empty selection. This is only enabled if SupportsMultiSelection is also enabled.

code: WidgetArgsType & SupportsEmptySelection &40; bool InArg &41;


description: If enabled the widget will support multi selection. For single selection the widget relies on the Value attribute, for multi selection the widget relies on the MultiValue attribute.

code: WidgetArgsType & SupportsMultiSelection &40; bool InArg &41;


description: Styling for the text in each slot. If a custom widget is supplied for a slot this argument is not used

code: WidgetArgsType & TextStyle &40; const FTextBlockStyle &42; InArg &41;


description: Padding to apply to each slot

code: WidgetArgsType & UniformPadding &40; const TAttribute< FMargin > & InAttribute &41;


description: The current control value.

code: WidgetArgsType & Value &40; const TAttribute< OptionType > & InAttribute &41;


code: typedef FArguments WidgetArgsType


description: The current (multiple) control values (if SupportsMultiSelection is enabled)

code: WidgetArgsType & Values &40; const TAttribute< TArray< OptionType > > & InAttribute &41;


code: typedef TBaseDelegate_OneParam< void, OptionType > FOnValueChanged


code: struct FArguments : public [TSlateBaseNamedArgs< SSegmentedControl< OptionType > >](API\Runtime\SlateCore\Widgets\TSlateBaseNamedArgs)

type: TArray< typenam...

description: Slot type supported by this panel


className: FOnValueChecked

code: typedef TBaseDelegate_TwoParams< void, OptionType, ECheckBoxState > FOnValueChecked


className: FOnValuesChanged

code: typedef TBaseDelegate_OneParam< void, [TArray](API\Runtime\Core\Containers\TArray)< OptionType > > FOnValuesChanged


className: FScopedWidgetSlotArguments

description: Slot Management.


code: WidgetArgsType & Text &40; const TAttribute< FText > & InAttribute &41;


code: void Construct &40; const FChildren & SlotOwner, FSlotArguments && InArgs &41;


code: WidgetArgsType & Icon &40; const TAttribute< const FSlateBrush &42; > & InAttribute &41;


code: WidgetArgsType & ToolTip &40; const TAttribute< FText > & InAttribute &41;


code: WidgetArgsType & Value &40; TOptional< OptionType > InArg &41;


className: FSlotArguments

code: struct FSlotArguments : public [TSlotBase< FSlot >::FSlotArguments](API\Runtime\SlateCore\TSlotBase\FSlotArguments), public [TAlignmentWidgetSlotMixin< FSlot >::FSlotArgumentsMixin](API\Runtime\SlateCore\Layout\TAlignmentWidgetSlotMixin\FSlotArgumentsMixin)


code: const FSlateBrush &42; GetIcon&40;&41; const


code: void SetIcon &40; TAttribute< const FSlateBrush &42; > InBrush &41;


code: void SetText &40; TAttribute< FText > InText &41;


code: void SetToolTip &40; TAttribute< FText > InTooltip &41;


code: FSlot &40; const OptionType & InValue &41;


className: FSlot

description: Stores the per-child info for this panel type

code: struct FSlot : public [TSlotBase< FSlot >](API\Runtime\SlateCore\TSlotBase), public [TAlignmentWidgetSlotMixin< FSlot >](API\Runtime\SlateCore\Layout\TAlignmentWidgetSlotMixin)

SSegmentedControl< OptionType >

type: friend


code: [TArray](API\Runtime\Core\Containers\TArray)< OptionType > GetValues() const


code: bool HasValue ( OptionType InValue )


description: See the Value attribute

code: void SetValue ( [TAttribute](API\Runtime\Core\Misc\TAttribute)< OptionType > InValue, bool bUpdateChildren )


description: See the Values attribute

code: void SetValues ( [TAttribute](API\Runtime\Core\Misc\TAttribute)< [TArray](API\Runtime\Core\Containers\TArray)< OptionType >> InValues, bool bUpdateChildren )


code: static [FSlot::FSlotArguments](API\Runtime\Slate\Widgets\Input\SSegmentedControl\FSlot\FSlotArguments) Slot ( const OptionType & InValue )


className: SSegmentedControl

description: Note: It is currently not possible to add segments after initialization (i.e. there is no AddSlot).

code: template<typename OptionType> class SSegmentedControl : public [SCompoundWidget](API\Runtime\SlateCore\Widgets\SCompoundWidget)


description: LeafWidgets should compute their DesiredSize based solely on their visual representation. There is no need to take child widgets into account as LeafWidgets have none by definition. For example, the TextBlock widget simply measures the area necessary to display its text with the given font and font size.

code: virtual FVector2D ComputeDesiredSize ( float ) const


description: Commits the specified slider value.

code: virtual void CommitValue ( float NewValue )


description: Construct the widget.

code: void Construct ( const [SSlider::FArguments](API\Runtime\Slate\Widgets\Input\SSlider\FArguments) & InDeclaration )


code: virtual [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< FSlateAccessibleWidget > CreateAccessibleWidget()


description: Whether the slidable area should be indented to fit the handle.

code: WidgetArgsType & IndentHandle &40; const TAttribute< bool > & InAttribute &41;


description: Sometimes a slider should only be mouse-clickable and never keyboard focusable.

code: WidgetArgsType & IsFocusable &40; bool InArg &41;


description: The maximum value that can be specified by using the slider.

code: WidgetArgsType & MaxValue &40; float InArg &41;


description: Whether the handle is interactive or fixed.

code: WidgetArgsType & Locked &40; const TAttribute< bool > & InAttribute &41;


description: The minimum value that can be specified by using the slider.

code: WidgetArgsType & MinValue &40; float InArg &41;


description: Invoked when the Controller is pressed and capture begins.

code: WidgetArgsType & OnControllerCaptureBegin &40; const FSimpleDelegate & InDelegate &41;


description: Sets new value if mouse position is greater/less than half the step size.

code: WidgetArgsType & MouseUsesStep &40; bool InArg &41;


description: Invoked when the controller capture is released.

code: WidgetArgsType & OnControllerCaptureEnd &40; const FSimpleDelegate & InDelegate &41;


description: Invoked when the mouse is pressed and a capture begins.

code: WidgetArgsType & OnMouseCaptureBegin &40; const FSimpleDelegate & InDelegate &41;


description: Invoked when the mouse is released and a capture ends.

code: WidgetArgsType & OnMouseCaptureEnd &40; const FSimpleDelegate & InDelegate &41;


description: Called when the value is changed by the slider.

code: WidgetArgsType & OnValueChanged &40; const FOnFloatValueChanged & InDelegate &41;


description: The slider's orientation.

code: WidgetArgsType & Orientation &40; EOrientation InArg &41;


description: The color to draw the slider bar in.

code: WidgetArgsType & SliderBarColor &40; const TAttribute< FSlateColor > & InAttribute &41;


description: The color to draw the slider handle in.

code: WidgetArgsType & SliderHandleColor &40; const TAttribute< FSlateColor > & InAttribute &41;


description: The input mode while using the controller.

code: WidgetArgsType & StepSize &40; const TAttribute< float > & InAttribute &41;


description: The style used to draw the slider.

code: WidgetArgsType & Style &40; const FSliderStyle &42; InArg &41;


description: A value that drives where the slider handle appears. Value is normalized between 0 and 1.

code: WidgetArgsType & Value &40; const TAttribute< float > & InAttribute &41;


className: WidgetArgsType

code: typedef FArguments WidgetArgsType


code: const [FSlateBrush](API\Runtime\SlateCore\Styling\FSlateBrush) * GetBarImage() const


className: FArguments

code: struct FArguments : public [TSlateBaseNamedArgs< SSlider >](API\Runtime\SlateCore\Widgets\TSlateBaseNamedArgs)


description: Sets whether we have to lock input to change the slider value.

code: WidgetArgsType & RequiresControllerLock &40; bool InArg &41;


description: an attribute reference of IndentHandle

code: [TSlateAttributeRef](API\Runtime\SlateCore\Widgets\SWidget\TSlateAttributeRef)< bool > GetIndentHandleAttribute() const


description: an attribute reference of Locked

code: [TSlateAttributeRef](API\Runtime\SlateCore\Widgets\SWidget\TSlateAttributeRef)< bool > GetLockedAttribute() const


description: Get the MaxValue attribute

code: float GetMaxValue() const


description: Get the MinValue attribute

code: float GetMinValue() const


description: Get the Value attribute scaled from 0 to 1

code: float GetNormalizedValue() const


description: an attribute reference of SliderBarColor


description: an attribute reference of SliderHandleColor


description: Get the StepSize attribute

code: float GetStepSize() const


code: const [FSlateBrush](API\Runtime\SlateCore\Styling\FSlateBrush) * GetThumbImage() const


description: Get the Value attribute

code: float GetValue() const


code: virtual const [FSlateWidgetClassData](API\Runtime\SlateCore\Widgets\FSlateWidgetClassData) & GetWidgetClass() const


description: an attribute reference of IndentHandle

code: [TSlateAttributeRef](API\Runtime\SlateCore\Widgets\SWidget\TSlateAttributeRef)< float > GetValueAttribute() const


description: Is this widget interactive or not? Defaults to false

code: virtual bool IsInteractable() const


description: Is the handle locked or not? Defaults to false

code: bool IsLocked() const


description: Called when this widget loses focus. This event does not bubble.

code: virtual void OnFocusLost ( const [FFocusEvent](API\Runtime\SlateCore\Input\FFocusEvent) & InFocusEvent )


description:
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

code: virtual [FReply](API\Runtime\SlateCore\Input\FReply) OnKeyDown ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FKeyEvent](API\Runtime\SlateCore\Input\FKeyEvent) & InKeyEvent )


description:
Called after a key is released when this widget has focus
Returns whether the event was handled, along with other possible actions

code: virtual [FReply](API\Runtime\SlateCore\Input\FReply) OnKeyUp ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FKeyEvent](API\Runtime\SlateCore\Input\FKeyEvent) & InKeyEvent )


description:
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.

code: virtual [FReply](API\Runtime\SlateCore\Input\FReply) OnMouseButtonDown ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FPointerEvent](API\Runtime\SlateCore\Input\FPointerEvent) & MouseEvent )


description:
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.

code: virtual [FReply](API\Runtime\SlateCore\Input\FReply) OnMouseButtonUp ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FPointerEvent](API\Runtime\SlateCore\Input\FPointerEvent) & MouseEvent )


description: Called when this widget had captured the mouse, but that capture has been revoked for some reason.

code: virtual void OnMouseCaptureLost ( const [FCaptureLostEvent](API\Runtime\SlateCore\Input\FCaptureLostEvent) & CaptureLostEvent )


description:
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.

code: virtual [FReply](API\Runtime\SlateCore\Input\FReply) OnMouseMove ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FPointerEvent](API\Runtime\SlateCore\Input\FPointerEvent) & MouseEvent )


description: Called when navigation is requested e.g. Left Joystick, Direction Pad, Arrow Keys can generate navigation events.

code: virtual [FNavigationReply](API\Runtime\SlateCore\Input\FNavigationReply) OnNavigation ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FNavigationEvent](API\Runtime\SlateCore\Input\FNavigationEvent) & InNavigationEvent )


description: Whenever possible, LeafWidgets should avoid dealing with layout properties. See TextBlock for an example.

code: 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


description: Called when a touchpad touch is moved (finger moved)

code: virtual [FReply](API\Runtime\SlateCore\Input\FReply) OnTouchMoved ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FPointerEvent](API\Runtime\SlateCore\Input\FPointerEvent) & InTouchEvent )


description: Called when a touchpad touch is ended (finger lifted)

code: virtual [FReply](API\Runtime\SlateCore\Input\FReply) OnTouchEnded ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FPointerEvent](API\Runtime\SlateCore\Input\FPointerEvent) & InTouchEvent )


description: Called when a touchpad touch is started (finger down)

code: virtual [FReply](API\Runtime\SlateCore\Input\FReply) OnTouchStarted ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FPointerEvent](API\Runtime\SlateCore\Input\FPointerEvent) & InTouchEvent )


description:
Calculates the new value based on the given absolute coordinates.
The new value.

code: float PositionToValue ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [UE::Slate::FDeprecateVector2DParameter](API\Runtime\SlateCore\Types\FDeprecateVector2DParameter) & AbsolutePosition )


description: Set the IndentHandle attribute

code: void SetIndentHandle ( [TAttribute](API\Runtime\Core\Misc\TAttribute)< bool > InIndentHandle )


description: Set the Locked attribute

code: void SetLocked ( [TAttribute](API\Runtime\Core\Misc\TAttribute)< bool > InLocked )


description: Set the MinValue and MaxValue attributes. If the new MinValue is more than the new MaxValue, MaxValue will be changed to equal MinValue.

code: void SetMinAndMaxValues ( float InMinValue, float InMaxValue )


description: Set the MouseUsesStep attribute

code: void SetMouseUsesStep ( bool MouseUsesStep )


description: Set the Orientation attribute

code: void SetOrientation ( EOrientation InOrientation )


description: Set the RequiresControllerLock attribute

code: void SetRequiresControllerLock ( bool RequiresControllerLock )


description: Set the SliderBarColor attribute

code: void SetSliderBarColor ( [TAttribute](API\Runtime\Core\Misc\TAttribute)< [FSlateColor](API\Runtime\SlateCore\Styling\FSlateColor) > InSliderBarColor )


description: Set the StepSize attribute

code: void SetStepSize ( [TAttribute](API\Runtime\Core\Misc\TAttribute)< float > InStepSize )


description: Set the SliderHandleColor attribute

code: void SetSliderHandleColor ( [TAttribute](API\Runtime\Core\Misc\TAttribute)< [FSlateColor](API\Runtime\SlateCore\Styling\FSlateColor) > InSliderHandleColor )


description: Set the widget style.

code: void SetStyle ( const [FSliderStyle](API\Runtime\SlateCore\Styling\FSliderStyle) * InStyle )


description: Set the Value attribute

code: void SetValue ( [TAttribute](API\Runtime\Core\Misc\TAttribute)< float > InValueAttribute )


code: static const [FSlateWidgetClassData](API\Runtime\SlateCore\Widgets\FSlateWidgetClassData) & StaticWidgetClass()


description:
Checks to see if this widget supports keyboard focus. Override this in derived classes.
True if this widget can take keyboard focus

code: virtual bool SupportsKeyboardFocus() const


code: void ApplySliderMaxValueChanged ( float SliderDeltaToAdd, bool UpdateOnlyIfHigher )


className: SSlider

description: A Slate slider control is a linear scale and draggable handle.

code: class SSlider : public [SLeafWidget](API\Runtime\SlateCore\Widgets\SLeafWidget)

bControllerInputCaptured

description: Holds a flag indicating whether a controller/keyboard is manipulating the slider's value.

bIsFocusable

description: When true, this slider will be keyboard focusable. Defaults to false.

bMouseUsesStep

description: Sets new value if mouse position is greater/less than half the step size.

bRequiresControllerLock

description: Sets whether we have to lock input to change the slider value.

CachedCursor

description: Holds the initial cursor in case a custom cursor has been specified, so we can restore it after dragging the slider.

MaxValue

type: float

Orientation

type: EOrientation

description: Holds the slider's orientation.

PressedScreenSpaceTouchDownPosition

description: The location in screenspace the slider was pressed by a touch

StepSize

type: TAttribute< flo...

description: Holds the amount to adjust the value by when using a controller or keyboard

Style

type: constFSliderSt...

description: Holds the style passed to the widget upon construction.


code: void ApplySliderMinValueChanged ( float SliderDeltaToAdd, bool UpdateOnlyIfLower )


description: Call this method when the user's interaction has changed the value

code: void CommitValue ( NumericType NewValue, double NewSpinValue, [ECommitMethod](API\Runtime\Slate\Widgets\Input\SSpinBox\ECommitMethod) CommitMethod, [ETextCommit::Type](API\Runtime\SlateCore\Types\ETextCommit__Type) OriginalCommitInfo )


description: Construct the widget

code: void Construct ( const [FArguments](API\Runtime\Slate\Widgets\Input\SSpinBox\FArguments) & InArgs )


className: DefaultMaxFractionalDigits

description: The default maximum fractional digits

code: static const int32 DefaultMaxFractionalDigits = 6;


className: DefaultMinFractionalDigits

description: The default minimum fractional digits

code: static const int32 DefaultMinFractionalDigits = 1;


className: ECommitMethod

description: How user changed the value in the spinbox

code: enum ECommitMethod { CommittedViaSpin, CommittedViaTypeIn, CommittedViaArrowKey, CommittedViaCode, }


description: Make the spinbox switch to keyboard-based input mode.

code: void EnterTextMode()


description: Make the spinbox switch to mouse-based input mode.

code: void ExitTextMode()


description: Whether typed values should use delta snapping, defaults to false

code: WidgetArgsType & AlwaysUsesDeltaSnap &40; const TAttribute< bool > & InAttribute &41;


description: Whether to clear keyboard focus when pressing enter to commit changes

code: WidgetArgsType & ClearKeyboardFocusOnCommit &40; const TAttribute< bool > & InAttribute &41;


description: True to broadcast every time we type

code: WidgetArgsType & BroadcastValueChangesPerKey &40; bool InArg &41;


description: Padding to add around this widget and its internal widgets

code: WidgetArgsType & ContentPadding &40; const TAttribute< FMargin > & InAttribute &41;


description: Menu extender for the right-click context menu

code: WidgetArgsType & ContextMenuExtender &40; const FMenuExtensionDelegate & InDelegate &41;


description: Delta to increment the value as the slider moves. If not specified will determine automatically

code: WidgetArgsType & Delta &40; const TAttribute< NumericType > & InAttribute &41;


description: Whether this spin box should have slider feature enabled, defaults to true

code: WidgetArgsType & EnableSlider &40; const TAttribute< bool > & InAttribute &41;


description: Whether this spin box should have mouse wheel feature enabled, defaults to true

code: WidgetArgsType & EnableWheel &40; bool InArg &41;


description: Font used to display text in the slider

code: WidgetArgsType & Font &40; const TAttribute< FSlateFontInfo > & InAttribute &41;


description: How should the value be justified in the spinbox.

code: WidgetArgsType & Justification &40; const TAttribute< ETextJustify::Type > & InAttribute &41;


description: What keyboard to display.

code: WidgetArgsType & KeyboardType &40; const TAttribute< EKeyboardType > & InAttribute &41;


description: If we're an unbounded spinbox, what value do we divide mouse movement by before multiplying by Delta. Requires Delta to be set.

code: WidgetArgsType & LinearDeltaSensitivity &40; const TAttribute< int32 > & InAttribute &41;


description: The maximum fractional digits the spin box displays, defaults to 6

code: WidgetArgsType & MaxFractionalDigits &40; const TAttribute< TOptional< int32 > > & InAttribute &41;


description: The maximum value that can be entered into the text edit box

code: WidgetArgsType & MaxValue &40; const TAttribute< TOptional< NumericType > > & InAttribute &41;


description: The maximum value that can be specified by using the slider, defaults to MaxValue

code: WidgetArgsType & MaxSliderValue &40; const TAttribute< TOptional< NumericType > > & InAttribute &41;


description: The minimum fractional digits the spin box displays, defaults to 1

code: WidgetArgsType & MinFractionalDigits &40; const TAttribute< TOptional< int32 > > & InAttribute &41;


description: The minimum value that can be specified by using the slider, defaults to MinValue

code: WidgetArgsType & MinSliderValue &40; const TAttribute< TOptional< NumericType > > & InAttribute &41;


description: Minimum width that a spin box should be

code: WidgetArgsType & MinDesiredWidth &40; const TAttribute< float > & InAttribute &41;


description: The minimum value that can be entered into the text edit box

code: WidgetArgsType & MinValue &40; const TAttribute< TOptional< NumericType > > & InAttribute &41;


description: Called right after the max slider value is changed (only relevant if SupportDynamicSliderMaxValue is true)

code: WidgetArgsType & OnDynamicSliderMaxValueChanged &40; const FOnDynamicSliderMinMaxValueChanged & InDelegate &41;


description: Called right before the slider begins to move

code: WidgetArgsType & OnBeginSliderMovement &40; const FSimpleDelegate & InDelegate &41;


description: Called right after the min slider value is changed (only relevant if SupportDynamicSliderMinValue is true)

code: WidgetArgsType & OnDynamicSliderMinValueChanged &40; const FOnDynamicSliderMinMaxValueChanged & InDelegate &41;


description: Called when the value is changed by slider or typing

code: WidgetArgsType & OnValueChanged &40; const FOnValueChanged & InDelegate &41;


description: Called right after the slider handle is released by the user

code: WidgetArgsType & OnEndSliderMovement &40; const FOnValueChanged & InDelegate &41;


description: Called when the value is committed (by pressing enter)

code: WidgetArgsType & OnValueCommitted &40; const FOnValueCommitted & InDelegate &41;


description: If refresh requests for the viewport should happen for all value changes

code: WidgetArgsType & PreventThrottling &40; bool InArg &41;


description: Whether to select all text when pressing enter to commit changes

code: WidgetArgsType & SelectAllTextOnCommit &40; const TAttribute< bool > & InAttribute &41;


description: How many pixel the mouse must move to change the value of the delta step

code: WidgetArgsType & ShiftMouseMovePixelPerDelta &40; const TAttribute< int32 > & InAttribute &41;


description: Use exponential scale for the slider

code: WidgetArgsType & SliderExponent &40; const TAttribute< float > & InAttribute &41;


description: When use exponential scale for the slider which is the neutral value

code: WidgetArgsType & SliderExponentNeutralValue &40; const TAttribute< NumericType > & InAttribute &41;


description: The style used to draw this spinbox

code: WidgetArgsType & Style &40; const FSpinBoxStyle &42; InArg &41;


description: Tell us if we want to support dynamically changing of the max value using ctrl

code: WidgetArgsType & SupportDynamicSliderMaxValue &40; const TAttribute< bool > & InAttribute &41;


description: Tell us if we want to support dynamically changing of the min value using ctrl

code: WidgetArgsType & SupportDynamicSliderMinValue &40; const TAttribute< bool > & InAttribute &41;


description: Provide custom type conversion functionality to this spin box

code: WidgetArgsType & TypeInterface &40; TSharedPtr< INumericTypeInterface< NumericType > > InArg &41;


description: The value to display

code: WidgetArgsType & Value &40; const TAttribute< NumericType > & InAttribute &41;


description: Step to increment or decrement the value by when scrolling the mouse wheel. If not specified will determine automatically

code: WidgetArgsType & WheelStep &40; const TAttribute< TOptional< NumericType > > & InAttribute &41;


code: typedef FArguments WidgetArgsType


code: struct FArguments : public [TSlateBaseNamedArgs< SSpinBox< NumericType > >](API\Runtime\SlateCore\Widgets\TSlateBaseNamedArgs)


className: FOnDynamicSliderMinMaxValueChanged

description: Notification when the max/min spinner values are changed (only apply if SupportDynamicSliderMaxValue or SupportDynamicSliderMinValue are true)

code: typedef TBaseDelegate_FourParams< void, NumericType, [TWeakPtr](API\Runtime\Core\Templates\TWeakPtr)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) >, bool, bool > FOnDynamicSliderMinMaxValueChanged


className: FOnValueChanged

description: Notification for numeric value change

code: typedef TBaseDelegate_OneParam< void, NumericType > FOnValueChanged


description: Calculates range fraction. Possible to use on full numeric range

code: static float Fraction ( double InValue, double InMinValue, double InMaxValue )


description: See the AlwaysUsesDeltaSnap attribute

code: bool GetAlwaysUsesDeltaSnap() const


description: See the Delta attribute

code: NumericType GetDelta() const


description: See the EnableSlider attribute

code: bool GetEnableSlider() const


description: See the MaxFractionalDigits attribute

code: int32 GetMaxFractionalDigits() const


code: NumericType GetMaxSliderValue() const


description: See the MaxValue attribute

code: NumericType GetMaxValue() const


description: See the MinDesiredWidth attribute

code: float GetMinDesiredWidth() const


code: NumericType GetMinSliderValue() const


description: See the MinFractionalDigits attribute

code: int32 GetMinFractionalDigits() const


className: FOnValueCommitted

description: Notification for numeric value committed

code: typedef TBaseDelegate_TwoParams< void, NumericType, [ETextCommit::Type](API\Runtime\SlateCore\Types\ETextCommit__Type) > FOnValueCommitted


description: See the MinValue attribute

code: NumericType GetMinValue() const


description: See the SliderExponent attribute

code: float GetSliderExponent() const


description: See the Value attribute

code: NumericType GetValue() const


description: the value being observed by the spinbox as a string


description: the value being observed by the spinbox asFText- todo: spinboxFTextsupport (reimplement me)


description: Return the Value attribute

code: [TAttribute](API\Runtime\Core\Misc\TAttribute)< NumericType > GetValueAttribute() const


code: const [FSpinBoxStyle](API\Runtime\SlateCore\Styling\FSpinBoxStyle) * GetWidgetStyle() const


description:
Checks to see if this widget currently has the keyboard focus
True if this widget has keyboard focus

code: virtual bool HasKeyboardFocus() const


description: true when we are in keyboard-based input mode; false otherwise

code: bool IsInTextMode() const


description: See the MaxSliderValue attribute

code: bool IsMaxSliderValueBound() const


description: See the MinSliderValue attribute

code: bool IsMinSliderValueBound() const


code: void NotifyValueCommitted ( NumericType CurrentValue ) const


description: 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.

code: 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


description:
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

code: virtual [FReply](API\Runtime\SlateCore\Input\FReply) OnFocusReceived ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FFocusEvent](API\Runtime\SlateCore\Input\FFocusEvent) & InFocusEvent )


description:
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

code: virtual [FReply](API\Runtime\SlateCore\Input\FReply) OnKeyDown ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FKeyEvent](API\Runtime\SlateCore\Input\FKeyEvent) & InKeyEvent )


description:
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.

code: virtual [FReply](API\Runtime\SlateCore\Input\FReply) OnMouseButtonDown ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FPointerEvent](API\Runtime\SlateCore\Input\FPointerEvent) & MouseEvent )


description:
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.

code: virtual [FReply](API\Runtime\SlateCore\Input\FReply) OnMouseButtonUp ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FPointerEvent](API\Runtime\SlateCore\Input\FPointerEvent) & MouseEvent )


description:
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.

code: virtual [FReply](API\Runtime\SlateCore\Input\FReply) OnMouseMove ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FPointerEvent](API\Runtime\SlateCore\Input\FPointerEvent) & MouseEvent )


description:
Called when the mouse wheel is spun. This event is bubbled.
Returns whether the event was handled, along with other possible actions

code: virtual [FReply](API\Runtime\SlateCore\Input\FReply) OnMouseWheel ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FPointerEvent](API\Runtime\SlateCore\Input\FPointerEvent) & MouseEvent )


description:
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.

code: 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


code: void SetDelta ( NumericType InDelta )


code: void SetAlwaysUsesDeltaSnap ( bool bNewValue )


code: void SetEnableSlider ( bool bNewValue )


code: void SetMaxFractionalDigits ( const [TAttribute](API\Runtime\Core\Misc\TAttribute)< [TOptional](API\Runtime\Core\IO\TOptional)< int32 >> & InMaxFractionalDigits )


code: void SetMaxSliderValue ( const [TAttribute](API\Runtime\Core\Misc\TAttribute)< [TOptional](API\Runtime\Core\IO\TOptional)< NumericType >> & InMaxSliderValue )


code: void SetMaxValue ( const [TAttribute](API\Runtime\Core\Misc\TAttribute)< [TOptional](API\Runtime\Core\IO\TOptional)< NumericType >> & InMaxValue )


code: void SetMinDesiredWidth ( const [TAttribute](API\Runtime\Core\Misc\TAttribute)< float > & InMinDesiredWidth )


code: void SetMinFractionalDigits ( const [TAttribute](API\Runtime\Core\Misc\TAttribute)< [TOptional](API\Runtime\Core\IO\TOptional)< int32 >> & InMinFractionalDigits )


code: void SetMinSliderValue ( const [TAttribute](API\Runtime\Core\Misc\TAttribute)< [TOptional](API\Runtime\Core\IO\TOptional)< NumericType >> & InMinSliderValue )


code: void SetSliderExponent ( const [TAttribute](API\Runtime\Core\Misc\TAttribute)< float > & InSliderExponent )


code: void SetTextBlockFont ( [FSlateFontInfo](API\Runtime\SlateCore\Fonts\FSlateFontInfo) InFont )


code: void SetTextClearKeyboardFocusOnCommit ( bool bNewValue )


code: void SetTextSelectAllTextOnCommit ( bool bNewValue )


code: void SetValue ( const [TAttribute](API\Runtime\Core\Misc\TAttribute)< NumericType > & InValueAttribute )


code: void SetMinValue ( const [TAttribute](API\Runtime\Core\Misc\TAttribute)< [TOptional](API\Runtime\Core\IO\TOptional)< NumericType >> & InMinValue )


code: void SetWidgetStyle ( const [FSpinBoxStyle](API\Runtime\SlateCore\Styling\FSpinBoxStyle) * InStyle )


description:
Checks to see if this widget supports keyboard focus. Override this in derived classes.
True if this widget can take keyboard focus

code: virtual bool SupportsKeyboardFocus() const


description: Invoked when the text in the text field changes

code: void TextField_OnTextChanged ( const [FText](API\Runtime\Core\Internationalization\FText) & NewText )


description: Invoked when the text field commits its text.

code: void TextField_OnTextCommitted ( const [FText](API\Runtime\Core\Internationalization\FText) & NewText, [ETextCommit::Type](API\Runtime\SlateCore\Types\ETextCommit__Type) CommitInfo )


code: void SetTextJustification ( [ETextJustify::Type](API\Runtime\Slate\Framework\Text\ETextJustify__Type) InJustification )


className: SSpinBox

description: A Slate SpinBox resembles traditional spin boxes in that it is a widget that provides keyboard-based and mouse-based manipulation of a numeric value. Mouse-based manipulation: drag anywhere on the spinbox to change the value. Keyboard-based manipulation: click on the spinbox to enter text mode.

code: template<typename NumericType> class SSpinBox : public [SCompoundWidget](API\Runtime\SlateCore\Widgets\SCompoundWidget)


description: Cancels any open requests to toggle a sub-menu

code: void CancelPendingSubMenu()


code: void Construct ( const [FArguments](API\Runtime\Slate\Widgets\Input\SSubMenuHandler\FArguments) & InArgs, [TWeakPtr](API\Runtime\Core\Templates\TWeakPtr)< [SMenuOwner](API\Runtime\Slate\Widgets\Layout\SMenuOwner) > InMenuOwner )


code: NamedSlotProperty< FArguments > Content&40;&41;


code: WidgetArgsType & MenuAnchor &40; TSharedPtr< SMenuAnchor > InArg &41;


code: WidgetArgsType & MenuContent &40; TSharedPtr< SWidget > InArg &41;


code: WidgetArgsType & OnGetMenuContent &40; const FOnGetContent & InDelegate &41;


code: FArguments & operator&91;&93; &40; const TSharedRef< SWidget > & InChild &41;


code: WidgetArgsType & Placement &40; const TAttribute< EMenuPlacement > & InAttribute &41;


code: typedef FArguments WidgetArgsType


description: Returns TRUE if the sub-menu is open

code: bool IsSubMenuOpen() const


description: Returns TRUE if there is a sub-menu available for this item

code: bool HasSubMenu() const


code: struct FArguments : public [TSlateBaseNamedArgs< SSubMenuHandler >](API\Runtime\SlateCore\Widgets\TSlateBaseNamedArgs)


description: The system will use this event to notify a widget that the cursor has entered it. This event is uses a custom bubble strategy.

code: virtual void OnMouseEnter ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FPointerEvent](API\Runtime\SlateCore\Input\FPointerEvent) & MouseEvent )


description: The system will use this event to notify a widget that the cursor has left it. This event is uses a custom bubble strategy.

code: virtual void OnMouseLeave ( const [FPointerEvent](API\Runtime\SlateCore\Input\FPointerEvent) & MouseEvent )


description: Requests that the sub-menu associated with this widget be toggled on or off. It does not immediately toggle the menu. After a set amount of time is passed the menu will toggle

code: void RequestSubMenuToggle ( bool bOpenMenu, const bool bClobber, const bool bImmediate )


description: One-off delayed active timer to update the open/closed state of the sub menu.

code: EActiveTimerReturnType UpdateSubMenuState ( double InCurrentTime, float InDeltaTime, bool bWantsOpen )


description: Returns whether or the sub-menu entry should appear hovered. If the sub-menu is open we will always show the menu as hovered to indicate which sub-menu is open In the case that the user is interacting in this menu we do not show the menu as hovered because we need to show what the user is actually selecting

code: bool ShouldSubMenuAppearHovered() const


description: Clears the list of suggestions and hides the suggestions list.

code: void ClearSuggestions()


className: SSubMenuHandler

description: Wrapper for any widget that is used in a table view that wants to handle sub-menus with the same functionality as a normal multibox menu

code: class SSubMenuHandler : public [SCompoundWidget](API\Runtime\SlateCore\Widgets\SCompoundWidget)

ActiveTimerHandle

type: TWeakPtr< FActi...

description: The handle to the active timer to update the sub-menu state

MenuAnchor

type: TWeakPtr<SMenu...

description: For pull-down or sub-menu entries, this stores a weak reference to the menu anchor widget that we'll use to summon the menu

MenuOwnerWidget

type: TWeakPtr< class...

description: Weak reference back to the MenuOwner widget that owns us


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

code: void Construct ( const [FArguments](API\Runtime\Slate\Widgets\Input\SSuggestionTextBox\FArguments) & InArgs )


description: The color of the background/border around the editable text.

code: WidgetArgsType & BackgroundColor &40; const TAttribute< FSlateColor > & InAttribute &41;


description: Whether to clear keyboard focus when pressing enter to commit changes.

code: WidgetArgsType & ClearKeyboardFocusOnCommit &40; const TAttribute< bool > & InAttribute &41;


description: The image of the background/border around the editable text.

code: WidgetArgsType & BackgroundImage &40; const FSlateBrush &42; InArg &41;


description: Font color and opacity.

code: WidgetArgsType & Font &40; const TAttribute< FSlateFontInfo > & InAttribute &41;


description: Provides an alternative mechanism for error reporting.

code: WidgetArgsType & ErrorReporting &40; TSharedPtr< class IErrorReportingWidget > InArg &41;


description: Hint text that appears when there is no text in the text box.

code: WidgetArgsType & HintText &40; const TAttribute< FText > & InAttribute &41;


description: Workaround as we loose focus when the auto completion closes.

code: WidgetArgsType & IsCaretMovedWhenGainFocus &40; const TAttribute< bool > & InAttribute &41;


description: Minimum width that a text block should be.

code: WidgetArgsType & MinDesiredWidth &40; const TAttribute< float > & InAttribute &41;


description: Called before the history list is shown.

code: WidgetArgsType & OnShowingHistory &40; const FOnShowingHistory & InDelegate &41;


description: Called before the suggestion list is shown.

code: WidgetArgsType & OnShowingSuggestions &40; const FOnShowingSuggestions & InDelegate &41;


description: Called when the text has been committed.

code: WidgetArgsType & OnTextCommitted &40; const FOnTextCommitted & InDelegate &41;


description: Called whenever the text is changed programmatically or interactively by the user.

code: WidgetArgsType & OnTextChanged &40; const FOnTextChanged & InDelegate &41;


description: Whether to allow the user to back out of changes when they press the escape key.

code: WidgetArgsType & RevertTextOnEscape &40; const TAttribute< bool > & InAttribute &41;


description: Whether to select all text when pressing enter to commit changes.

code: WidgetArgsType & SelectAllTextOnCommit &40; const TAttribute< bool > & InAttribute &41;


description: Whether to select all text when the user clicks to give focus on the widget.

code: WidgetArgsType & SelectAllTextWhenFocused &40; const TAttribute< bool > & InAttribute &41;


description: The maximum height of the suggestion list.

code: WidgetArgsType & SuggestionListMaxHeight &40; const TAttribute< float > & InAttribute &41;


description: The styling of the suggestion text.

code: WidgetArgsType & SuggestionTextStyle &40; const FTextBlockStyle &42; InArg &41;


description: The styling of the text box.

code: WidgetArgsType & TextStyle &40; const FEditableTextBoxStyle &42; InArg &41;


code: typedef FArguments WidgetArgsType


description: Sets the text content for this editable text box widget.

code: WidgetArgsType & Text &40; const TAttribute< FText > & InAttribute &41;


description: Text color and opacity.

code: WidgetArgsType & ForegroundColor &40; const TAttribute< FSlateColor > & InAttribute &41;


description: Sets the keyboard focus to the text box.

code: void FocusTextBox()


code: struct FArguments : public [TSlateBaseNamedArgs< SSuggestionTextBox >](API\Runtime\SlateCore\Widgets\TSlateBaseNamedArgs)


description:
Gets the string value of the currently selected suggestion.
Suggestion string, or empty if no suggestion is selected.


description:
Returns the text string.
The text string.


description: Highlights the selected suggestion in the suggestion list.

code: void MarkActiveSuggestion()


description: Called when this widget loses focus. This event does not bubble.

code: virtual void OnFocusLost ( const [FFocusEvent](API\Runtime\SlateCore\Input\FFocusEvent) & InFocusEvent )


description:
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

code: virtual [FReply](API\Runtime\SlateCore\Input\FReply) OnKeyDown ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FKeyEvent](API\Runtime\SlateCore\Input\FKeyEvent) & InKeyEvent )


description: Sets the list of suggestions.

code: void SetSuggestions ( [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & SuggestionStrings, bool InHistoryMode )


description: Sets the text string currently being edited

code: void SetText ( const [TAttribute](API\Runtime\Core\Misc\TAttribute)< [FText](API\Runtime\Core\Internationalization\FText) > & InNewText )


description: If InError is a non-empty string the TextBox will the ErrorReporting provided during construction. If no error reporting was provided, the TextBox will create a default error reporter.

code: void SetError ( const [FString](API\Runtime\Core\Containers\FString) & InError )


description:
Checks to see if this widget supports keyboard focus. Override this in derived classes.
True if this widget can take keyboard focus

code: virtual bool SupportsKeyboardFocus() const


description: Default constructor.

code: SSuggestionTextBox()


className: SSuggestionTextBox

description: Implements an editable text box that can show auto-complete histories and suggestions lists.

code: class SSuggestionTextBox : public [SCompoundWidget](API\Runtime\SlateCore\Widgets\SCompoundWidget)


description: Clears the selected item in the text combo

code: void ClearSelection()


code: void Construct ( const [FArguments](API\Runtime\Slate\Widgets\Input\STextComboBox\FArguments) & InArgs )


description: The visual style of the button part of the combo box (overrides ComboBoxStyle)

code: WidgetArgsType & ButtonStyle &40; const FButtonStyle &42; InArg &41;


description: Text color and opacity

code: WidgetArgsType & ColorAndOpacity &40; const TAttribute< FSlateColor > & InAttribute &41;


code: WidgetArgsType & ComboBoxStyle &40; const FComboBoxStyle &42; InArg &41;


description: Visual padding of the button content for the combobox

code: WidgetArgsType & ContentPadding &40; const TAttribute< FMargin > & InAttribute &41;


description: Sets the font used to draw the text

code: WidgetArgsType & Font &40; const TAttribute< FSlateFontInfo > & InAttribute &41;


description: Called when the combo box is opened

code: WidgetArgsType & OnComboBoxOpening &40; const FOnComboBoxOpening & InDelegate &41;


description: Called when combo box needs to establish selected item

code: WidgetArgsType & InitiallySelectedItem &40; TSharedPtr< FString > InArg &41;


description: [Optional] Called to get the label for the currently selected item

code: WidgetArgsType & OnGetTextLabelForItem &40; const FGetTextComboLabel & InDelegate &41;


description: Called when the text is chosen.

code: WidgetArgsType & OnSelectionChanged &40; const FOnTextSelectionChanged & InDelegate &41;


code: typedef FArguments WidgetArgsType


description: Selection of strings to pick from

code: WidgetArgsType & OptionsSource &40; TArray< TSharedPtr< FString > > &42; InArg &41;


code: struct FArguments : public [TSlateBaseNamedArgs< STextComboBox >](API\Runtime\SlateCore\Widgets\TSlateBaseNamedArgs)


className: FGetTextComboLabel

code: typedef TBaseDelegate_OneParam< [FString](API\Runtime\Core\Containers\FString), [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FString](API\Runtime\Core\Containers\FString) > > FGetTextComboLabel


className: FOnTextSelectionChanged

code: typedef TSlateDelegates< [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FString](API\Runtime\Core\Containers\FString) > >::FOnSelectionChanged FOnTextSelectionChanged


description: Returns the currently selected text string

code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FString](API\Runtime\Core\Containers\FString) > GetSelectedItem()


description: Request to reload the text options in the combobox from the OptionsSource attribute

code: void RefreshOptions()


description: Called to create a widget for each string

code: [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) > MakeItemWidget ( [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FString](API\Runtime\Core\Containers\FString) > StringItem )


code: void SetSelectedItem ( [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FString](API\Runtime\Core\Containers\FString) > NewSelection )


className: STextComboBox

description: A combo box that shows text content.

code: class STextComboBox : public [SCompoundWidget](API\Runtime\SlateCore\Widgets\SCompoundWidget)


code: void Construct ( const [FArguments](API\Runtime\Slate\Widgets\Input\STextComboPopup\FArguments) & InArgs )


description: When set, this widget will automatically attempt to set focus to itself when it is created, or when its owner window is activated

code: WidgetArgsType & AutoFocus &40; bool InArg &41;


description: Label, placed before combo box

code: WidgetArgsType & Label &40; FText InArg &41;


description: Called when the text is chosen.

code: WidgetArgsType & OnTextChosen &40; const FOnTextChosen & InDelegate &41;


description: Selection of strings to pick from

code: WidgetArgsType & TextOptions &40; TArray< FString > InArg &41;


code: struct FArguments : public [TSlateBaseNamedArgs< STextComboPopup >](API\Runtime\SlateCore\Widgets\TSlateBaseNamedArgs)


description: SWidgetinterface

code: virtual [FReply](API\Runtime\SlateCore\Input\FReply) OnKeyDown ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FKeyEvent](API\Runtime\SlateCore\Input\FKeyEvent) & InKeyEvent )


description: Called when 'OK' button is pressed


description: Focuses the control on the OK button

code: void FocusDefaultWidget()


className: STextComboPopup

description: Simple box containing a combobox of strings to pick from, usually used within a MenuStack

code: class STextComboPopup : public [SCompoundWidget](API\Runtime\SlateCore\Widgets\SCompoundWidget)

OkButton

type: TSharedPtr<SBu...

description: The OK button

OnTextChosen

type: FOnTextChosen

description: Delegate to call when OK button is pressed

StringCombo

type: TSharedPtr< SCo...

description: The combo box

Strings

type: TArray<TShared...

description: Array of shared pointers to strings so combo widget can work on them


code: void Construct ( const [FArguments](API\Runtime\Slate\Widgets\Input\STextEntryPopup\FArguments) & InArgs )


description: Whether to clear keyboard focus when pressing enter to commit changes

code: WidgetArgsType & ClearKeyboardFocusOnCommit &40; const TAttribute< bool > & InAttribute &41;


description: Test to place into text entry box before anything is typed

code: WidgetArgsType & DefaultText &40; FText InArg &41;


description: Provide a alternative mechanism for error reporting.

code: WidgetArgsType & ErrorReporting &40; TSharedPtr< class IErrorReportingWidget > InArg &41;


description: Hint text that appears when there is no text in the text box

code: WidgetArgsType & HintText &40; const TAttribute< FText > & InAttribute &41;


description: Label, placed before text entry box


description: Called whenever the text is changed programmatically or interactively by the user

code: WidgetArgsType & OnTextChanged &40; const FOnTextChanged & InDelegate &41;


description: The maximum width for text entry

code: WidgetArgsType & MaxWidth &40; const TAttribute< float > & InAttribute &41;


description: Called when the text is committed.

code: WidgetArgsType & OnTextCommitted &40; const FOnTextCommitted & InDelegate &41;


description: Whether to select all text when the user clicks to give focus on the widget

code: WidgetArgsType & SelectAllTextWhenFocused &40; bool InArg &41;


code: WidgetArgsType & OnVerifyTextChanged &40; const FOnVerifyTextChanged & InDelegate &41;


code: typedef FArguments WidgetArgsType


code: struct FArguments : public [TSlateBaseNamedArgs< STextEntryPopup >](API\Runtime\SlateCore\Widgets\TSlateBaseNamedArgs)


description: the widget that we want to be focused when the popup is shown


description: If InError is a non-empty string the TextBox will use the ErrorReporting widget provided during construction If no error reporting was provided, the TextBox will create a default error reporter.

code: void SetError ( const [FText](API\Runtime\Core\Internationalization\FText) & InError )


code: void SetError ( const [FString](API\Runtime\Core\Containers\FString) & InError )


className: STextEntryPopup

description: Simple text entry popup, usually used within a MenuStack

code: class STextEntryPopup : public [SCompoundWidget](API\Runtime\SlateCore\Widgets\SCompoundWidget)

Box

type: TSharedPtr<SVe...

description: Allows for inserting additional widgets that extend the functionality of the Popup

ErrorReporting

type: TSharedPtr< cla...

description: SomeWidget used for error reporting


code: void AddControl ( const [FControlInfo](API\Runtime\Slate\Widgets\Input\SVirtualJoystick\FControlInfo) & Control )


code: static void AlignBoxIntoScreen ( FVector2D & Position, const FVector2D & Size, const FVector2D & ScreenSize )


code: FVector2D ComputeThumbPosition ( int32 ControlIndex, const FVector2D & LocalCoord, float * OutDistanceToTouchSqr, float * OutDistanceToEdgeSqr )


description: LeafWidgets should compute their DesiredSize based solely on their visual representation. There is no need to take child widgets into account as LeafWidgets have none by definition. For example, the TextBlock widget simply measures the area necessary to display its text with the given font and font size.

code: virtual FVector2D ComputeDesiredSize ( float ) const


code: void Construct ( const [FArguments](API\Runtime\Slate\Widgets\Input\SVirtualJoystick\FArguments) & InArgs )


className: EVirtualJoystickState

code: enum EVirtualJoystickState { State_Active, State_CountingDownToInactive, State_CountingDownToReset, State_Inactive, State_WaitForStart, State_CountingDownToStart, }


className: FArguments

code: struct FArguments : public [TSlateBaseNamedArgs< SVirtualJoystick >](API\Runtime\SlateCore\Widgets\TSlateBaseNamedArgs)


description: Reset the control to a centered/inactive state

code: void Reset&40;&41;


className: FControlData

description: The settings and current state of each zone we render

code: struct FControlData

bHasBeenPositioned

type: bool

description: Whether or not we need position the control against the geometry

bNeedUpdatedCenter

description: Whether or not to update center position

bSendOneMoreEvent

description: Whether or not to send one last "release" event next tick

CapturedPointerIndex

description: Which pointer index is interacting with this control right now, or -1 if not interacting

CorrectedCenter

description: The corrected actual center of the control

CorrectedInputScale

description: The corrected scale for control input

CorrectedInteractionSize

description: The corrected size of a the interactable area around Center

CorrectedThumbSize

description: The corrected size of the thumb that can be re-centered within InteractionSize area

CorrectedVisualSize

description: The corrected size of a joystick that can be re-centered within InteractionSize area

ElapsedTime

description: Time to activate joystick

Info

type: FControlInfo

description: Control settings

NextCenter

description: Visual center to be updated

ThumbPosition

description: The position of the thumb, in relation to the VisualCenter

VisualCenter

description: For recentered joysticks, this is the re-center location


className: FControlInfo

description: The settings of each zone we render

code: struct FControlInfo

AltInputKey

type: FKey

description: The secondary input (for sticks, this is the vertical/Y input, unused for buttons)

bTreatAsButton

description: If true, this joystick will be treated as a simple press-release button

Center

description: The actual center of the control

type: TSharedPtr<ISl...

description: The brush to use to draw the background for joysticks, or unclicked for buttons

description: The brush to use to draw the thumb for joysticks, or clicked for buttons

InputScale

description: The scale for control input

InteractionSize

description: The size of a the interactable area around Center

MainInputKey

description: The input to send from this control (for sticks, this is the horizontal/X input)

ThumbSize

description: The size of the thumb that can be re-centered within InteractionSize area

VisualSize

description: The size of a joystick that can be re-centered within InteractionSize area


description: Callback for handling display metrics changes.

code: virtual void HandleDisplayMetricsChanged ( const [FDisplayMetrics](API\Runtime\ApplicationCore\GenericPlatform\FDisplayMetrics) & NewDisplayMetric )


description:
Process a touch event (on movement and possibly on initial touch)
true if the touch was successful

code: virtual bool HandleTouch ( int32 ControlIndex, const FVector2D & LocalCoord, const FVector2D & ScreenSize )


description: Whenever possible, LeafWidgets should avoid dealing with layout properties. See TextBlock for an example.

code: 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


description: Called when a touchpad touch is moved (finger moved)

code: virtual [FReply](API\Runtime\SlateCore\Input\FReply) OnTouchMoved ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FPointerEvent](API\Runtime\SlateCore\Input\FPointerEvent) & InTouchEvent )


description: Called when a touchpad touch is ended (finger lifted)

code: virtual [FReply](API\Runtime\SlateCore\Input\FReply) OnTouchEnded ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FPointerEvent](API\Runtime\SlateCore\Input\FPointerEvent) & InTouchEvent )


code: void SetControls ( const [TArray](API\Runtime\Core\Containers\TArray)< [FControlInfo](API\Runtime\Slate\Widgets\Input\SVirtualJoystick\FControlInfo) > & InControls )


description: Called when a touchpad touch is started (finger down)

code: virtual [FReply](API\Runtime\SlateCore\Input\FReply) OnTouchStarted ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FPointerEvent](API\Runtime\SlateCore\Input\FPointerEvent) & InTouchEvent )


description: Sets parameters that control all controls

code: void SetGlobalParameters ( float InActiveOpacity, float InInactiveOpacity, float InTimeUntilDeactive, float InTimeUntilReset, float InActivationDelay, bool InbPreventReCenter, float InStartupDelay )


description: Return the target opacity to lerp to given the current state

code: float GetBaseOpacity()


description: Shows or hides the controls (for instance during cinematics)

code: void SetJoystickVisibility ( const bool bVisible, const bool bFade )


description:
Checks to see if this widget supports keyboard focus. Override this in derived classes.
True if this widget can take keyboard focus

code: virtual bool SupportsKeyboardFocus() const


description: Static function to return if external users should create/activate/etc a touch interface Note that this function is also used internally, so even if this returns false but anSVirtualJoystickis created, it won't actually show any controls


className: TControlArray

description: TArrayspecialization for controls. In the game only few joysticks presented so we can predict their count and store in memory in more efficient way

code: typedef [TArray](API\Runtime\Core\Containers\TArray)< T, TInlineAllocator< 2 >> TControlArray


description: Ticks this widget with Geometry. Override in derived classes, but always call the parent implementation.

code: virtual void Tick ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & AllottedGeometry, const double InCurrentTime, const float InDeltaTime )


className: SVirtualJoystick

description: A virtual joystsick

code: class SVirtualJoystick : public [SLeafWidget](API\Runtime\SlateCore\Widgets\SLeafWidget)

ActivationDelay

type: float

ActiveOpacity

description: Global settings from theUTouchInterface

bCenterOnEvent

type: uint32: 1

description: If true, this zone will have it's "center" set when you touch it, otherwise the center will be set to the center of the zone

bPreventReCenter

description: If true, ignore re-centering

bVisible

description: True if the joystick should be visible

Controls

type: TControlArray< ...

description: List of controls set by theUTouchInterface

Countdown

description: Countdown until next state change

CurrentOpacity

description: Target opacity

PreviousScalingFactor

description: Last used scaling value for

State

type: EVirtualJoystic...

description: The current state of all controls


description:
Computes the desired size of this widget (SWidget)
The widget's desired size

code: virtual FVector2D ComputeDesiredSize ( float ) const


description: Construct this widget

code: void Construct ( const [FArguments](API\Runtime\Slate\Widgets\Input\SVirtualKeyboardEntry\FArguments) & InArgs )


description: Whether to clear keyboard focus when pressing enter to commit changes

code: WidgetArgsType & ClearKeyboardFocusOnCommit &40; const TAttribute< bool > & InAttribute &41;


description: Text color and opacity

code: WidgetArgsType & ColorAndOpacity &40; const TAttribute< FSlateColor > & InAttribute &41;


description: Sets the font used to draw the text

code: WidgetArgsType & Font &40; const TAttribute< FSlateFontInfo > & InAttribute &41;


description: The text that appears when there is nothing typed into the search box

code: WidgetArgsType & HintText &40; const TAttribute< FText > & InAttribute &41;


description: Sets the text content for this editable text widget

code: WidgetArgsType & KeyboardType &40; const TAttribute< EKeyboardType > & InAttribute &41;


description: Minimum width that a text block should be

code: WidgetArgsType & MinDesiredWidth &40; const TAttribute< float > & InAttribute &41;


description: Called whenever the text is changed programmatically or interactively by the user

code: WidgetArgsType & OnTextChanged &40; const FOnTextChanged & InDelegate &41;


description: Called whenever the text is committed. This happens when the user presses enter or the text box loses focus.

code: WidgetArgsType & OnTextCommitted &40; const FOnTextCommitted & InDelegate &41;


code: WidgetArgsType & Text &40; const TAttribute< FText > & InAttribute &41;


description: Sets additional arguments to be used by the virtual keyboard summoned by this widget

code: WidgetArgsType & VirtualKeyboardOptions &40; FVirtualKeyboardOptions InArg &41;


description: Sets whether this text box can actually be modified interactively by the user

code: WidgetArgsType & IsReadOnly &40; const TAttribute< bool > & InAttribute &41;


className: WidgetArgsType

code: typedef FArguments WidgetArgsType


description:
Returns the hint text.
HintText

code: virtual [FText](API\Runtime\Core\Internationalization\FText) GetHintText() const


code: struct FArguments : public [TSlateBaseNamedArgs< SVirtualKeyboardEntry >](API\Runtime\SlateCore\Widgets\TSlateBaseNamedArgs)


description: Whether the user can edit the text.

code: bool GetIsReadOnly() const


code: virtual bool GetSelection ( int & OutSelStart, int & OutSelEnd )


description: Returns additional virtual keyboard options


description:
Returns the text.
Text

code: virtual [FText](API\Runtime\Core\Internationalization\FText) GetText() const


description:
Returns the virtual keyboard type.
VirtualKeyboardType

code: virtual EKeyboardType GetVirtualKeyboardType() const


description: whether the current text varies from the original

code: bool HasTextChangedFromOriginal() const


description: Called when this widget loses the keyboard focus. This event does not bubble.

code: virtual void OnFocusLost ( const [FFocusEvent](API\Runtime\SlateCore\Input\FFocusEvent) & InFocusEvent )


description:
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

code: virtual [FReply](API\Runtime\SlateCore\Input\FReply) OnFocusReceived ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FFocusEvent](API\Runtime\SlateCore\Input\FFocusEvent) & InFocusEvent )


description: Restores the text to the original state

code: void RestoreOriginalText()


description:
Returns whether the entry is multi-line
Whether the entry is multi-line

code: virtual bool IsMultilineEntry() const


description: Sets the font used to draw the text

code: void SetFont ( const [TAttribute](API\Runtime\Core\Misc\TAttribute)< [FSlateFontInfo](API\Runtime\SlateCore\Fonts\FSlateFontInfo) > & InNewFont )


description: Whenever possible, LeafWidgets should avoid dealing with layout properties. See TextBlock for an example.

code: 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


code: virtual void SetSelectionFromVirtualKeyboard ( int InSelStart, int InSelEnd )


description: Sets the text currently being edited

code: void SetText ( const [TAttribute](API\Runtime\Core\Misc\TAttribute)< [FText](API\Runtime\Core\Internationalization\FText) > & InNewText )


description:
Checks to see if this widget supports keyboard focus. Override this in derived classes.
True if this widget can take keyboard focus

code: virtual bool SupportsKeyboardFocus() const


description: Sets the text to that entered by the virtual keyboard

code: virtual void SetTextFromVirtualKeyboard ( const [FText](API\Runtime\Core\Internationalization\FText) & InNewText, ETextEntryType TextEntryType )


description: Constructor

code: SVirtualKeyboardEntry()


description: Ticks this widget. Override in derived classes, but always call the parent implementation.

code: virtual void Tick ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & AllottedGeometry, const double InCurrentTime, const float InDeltaTime )


description: Construct the widget

code: void Construct ( const [SVolumeControl::FArguments](API\Runtime\Slate\Widgets\Input\SVolumeControl\FArguments) & InDeclaration )


className: ESpeakerIcon

code: enum ESpeakerIcon { ES_Full, ES_Mid, ES_Low, ES_Off, ES_Muted, ES_MAX, }


className: SVirtualKeyboardEntry

code: class SVirtualKeyboardEntry : public [SLeafWidget](API\Runtime\SlateCore\Widgets\SLeafWidget), public [IVirtualKeyboardEntry](API\Runtime\Slate\Widgets\Input\IVirtualKeyboardEntry)


description: The mute state to display

code: WidgetArgsType & Muted &40; const TAttribute< bool > & InAttribute &41;


description: Called when the mute state is changed by clicking the button

code: WidgetArgsType & OnMuteChanged &40; const FOnMuted & InDelegate &41;


description: Called when the volume is changed by slider or muting

code: WidgetArgsType & OnVolumeChanged &40; const FOnFloatValueChanged & InDelegate &41;


description: The style to use to draw this volume control

code: WidgetArgsType & Style &40; const FVolumeControlStyle &42; InArg &41;


description: The volume to display

code: WidgetArgsType & Volume &40; const TAttribute< float > & InAttribute &41;


code: typedef FArguments WidgetArgsType


code: struct FArguments : public [TSlateBaseNamedArgs< SVolumeControl >](API\Runtime\SlateCore\Widgets\TSlateBaseNamedArgs)


className: FOnMuted

code: typedef TBaseDelegate_OneParam< void, bool > FOnMuted


className: SVolumeControl

description: A Slate VolumeControl is a mute icon/button and volume slider.

code: class SVolumeControl : public [SCompoundWidget](API\Runtime\SlateCore\Widgets\SCompoundWidget)


className: DefaultMaxFractionalDigits

description: The default maximum fractional digits

code: static const int32 DefaultMaxFractionalDigits = 6;


className: DefaultMinFractionalDigits

description: The default minimum fractional digits

code: static const int32 DefaultMinFractionalDigits = 1;


code: virtual int32 GetMaxFractionalDigits() const


code: virtual [TOptional](API\Runtime\Core\IO\TOptional)< NumericType > FromString ( const [FString](API\Runtime\Core\Containers\FString) & InString, const NumericType & InExistingValue )


description: Gets the minimum and maximum fractional digits.

code: virtual int32 GetMinFractionalDigits() const


description: Check whether the typed character is valid

code: virtual bool IsCharacterValid ( TCHAR InChar ) const


description: Sets the minimum and maximum fractional digits - A minimum greater than 0 will always have that many trailing zeros

code: virtual void SetMinFractionalDigits ( const [TAttribute](API\Runtime\Core\Misc\TAttribute)< [TOptional](API\Runtime\Core\IO\TOptional)< int32 >> & NewValue )


description: Convert the type to/from a string

code: virtual [FString](API\Runtime\Core\Containers\FString) ToString ( const NumericType & Value ) const


code: virtual void SetMaxFractionalDigits ( const [TAttribute](API\Runtime\Core\Misc\TAttribute)< [TOptional](API\Runtime\Core\IO\TOptional)< int32 >> & NewValue )


description: Attempt to parse a numeral with our units from the specified string.

code: virtual [TOptional](API\Runtime\Core\IO\TOptional)< NumericType > FromString ( const [FString](API\Runtime\Core\Containers\FString) & ValueString, const NumericType & InExistingValue )


className: TDefaultNumericTypeInterface

description: Default numeric type interface

code: template<typename NumericType> struct TDefaultNumericTypeInterface : public [INumericTypeInterface< NumericType >](API\Runtime\Slate\Widgets\Input\INumericTypeInterface)

MaxFractionalDigits

description: The current maximum fractional digits

MinFractionalDigits

description: The current minimum fractional digits


description: Check whether the specified typed character is valid


description: Set up this interface to use a fixed display unit based on the specified value

code: void SetupFixedDisplay ( const NumericType & InValue )


description: Convert this type to a string


description: Constructor

code: TNumericUnitTypeInterface ( EUnit InUnits )


className: TNumericUnitTypeInterface

description: Numeric interface that specifies how to interact with a number in a specific unit. Include NumericUnitTypeInterface.inl for symbol definitions.

code: template<typename NumericType> struct TNumericUnitTypeInterface : public [TDefaultNumericTypeInterface< NumericType >](API\Runtime\Slate\Widgets\Input\TDefaultNumericTypeInterface)

FixedDisplayUnits

type: TOptional< EUni...

description: Optional units that this type interface will be fixed on

UnderlyingUnits

type: const EUnit

description: The underlying units which the numeric type are specified in.


code: void Construct ( const [FArguments](API\Runtime\Slate\Widgets\LayerManager\STooltipPresenter\FArguments) & InArgs )


code: NamedSlotProperty< FArguments > Content&40;&41;


code: FArguments & operator&91;&93; &40; const TSharedRef< SWidget > & InChild &41;


code: typedef FArguments WidgetArgsType


code: struct FArguments : public [TSlateBaseNamedArgs< STooltipPresenter >](API\Runtime\SlateCore\Widgets\TSlateBaseNamedArgs)


description: Panels arrange their children in a space described by the AllottedGeometry parameter. The results of the arrangement should be returned by appending aFArrangedWidgetpair for every child widget. See StackPanel for an example

code: virtual void OnArrangeChildren &40; const FGeometry & AllottedGeometry, FArrangedChildren & ArrangedChildren &41; const


code: void SetContent ( [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) > InWidget )


description: Constructor

code: STooltipPresenter()


className: STooltipPresenter

description: Presents its content at the cursor's position. Tooltip avoids widget edges.

code: class STooltipPresenter : public [SPanel](API\Runtime\SlateCore\Widgets\SPanel)


code: namespace ESplitterResizeMode { enum Type { FixedPosition, FixedSize, Fill, } }


code: namespace EStretchDirection { enum Type { Both, DownOnly, UpOnly, } }


code: namespace EStretch { enum Type { None, Fill, ScaleToFit, ScaleToFitX, ScaleToFitY, ScaleToFill, ScaleBySafeZone, UserSpecified, UserSpecifiedWithClipping, } }


description: Returns true if the anchors represent a stretch along the horizontal axis

code: bool IsStretchedHorizontal() const


description: Returns true if the anchors represent a stretch along the vertical axis

code: bool IsStretchedVertical() const