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: Play the hovered sound

module: Slate

code: void PlayHoverSound() const


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


description: Play the pressed sound

code: void PlayPressedSound() const


description: Press the button

code: virtual void Press()


description: Release the button

code: virtual void Release()


description: Set the AppearPressed look.

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


description: See ButtonStyle attribute

code: void SetButtonStyle ( const [FButtonStyle](API\Runtime\SlateCore\Styling\FButtonStyle) * ButtonStyle )


code: void SetClickMethod ( [EButtonClickMethod::Type](API\Runtime\SlateCore\Types\EButtonClickMethod__Type) InClickMethod )


description: See ContentPadding attribute

code: void SetContentPadding ( [TAttribute](API\Runtime\Core\Misc\TAttribute)< [FMargin](API\Runtime\SlateCore\Layout\FMargin) > InContentPadding )


description: See HoveredSound attribute

code: void SetHoveredSound ( [TOptional](API\Runtime\Core\IO\TOptional)< [FSlateSound](API\Runtime\SlateCore\Sound\FSlateSound) > InHoveredSound )


description: Set if this button can be focused

code: void SetIsFocusable ( bool bInIsFocusable )


description: See OnClicked event

code: void SetOnClicked ( FOnClicked InOnClicked )


description: Set OnHovered event

code: void SetOnHovered ( FSimpleDelegate InOnHovered )


description: Set OnUnhovered event

code: void SetOnUnhovered ( FSimpleDelegate InOnUnhovered )


description: See PressedSound attribute

code: void SetPressedSound ( [TOptional](API\Runtime\Core\IO\TOptional)< [FSlateSound](API\Runtime\SlateCore\Sound\FSlateSound) > InPressedSound )


code: void SetPressMethod ( [EButtonPressMethod::Type](API\Runtime\SlateCore\Types\EButtonPressMethod__Type) InPressMethod )


code: void SetTouchMethod ( [EButtonTouchMethod::Type](API\Runtime\SlateCore\Types\EButtonTouchMethod__Type) InTouchMethod )


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


className: SButton

description: Slate's Buttons are clickable Widgets that can contain arbitrary widgets as itsContent().

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


description: Rebuilds the checkbox based on the current ESlateCheckBoxType

code: void BuildCheckBox ( [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) > InContent )


description: Construct this widget

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


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


description: The background hovered image for the checkbox - overrides the style's

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


description: The background image for the checkbox - overrides the style's

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


description: The background pressed image for the checkbox - overrides the style's

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


description: Whether or not the content portion of the checkbox should layout using auto-width. When true the content will always be arranged at its desired size as opposed to resizing to the available space.

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


description: The color of the background border (set by the Style arg but the Style can be overridden with this)

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


description: The checked hovered image for the checkbox - overrides the style's

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


description: The checked image for the checkbox - overrides the style's

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


description: The checked pressed image for the checkbox - overrides the style's

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


description: Sets the rules to use for determining whether the button was clicked. This is an advanced setting and generally should be left as the default.

code: WidgetArgsType & ClickMethod &40; EButtonClickMethod::Type InArg &41;


description: Content to be placed next to the check box, or for a toggle button, the content to be placed inside the button

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


description: Foreground color for the checkbox's content and parts (set by the Style arg but the Style can be overridden with this)

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


description: How the content of the toggle button should align within the given space

code: WidgetArgsType & HAlign &40; EHorizontalAlignment InArg &41;


description: The sound to play when the check box is hovered

code: WidgetArgsType & HoveredSoundOverride &40; TOptional< FSlateSound > InArg &41;


description: The sound to play when the check box is checked

code: WidgetArgsType & CheckedSoundOverride &40; TOptional< FSlateSound > InArg &41;


description: Whether the check box is currently in a checked state

code: WidgetArgsType & IsChecked &40; const TAttribute< ECheckBoxState > & InAttribute &41;


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


description: Called when the checked state has changed

code: WidgetArgsType & OnCheckStateChanged &40; const FOnCheckStateChanged & InDelegate &41;


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


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


description: Spacing between the check box image and its content (set by the Style arg but the Style can be overridden with this)

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


description: How should the button be clicked with keyboard/controller button events?

code: WidgetArgsType & PressMethod &40; EButtonPressMethod::Type InArg &41;


description: The style structure for this checkbox' visual style

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


description: How should the button be clicked with touch events?

code: WidgetArgsType & TouchMethod &40; EButtonTouchMethod::Type InArg &41;


description: The unchecked hovered image for the checkbox - overrides the style's

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


description: Type of check box (set by the Style arg but the Style can be overridden with this)

code: WidgetArgsType & Type &40; TOptional< ESlateCheckBoxType::Type > InArg &41;


description: The unchecked image for the checkbox - overrides the style's

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


description: The unchecked pressed image for the checkbox - overrides the style's

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


description: The sound to play when the check box is unchecked

code: WidgetArgsType & UncheckedSoundOverride &40; TOptional< FSlateSound > InArg &41;


description: The undetermined image for the checkbox - overrides the style's

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


description: The undetermined hovered image for the checkbox - overrides the style's

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


description: The undetermined pressed image for the checkbox - overrides the style's

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


className: WidgetArgsType

code: typedef FArguments WidgetArgsType


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


className: FArguments

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


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


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


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


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


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


description: The current checked state of the checkbox.

code: ECheckBoxState GetCheckedState() const


description: Utility function to translate other input click methods to regular ones.

code: [TEnumAsByte](API\Runtime\Core\Containers\TEnumAsByte)< [EButtonClickMethod::Type](API\Runtime\SlateCore\Types\EButtonClickMethod__Type) > GetClickMethodFromInputType ( const [FPointerEvent](API\Runtime\SlateCore\Input\FPointerEvent) & MouseEvent ) const


description: the Foreground color that this widget sets; unset options if the widget does not set a foreground color

code: virtual [FSlateColor](API\Runtime\SlateCore\Styling\FSlateColor) GetForegroundColor() const


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


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


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


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


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


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


description:
Returns true if the checkbox is currently checked
True if checked, otherwise false

code: bool IsChecked() const


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

code: virtual bool IsInteractable() const


description: Utility function to determine if the incoming mouse event is for a precise tap or click

code: bool IsPreciseTapOrClick ( const [FPointerEvent](API\Runtime\SlateCore\Input\FPointerEvent) & MouseEvent ) const


description:
Returns true if this button is currently pressed
True if pressed, otherwise false

code: bool IsPressed() const


description: Attribute getter for the background image

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


description: Attribute getter for the border background color


description: Attribute getter for the checkbox type


description:
Gets the check image to display for the current state of the check box
The name of the image to display

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


description: Attribute getter for the padding


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:
SeeSWidget::OnMouseButtonDown.
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:
SeeSWidget::OnMouseButtonDoubleClick.
Whether the event was handled along with possible requests for the system to take action.

code: virtual [FReply](API\Runtime\SlateCore\Input\FReply) OnMouseButtonDoubleClick ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & InMyGeometry, const [FPointerEvent](API\Runtime\SlateCore\Input\FPointerEvent) & InMouseEvent )


description:
SeeSWidget::OnMouseButtonUp.
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 )


description: Play the checked sound

code: void PlayCheckedSound() const


description: Play the hovered sound

code: void PlayHoverSound() const


description: See the CheckedHoveredImage attribute

code: void SetCheckedHoveredImage ( const [FSlateBrush](API\Runtime\SlateCore\Styling\FSlateBrush) * Brush )


description: Play the unchecked sound

code: void PlayUncheckedSound() const


description: See the CheckedImage attribute

code: void SetCheckedImage ( const [FSlateBrush](API\Runtime\SlateCore\Styling\FSlateBrush) * Brush )


description: See the CheckedPressedImage attribute

code: void SetCheckedPressedImage ( const [FSlateBrush](API\Runtime\SlateCore\Styling\FSlateBrush) * Brush )


description: See the Content slot

code: void SetContent ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) > & InContent )


code: void SetClickMethod ( [EButtonClickMethod::Type](API\Runtime\SlateCore\Types\EButtonClickMethod__Type) InClickMethod )


description: See the IsChecked attribute

code: void SetIsChecked ( [TAttribute](API\Runtime\Core\Misc\TAttribute)< ECheckBoxState > InIsChecked )


description: See the Style attribute

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


code: void SetPressMethod ( [EButtonPressMethod::Type](API\Runtime\SlateCore\Types\EButtonPressMethod__Type) InPressMethod )


code: void SetTouchMethod ( [EButtonTouchMethod::Type](API\Runtime\SlateCore\Types\EButtonTouchMethod__Type) InTouchMethod )


description: See the UncheckedHoveredImage attribute

code: void SetUncheckedHoveredImage ( const [FSlateBrush](API\Runtime\SlateCore\Styling\FSlateBrush) * Brush )


description: See the UncheckedImage attribute

code: void SetUncheckedImage ( const [FSlateBrush](API\Runtime\SlateCore\Styling\FSlateBrush) * Brush )


description: See the UncheckedPressedImage attribute

code: void SetUncheckedPressedImage ( const [FSlateBrush](API\Runtime\SlateCore\Styling\FSlateBrush) * Brush )


description: See the UndeterminedHoveredImage attribute

code: void SetUndeterminedHoveredImage ( const [FSlateBrush](API\Runtime\SlateCore\Styling\FSlateBrush) * Brush )


description: See the UndeterminedImage attribute

code: void SetUndeterminedImage ( const [FSlateBrush](API\Runtime\SlateCore\Styling\FSlateBrush) * Brush )


description: See the UndeterminedPressedImage attribute

code: void SetUndeterminedPressedImage ( const [FSlateBrush](API\Runtime\SlateCore\Styling\FSlateBrush) * Brush )


description:
SeeSWidget::SupportsKeyboardFocus().
True if this widget can take keyboard focus

code: virtual bool SupportsKeyboardFocus() const


description: Toggles the checked state for this check box, fire events as needed

code: void ToggleCheckedState()


className: SCheckBox

description: Check box Slate control

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

BackgroundHoveredImage

type: constFSlateBru...

description: Image to use for the checkbox background when hovered

BackgroundPressedImage

description: Image to use for the checkbox background when pressed

bCheckBoxContentUsesAutoWidth

type: bool

description: Whether or not the checkbox content is arranged using auto-width when in checkbox mode.

bIsFocusable

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

bIsPressed

description: True if this check box is currently in a pressed state

BorderBackgroundColorOverride

type: TAttribute<FSl...

description: Overrides border background color in the widget style, if set

CheckBoxTypeOverride

type: TOptional<ESla...

description: Overrides checkbox type in the widget style, if set

CheckedHoveredImage

description: Image to use when the checkbox is checked and hovered

CheckedPressedImage

description: Image to use when the checkbox is checked and pressed

CheckedSound

type: FSlateSound

description: The Sound to play when the check box is checked

ClickMethod

type: EButtonClickMet...

description: Sets whether a click should be triggered on mouse down, mouse up, or that both a mouse down and up are required.

ContentContainer

type: TSharedPtr<SBo...

description: When in toggle button mode, this will hold the pointer to the toggle button's border

ForegroundColorOverride

description: Overrides foreground color in the widget style, if set

HorizontalAlignment

type: EHorizontalAlig...

description: Horiz align setting if in togglebox mode

HoveredSound

description: The Sound to play when the check box is hovered

IsCheckboxChecked

type: TAttribute< ECh...

description: Are we checked

OnCheckStateChanged

type: FOnCheckStateCh...

description: Delegate called when the check box changes state

OnGetMenuContent

type: FOnGetContent

description: Delegate to execute to get the menu content of this button

PaddingOverride

type: TAttribute<FMa...

description: Overrides padding in the widget style, if set

PressMethod

type: TEnumAsByte<EB...

description: How should the button be clicked with keyboard/controller button events?

Style

type: constFCheckBox...

TouchMethod

description: How should the button be clicked with touch events?

UncheckedHoveredImage

description: Image to use when the checkbox is unchecked and hovered

UncheckedPressedImage

description: Image to use when the checkbox is unchecked and pressed

UncheckedSound

description: The Sound to play when the check box is unchecked

UndeterminedHoveredImage

description: Image to use when the checkbox is in an ambiguous state and hovered

UndeterminedPressedImage

description: Image to use when the checkbox is in an ambiguous state and pressed


description: Construct the widget from a declaration

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


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


description: The visual style of the button (overrides ComboButtonStyle)

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


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


code: WidgetArgsType & ComboButtonStyle &40; const FComboButtonStyle &42; InArg &41;


description: True if this combo's menu should be collapsed when our parent receives focus, false (default) otherwise

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


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


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


code: WidgetArgsType & HAlign &40; EHorizontalAlignment InArg &41;


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


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


description: Optional static menu content. If the menu content needs to be dynamically built, use the OnGetMenuContent event

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


description: Spawn a new window or reuse current window for this combo

code: WidgetArgsType & Method &40; TOptional< EPopupMethod > InArg &41;


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


code: WidgetArgsType & OnComboBoxOpened &40; const FOnComboBoxOpened & InDelegate &41;


description: Sets an event handler to generate a widget dynamically when the menu is needed.

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


code: WidgetArgsType & OnMenuOpenChanged &40; const FOnIsOpenChanged & InDelegate &41;


code: WidgetArgsType & VAlign &40; EVerticalAlignment InArg &41;


code: typedef FArguments WidgetArgsType


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


description:
Called to query the tool tip text for this widget, but will return an empty text when the menu is already open
Tool tip text, or an empty text if filtered out

code: [FText](API\Runtime\Core\Internationalization\FText) GetFilteredToolTipText ( [TAttribute](API\Runtime\Core\Misc\TAttribute)< [FText](API\Runtime\Core\Internationalization\FText) > ToolTipText ) const


description: Handle the button being clicked by summoning the ComboButton.


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: See the padding for button content.

code: void SetButtonContentPadding ( [FMargin](API\Runtime\SlateCore\Layout\FMargin) InPadding )


description: See MenuContent attribute

code: virtual void SetMenuContent ( [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) > InMenuContent )


description: Add/remove the expanding arrow.

code: void SetHasDownArrow ( bool InHasArrowDown )


code: void SetMenuContentWidgetToFocus ( [TWeakPtr](API\Runtime\Core\Templates\TWeakPtr)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) > InWidgetToFocusPtr )


description: See the OnGetMenuContent event

code: void SetOnGetMenuContent ( FOnGetContent InOnGetMenuContent )


className: SComboButton

description: A button that, when clicked, brings up a popup.

code: class SComboButton : public [SMenuAnchor](API\Runtime\Slate\Widgets\Input\SMenuAnchor)

bIsFocusable

description: Can this button be focused?

ButtonContentSlot

description: Area where the button's content resides

ContentWidgetPtr

type: TWeakPtr<SWidg...

description: The content widget, if any, set by the user on creation

MenuBorderBrush

description: Brush to use to add a "menu border" around the drop-down content

MenuBorderPadding

type: FMargin

description: Padding to use to add a "menu border" around the drop-down content

OnComboBoxOpened

type: FOnComboBoxOpen...

description: Delegate to execute when the combo list is opened


description: Constructs this widget.

code: void Construct ( const [FArguments](API\Runtime\Slate\Widgets\Input\SComboRow\FArguments) & InArgs, const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [STableViewBase](API\Runtime\Slate\Widgets\Views\STableViewBase) > & InOwnerTable )


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


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


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


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


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


description: Handle case where user clicks on an existing selected item

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 )


className: SComboRow

code: template<typename OptionType> class SComboRow : public [STableRow< OptionType >](API\Runtime\Slate\Widgets\Views\STableRow)


description: Query to see if any text is selected within the document

code: bool AnyTextSelected() const


description: Begin a new text search (this is called automatically when the bound search text changes)

code: void BeginSearch ( const [FText](API\Runtime\Core\Internationalization\FText) & InSearchText, const [ESearchCase::Type](API\Runtime\Core\Misc\ESearchCase__Type) InSearchCase, const bool InReverse )


description: Advance the current search to the next match (does nothing if not currently searching)

code: void AdvanceSearch ( const bool InReverse )


description: Build the context menu content to use for this widget (if any)

code: virtual [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) > BuildContextMenuContent() const


description: Are we currently able to insert a carriage return? (some widgets have modifier keys that need to be pressed)

code: virtual bool CanInsertCarriageReturn() const


description: The system calls this method. It performs a breadth-first traversal of every visible widget and asks each widget to cache how big it needs to be in order to present all of its content.

code: virtual void CacheDesiredSize ( float InLayoutScaleMultiplier )


description: Are we able to insert the given character into our text?

code: virtual bool CanTypeCharacter ( const TCHAR InChar ) const


description: Clear the active text selection

code: void ClearSelection()


description:
Note thatComputeDesiredSize()is meant as an aide to the developer. It is NOT meant to be very robust in many cases. If your widget is simulating a bouncing ball, you should just return a reasonable size; e.g. 160x160. Let the programmer set up a reasonable rule of resizing the bouncy ball simulation.
The desired size.

code: virtual FVector2D ComputeDesiredSize ( float LayoutScaleMultiplier ) const


description: Recomputes the volatility of the widget. If you have additional state you automatically want to make the widget volatile, you should sample that information here.

code: virtual bool ComputeVolatility() const


description: Construct this widget

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


description: Register and activate the IME context for this text layout

code: void EnableTextInputMethodContext()


description: Ensure that we will get aTick()soon (either due to having active focus, or something having changed progmatically and requiring an update) Does nothing if the active tick timer is already enabled

code: virtual void EnsureActiveTick()


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


description: Whether the context menu can be opened

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


description: Background image for the composing text (overrides Style)

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


description: Background image for the selected text (overrides Style)

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


description: Image brush used for the caret (overrides Style)

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


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 (overrides Style)

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


description: Menu extender for the right-click context menu

code: WidgetArgsType & ContextMenuExtender &40; const FMenuExtensionDelegate & InDelegate &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 font used to draw the text (overrides Style)

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


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

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


description: Sets whether this text box is for storing a password

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


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

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


description: How should the value be justified in the editable text field.

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


description: Minimum width that a text block should be

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


description: Delegate to call before a context menu is opened. User returns the menu content or null to the disable context menu

code: WidgetArgsType & OnContextMenuOpening &40; const FOnContextMenuOpening & InDelegate &41;


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

code: WidgetArgsType & OnKeyCharHandler &40; const FOnKeyChar & 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 OnKeyDown event

code: WidgetArgsType & OnKeyDownHandler &40; const FOnKeyDown & InDelegate &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;


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

code: WidgetArgsType & OverflowPolicy &40; TOptional< ETextOverflowPolicy > InArg &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 style of the text block, which dictates the font, color

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


description: Sets the text content for this editable text 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;


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 type of virtual keyboard to use on mobile devices

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


code: typedef FArguments WidgetArgsType


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


description: Should be renamed to GetVisibleChildren (not ALL children will be returned in all cases).

code: virtual [FChildren](API\Runtime\SlateCore\Layout\FChildren) * GetChildren()


description: Gets the font used to draw the text.


description: a brush to draw focus, nullptr if no focus drawing is desired

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


description: Assign AccessibleText with a default value that can be used when AccessibleBehavior is set to Auto or Custom.

code: virtual [TOptional](API\Runtime\Core\IO\TOptional)< [FText](API\Runtime\Core\Internationalization\FText) > GetDefaultAccessibleText ( EAccessibleType AccessibleType ) const


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


description:
Returns the text string
Text string


description: Get the currently selected text


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


description: Get the Slate widget this interface is representing (may not be called during destruction)

code: virtual [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) > GetSlateWidget()


description: Get the Slate widget this interface is representing (may be null during destruction)

code: virtual [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) > GetSlateWidgetPtr()


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

code: virtual EVirtualKeyboardDismissAction GetVirtualKeyboardDismissAction() const


description: Get the options for the virtual keyboard used for this widget


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

code: virtual EVirtualKeyboardTrigger GetVirtualKeyboardTrigger() const


description: Move the cursor to the given location in the document (will also scroll to this point)

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


description: Get the type of virtual keyboard to use for this widget

code: virtual EKeyboardType GetVirtualKeyboardType() const


description: Move the cursor specified location

code: void GoTo ( const ETextLocation NewLocation )


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

code: virtual bool IsInteractable() const


description: Is the text edit multi-line aware?

code: virtual bool IsMultiLineTextEdit() const


description: Is the text displaying a password and should be obscured?

code: virtual bool IsTextPassword() const


description: Is the text currently read-only?

code: virtual bool IsTextReadOnly() const


description: Compute the Geometry of all the children and add populate the ArrangedChildren list with their values. Each type of Layout panel should arrange children based on desired behavior.

code: virtual void OnArrangeChildren ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & AllottedGeometry, [FArrangedChildren](API\Runtime\SlateCore\Layout\FArrangedChildren) & ArrangedChildren ) const


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

code: virtual void OnCursorMoved ( const [FTextLocation](API\Runtime\Slate\Framework\Text\FTextLocation) & InLocation )


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:
Called during drag and drop when the the mouse is being dragged over a widget.
A reply that indicated whether this event was handled.

code: virtual [FReply](API\Runtime\SlateCore\Input\FReply) OnDragOver ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FDragDropEvent](API\Runtime\SlateCore\Input\FDragDropEvent) & DragDropEvent )


description:
Called when the user is dropping something onto a widget; terminates drag and drop.
A reply that indicated whether this event was handled.

code: virtual [FReply](API\Runtime\SlateCore\Input\FReply) OnDrop ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FDragDropEvent](API\Runtime\SlateCore\Input\FDragDropEvent) & DragDropEvent )


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 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 character is entered while this widget has keyboard focus
Returns whether the event was handled, along with other possible actions

code: virtual [FReply](API\Runtime\SlateCore\Input\FReply) OnKeyChar ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FCharacterEvent](API\Runtime\SlateCore\Input\FCharacterEvent) & InCharacterEvent )


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:
Called when a mouse button is double clicked. Override this in derived classes.
Returns whether the event was handled, along with other possible actions

code: virtual [FReply](API\Runtime\SlateCore\Input\FReply) OnMouseButtonDoubleClick ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & InMyGeometry, const [FPointerEvent](API\Runtime\SlateCore\Input\FPointerEvent) & InMouseEvent )


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


description: Called when the text has been changed by an edit operation

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


description: Called when the text control has committed its current edit changes

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


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:
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: 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: Sets whether to clear keyboard focus when pressing enter to commit changes

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


description: See the ColorAndOpacity attribute

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


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: See the HintText attribute

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


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

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


description: See the IsPassword attribute

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


description: See the IsReadOnly attribute

code: void SetIsReadOnly ( [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: Sets the minimum width that a text block should be.

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


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

code: void SetOnKeyCharHandler ( FOnKeyChar InOnKeyCharHandler )


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

code: void SetOnKeyDownHandler ( FOnKeyDown InOnKeyDownHandler )


description: Sets the overflow policy for this text block

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


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

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


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 all text when pressing enter to commit changes

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


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

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


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

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


description: TextStyle Sets the text block style used to draw the text

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


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: Sets the text style used to draw the text

code: void SetTextStyle ( const [FEditableTextStyle](API\Runtime\SlateCore\Styling\FEditableTextStyle) & InNewTextStyle )


description: Set the VirtualKeyboardDismissAction attribute

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


description: Should we clear the keyboard focus when the user commits text to this widget?

code: virtual bool ShouldClearKeyboardFocusOnCommit() const


description: Should the text clear its selection the widget loses focus?

code: virtual bool ShouldClearTextSelectionOnFocusLoss() const


description: Should the cursor be jumped to the end of the document when the widget gains focus?

code: virtual bool ShouldJumpCursorToEndWhenFocused() const


description: Should we revert the text back to its original state when the user presses escape?

code: virtual bool ShouldRevertTextOnEscape() const


description: Should we select all text when the user commits text to this widget?

code: virtual bool ShouldSelectAllTextOnCommit() const


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: Should the text be selected when the widget gains focus?

code: virtual bool ShouldSelectAllTextWhenFocused() const


description: Should we select word on mouse double click?

code: virtual bool ShouldSelectWordOnMouseDoubleClick() const


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: Synchronize the text style currently set (including from overrides) and update the text layout if required

code: void SynchronizeTextStyle()


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 )


description: Called when the fraction and offset of the horizontal scroll area has been recalculated. This function should apply the new values to any scrollbars, and return a clamped horizontal scroll value

code: virtual float UpdateAndClampHorizontalScrollBar ( const float InViewOffset, const float InViewFraction, const [EVisibility](API\Runtime\SlateCore\Layout\EVisibility) InVisiblityOverride )


description: Called when the fraction and offset of the vertical scroll area has been recalculated. This function should apply the new values to any scrollbars, and return a clamped vertical scroll value

code: virtual float UpdateAndClampVerticalScrollBar ( const float InViewOffset, const float InViewFraction, const [EVisibility](API\Runtime\SlateCore\Layout\EVisibility) InVisiblityOverride )


description: Constructor

code: SEditableText()


description: Destructor

code: ~SEditableText()


className: SEditableText

description: Editable text widget

code: class SEditableText : public [SWidget](API\Runtime\SlateCore\Widgets\SWidget), public [ISlateEditableTextWidget](API\Runtime\Slate\Widgets\Text\ISlateEditableTextWidget)

ActiveTickTimer

type: TWeakPtr< FActi...

description: The timer that is actively driving this widget toTick()even when Slate is idle

BackgroundImageSelected

type: TAttribute< con...

description: Background image for the selected text

bAllowContextMenu

type: TAttribute< boo...

description: Whether to disable the context menu

bClearKeyboardFocusOnCommit

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

bIsCaretMovedWhenGainFocus

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

bIsPassword

description: Sets whether this text box is for storing a password

bIsReadOnly

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

bRevertTextOnEscape

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

bSelectAllTextOnCommit

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

bSelectAllTextWhenFocused

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

bSelectWordOnMouseDoubleClick

description: Whether to select word on mouse double click

ColorAndOpacity

description: Text color and opacity

EditableTextLayout

type: TUniquePtr<FSl...

description: The text layout that deals with the editable text

Font

description: The font used to draw the text

MenuExtender

type: TSharedPtr<FEx...

description: Menu extender for right-click context menu

MinDesiredWidth

type: TAttribute< flo...

description: Prevents the editable text from being smaller than desired in certain cases (e.g. when it is empty)

OnContextMenuOpening

type: FOnContextMenuO...

description: Delegate to call before a context menu is opened

OnIsTypedCharValid

type: FOnIsTypedCharV...

description: Called when a character is typed and we want to know if the text field supports typing this character.

OnKeyCharHandler

type: FOnKeyChar

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

OnKeyDownHandler

type: FOnKeyDown

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

OnTextChangedCallback

type: FOnTextChanged

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

OnTextCommittedCallback

type: FOnTextCommitte...

description: Called whenever the text is committed.

PlainTextMarshaller

type: TSharedPtr<FPl...

description: Text marshaller used by the editable text layout

VirtualKeyboardDismissAction

type: TAttribute< EVi...

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

VirtualKeyboardOptions

type: FVirtualKeyboar...

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

VirtualKeyboardTrigger

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

VirtualKeyboardType

type: TAttribute< EKe...

description: The type of virtual keyboard to use for editing this text on mobile

WordBreakIterator

type: TSharedPtr<IBr...

description: The iterator to use to detect word boundaries


description: Advance the current search to the next match (does nothing if not currently searching)

code: void AdvanceSearch ( const bool InReverse )


description: Query to see if any text is selected within the document

code: bool AnyTextSelected() const


description: Begin a new text search (this is called automatically when the bound search text changes)

code: void BeginSearch ( const [FText](API\Runtime\Core\Internationalization\FText) & InSearchText, const [ESearchCase::Type](API\Runtime\Core\Misc\ESearchCase__Type) InSearchCase, const bool InReverse )


description: Clear the active text selection

code: void ClearSelection()


description: Construct this widget

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


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


description: Register and activate the IME context for the text layout of this textbox

code: void EnableTextInputMethodContext()


description: Whether the context menu can be opened

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


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

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: Menu extender for the right-click context menu

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


description: Provide a alternative mechanism for error reporting.

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


description: Text color and opacity when this box has keyboard focus (overrides Style)

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


description: Font color and opacity (overrides Style)

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


description: Text color and opacity (overrides Style)

code: WidgetArgsType & ForegroundColor &40; const TAttribute< FSlateColor > & InAttribute &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: Sets whether this text box is for storing a password

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


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

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


description: How should the value be justified in the editable text field.

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


description: Minimum width that a text block should be

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


description: Delegate to call before a context menu is opened. User returns the menu content or null to the disable context menu

code: WidgetArgsType & OnContextMenuOpening &40; const FOnContextMenuOpening & InDelegate &41;


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

code: WidgetArgsType & OnKeyCharHandler &40; const FOnKeyChar & InDelegate &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 & OnVerifyTextChanged &40; const FOnVerifyTextChanged & InDelegate &41;


description: Determines what happens to text that is clipped and doesnt fit within the allotted area for this text box

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: Callback delegate to have first chance handling of the OnKeyDown event

code: WidgetArgsType & OnKeyDownHandler &40; const FOnKeyDown & InDelegate &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;


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 for 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 type of virtual keyboard to use on mobile devices

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


code: typedef FArguments WidgetArgsType


description: Assign AccessibleText with a default value that can be used when AccessibleBehavior is set to Auto or Custom.

code: virtual [TOptional](API\Runtime\Core\IO\TOptional)< [FText](API\Runtime\Core\Internationalization\FText) > GetDefaultAccessibleText ( EAccessibleType AccessibleType ) const


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


description:
Returns the Hint text string
Hint Text string


description: Get the currently selected text


description:
Returns the text string
Text string


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


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: 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: Scroll to the given location in the document (without moving the cursor)

code: void ScrollTo ( const ETextLocation NewLocation )


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


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: Select all the text in the document

code: void SelectAllText()


description: See the AllowContextMenu attribute

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


description: Sets whether to clear keyboard focus when pressing enter to commit changes

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


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 )


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


description: Sets the text color and opacity when this box has keyboard focus(overrides Style)

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


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) > & InFont )


description: See the HintText attribute

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


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

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


description: See the IsPassword attribute

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


description: See the IsReadOnly attribute

code: void SetIsReadOnly ( [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: Sets the minimum width that a text box should be.

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


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

code: void SetOnKeyCharHandler ( FOnKeyChar InOnKeyCharHandler )


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

code: void SetOnKeyDownHandler ( FOnKeyDown InOnKeyDownHandler )


description: Sets the overflow policy for this text block

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


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: Sets whether to allow the user to back out of changes when they press the escape key

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


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 all text when pressing enter to commit changes

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


description: Sets whether to select select word on 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 block style currently used

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


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 (overrides Style)

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


description: See TextFlowDirection attribute

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


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

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


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


className: SEditableTextBox

description: Editable text box widget

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

BackgroundColorOverride

type: TAttribute<FSl...

description: Background color (overrides style)

Box

type: TSharedPtr<SHo...

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

EditableText

type: TSharedPtr<SEd...

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)

OnTextChanged

description: Called when the text is changed interactively

OnTextCommitted

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.

PaddingBox

type: TSharedPtr<SBo...

description: Box widget that adds padding around the editable text

PaddingOverride

type: TAttribute<FMa...

description: Padding (overrides style)

ReadOnlyForegroundColorOverride

description: Read-only foreground color (overrides style)

Style

type: constFEditable...


description: Construct this widget

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


description: Slot for this button's collapsed content (optional)

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


description: The text to display in this button in it's collapsed state (if nothing is specified for CollapsedButtonContent)

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


description: Slot for this button's expanded content (optional)

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


description: Slot for this button's expanded body

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


description: The text to display in this button in it's expanded state (if nothing is specified for ExpandedButtonContent)

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


description: Current expansion state

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


description: Called when the close button is clicked

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


description: Called when the expansion button is clicked

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


code: typedef FArguments WidgetArgsType


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


description: Callbacks to determine visibility of parts that should be shown when the button state is collapsed or expanded


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


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


description: Construct the hyperlink widgets from a declaration

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


className: SExpandableButton

description: A button that can either be collapsed or expanded, containing different content in each state.

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


code: WidgetArgsType & HighlightColor &40; const TAttribute< FLinearColor > & InAttribute &41;


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


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


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


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


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


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


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


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


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


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


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


code: typedef FArguments WidgetArgsType


description: Invoke the OnNavigate method


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


className: SHyperlink

description: A hyperlink widget is what you would expect from a browser hyperlink. When a hyperlink is clicked in invokes anOnNavigate()delegate.

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

OnNavigate

type: FSimpleDelegate

description: The delegate to invoke when someone clicks the hyperlink


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


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


description: When true modifier keys are captured in the selected key chord, otherwise they are ignored.

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


description: When true gamepad keys are captured in the selected key chord, otherwise they are ignored.

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


description: The style of the button used to enable key selection.

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


description: When true, pressing escape will cancel the key selection, when false, pressing escape will select the escape key.

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


description: When EscapeCancelsSelection is true, escape on specific keys that are unbind able by the user.

code: WidgetArgsType & EscapeKeys &40; TArray< FKey > InArg &41;


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

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


description: The text to display while selecting a new key.

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


description: The font used to display the currently selected key.

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


description: The text to display while no key text is available or not selecting a key.

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


description: The margin around the selected key text.

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


description: Occurs whenever key selection mode starts and stops.

code: WidgetArgsType & OnIsSelectingKeyChanged &40; const FOnIsSelectingKeyChanged & InDelegate &41;


description: Occurs whenever a new key is selected.

code: WidgetArgsType & OnKeySelected &40; const FOnKeySelected & InDelegate &41;


description: The currently selected key

code: WidgetArgsType & SelectedKey &40; const TAttribute< FInputChord > & InAttribute &41;


description: The text style of the button text

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


code: typedef FArguments WidgetArgsType


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


className: FOnIsSelectingKeyChanged

code: typedef TBaseDelegate_NoParams< void > FOnIsSelectingKeyChanged


className: FOnKeySelected

code: typedef TBaseDelegate_OneParam< void, const [FInputChord](API\Runtime\Slate\Framework\Commands\FInputChord) & > FOnKeySelected


description: Returns true whenever key selection mode is active, otherwise returns false.

code: bool GetIsSelectingKey() const


description: Gets the currently selected key chord.


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: 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:
This event is primarily to allow parent widgets to consume an event before a child widget processes it and it should be used only when there is no better design alternative.
Returns whether the event was handled, along with other possible actions

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


description: Use this event sparingly as preview events generally make UIs more difficult to reason about.

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


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: When true gamepad keys are captured in the selected key chord, otherwise they are ignored.

code: void SetAllowGamepadKeys ( const bool bInAllowGamepadKeys )


description: When true modifier keys are captured in the selected key chord, otherwise they are ignored.

code: void SetAllowModifierKeys ( const bool bInAllowModifierKeys )


description: Sets the style of the button which is used enter key selection mode.

code: void SetButtonStyle ( const [FButtonStyle](API\Runtime\SlateCore\Styling\FButtonStyle) * ButtonStyle )


description: Sets the escape keys to check against.

code: void SetEscapeKeys ( [TArray](API\Runtime\Core\Containers\TArray)< [FKey](API\Runtime\InputCore\FKey) > InEscapeKeys )


description: Sets the text which is displayed when selecting a key.

code: void SetKeySelectionText ( [FText](API\Runtime\Core\Internationalization\FText) InKeySelectionText )


description: Sets the margin around the text used to display the currently selected key

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


description: Sets the text to display when no key text is available or not selecting a key.

code: void SetNoKeySpecifiedText ( [FText](API\Runtime\Core\Internationalization\FText) InNoKeySpecifiedText )


description: Sets the currently selected key chord.

code: void SetSelectedKey ( [TAttribute](API\Runtime\Core\Misc\TAttribute)< [FInputChord](API\Runtime\Slate\Framework\Commands\FInputChord) > InSelectedKey )


description: Sets the visibility of the text block.

code: void SetTextBlockVisibility ( [EVisibility](API\Runtime\SlateCore\Layout\EVisibility) InVisibility )


description: Sets the style of the text on the button which is used enter key selection mode.

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


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


className: SInputKeySelector

description: A widget for selecting keys or input chords.

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


description:
A Panel's desired size in the space required to arrange of its children on the screen while respecting all of the children's desired sizes and any layout-related options specified by the user. See StackPanel for an example.
The desired size.

code: virtual FVector2D ComputeDesiredSize ( float ) const


description: Recomputes the volatility of the widget. If you have additional state you automatically want to make the widget volatile, you should sample that information here.

code: virtual bool ComputeVolatility() const


description: Construct this widget

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


description: True to apply the InWidgetStyle of the menu anchor when painting the popup, false to always paint the popup with full opacity and no tint.

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


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


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


description: True if this menu anchor should be collapsed when its parent receives focus, false (default) otherwise

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


description: Computes the placement geometry for menus displayed in a separately created window

code: [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) ComputeNewWindowMenuPlacement ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & AllottedGeometry, const FVector2D & PopupDesiredSize, EMenuPlacement PlacementMode ) const


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


code: WidgetArgsType & Method &40; TOptional< EPopupMethod > InArg &41;


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


code: WidgetArgsType & OnMenuOpenChanged &40; const FOnIsOpenChanged & InDelegate &41;


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


code: WidgetArgsType & Padding &40; FMargin InArg &41;


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


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


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


code: typedef FArguments WidgetArgsType


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


code: FPopupPlacement &40; const FGeometry & PlacementGeometry, const FVector2D & PopupDesiredSize, EMenuPlacement PlacementMode &41;


className: FPopupPlacement

code: struct FPopupPlacement

AnchorLocalSpace

type: FSlateRect

Orientation

type: EOrientation


description: All widgets must provide a way to access their children in a layout-agnostic way. Panels store their children in Slots, which creates a dilemma. Most panels can store their children in a TPanelChildren, where the Slot class provides layout information about the child it stores. In that case GetChildren should simply return the TPanelChildren. See StackPanel for an example.

code: virtual [FChildren](API\Runtime\SlateCore\Layout\FChildren) * GetChildren()


description: The current menu position

code: FVector2D GetMenuPosition() const


code: virtual [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [SWindow](API\Runtime\SlateCore\Widgets\SWindow) > GetMenuWindow() const


description: true if the popup is open; false otherwise.

code: bool IsOpen() const


description: Whether this menu has open submenus

code: bool HasOpenSubMenus() const


description: true if the popup is currently open and reusing an existing window

code: bool IsOpenAndReusingWindow() const


description: true if the popup is currently open and we created a dedicated window for it

code: bool IsOpenViaCreatedWindow() const


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 ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & AllottedGeometry, [FArrangedChildren](API\Runtime\SlateCore\Layout\FArrangedChildren) & ArrangedChildren ) const


description: Handler/callback called by menus created by this anchor, when they are dismissed

code: void OnMenuClosed ( [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [IMenu](API\Runtime\Slate\Framework\Application\IMenu) > InMenu )


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


className: OpenApplicationMenus

code: static [TArray](API\Runtime\Core\Containers\TArray)< [TWeakPtr](API\Runtime\Core\Templates\TWeakPtr)< [IMenu](API\Runtime\Slate\Framework\Application\IMenu) > > OpenApplicationMenus;


description: See Content Slot attribute

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


description: Reset the popup state to prepopup.

code: void ResetPopupMenuContent()


description: Open or close the popup

code: virtual void SetIsOpen ( bool InIsOpen, const bool bFocusMenu, const int32 FocusUserIndex )


description: See MenuContent attribute

code: virtual void SetMenuContent ( [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) > InMenuContent )


description: true if we should open the menu due to a click. Sometimes we should not, if the same MouseDownEvent that just closed the menu is about to re-open it because it happens to land on the button.

code: bool ShouldOpenDueToClick() const


code: void SetMenuPlacement ( [TAttribute](API\Runtime\Core\Misc\TAttribute)< EMenuPlacement > InMenuPlacement )


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 )


code: virtual bool UsingApplicationMenuStack() const


className: SMenuAnchor

description: A PopupAnchor summons a Popup relative to its content. Summoning a popup relative to the cursor is accomplished via the application.

code: class SMenuAnchor : public [SPanel](API\Runtime\SlateCore\Widgets\SPanel), public [IMenuHost](API\Runtime\Slate\Framework\Application\IMenuHost)

bApplyWidgetStyleToMenu

type: bool

description: Should we paint the popup using the received InWidgetStyle?

bDismissedThisTick

description: Was the menu just dismissed this tick?

bFitInWindow

description: Should the menu anchor fit inside the window?

bIsCollapsedByParent

description: Whether this menu should be collapsed when its parent gets focus

bShouldDeferPaintingAfterWindowContent

description: Should the menu content painting be deferred? If not, the menu content will layer over the menu anchor, rather than above all window contents.

bUseApplicationMenuStack

description: Should the menu by created by the application stack code making it behave like and have the lifetime of a normal menu?

Children

type: TPanelChildren<...

description: The currently arranged children in the menu anchor.

MenuContent

type: TSharedPtr<SWi...

description: Static menu content to use when the delegate used when OnGetMenuContent is not defined.

Method

type: TOptional< EPop...

description: Should we summon a new window for this popup or

MethodInUse

type: FPopupMethodRep...

description: Method currently being used to show the popup. No value if popup is closed.

OnGetMenuContent

type: FOnGetContent

description: Callback invoked when the popup is being summoned

OnMenuOpenChanged

type: FOnIsOpenChange...

description: Callback invoked when the popup is being opened/closed

OwnedMenuPtr

type: TSharedPtr<IMe...

description: An interface pointer to the menu object presenting this popup.

Placement

type: TAttribute< EMe...

description: How should the popup be placed relative to the anchor.

PopupMenuPtr

type: TWeakPtr<IMenu...

PopupWindowPtr

type: TWeakPtr<SWind...

description: A pointer to the window presenting this popup.

ScreenPopupPosition

description: Screen-space version of LocalPopupPosition, also cached in Tick.

WrappedContent

description: MenuContent plus any extra wrapping widgets needed by the menu infrastructure.


description: Advance the current search to the next match (does nothing if not currently searching)

code: void AdvanceSearch ( const bool InReverse )


description: Query to see if any text is selected within the document

code: bool AnyTextSelected() const


description: Apply the given style to the currently selected text (or insert a new run at the current cursor position if no text is selected)

code: void ApplyToSelection ( const [FRunInfo](API\Runtime\Slate\Framework\Text\FRunInfo) & InRunInfo, const [FTextBlockStyle](API\Runtime\SlateCore\Styling\FTextBlockStyle) & InStyle )


description: Begin a new text search (this is called automatically when the bound search text changes)

code: void BeginSearch ( const [FText](API\Runtime\Core\Internationalization\FText) & InSearchText, const [ESearchCase::Type](API\Runtime\Core\Misc\ESearchCase__Type) InSearchCase, const bool InReverse )


description: Clear the active text selection

code: void ClearSelection()


description: Construct this widget

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


description: Whether the context menu can be opened

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


description: Whether to allow multi-line text

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


description: Should we always show the scrollbars (only affects internally created scroll bars)

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


description: Whether to wrap text automatically based on the widget's computed horizontal space. IMPORTANT: Using automatic wrapping can result in visual artifacts, as the the wrapped size will computed be at least one frame late! Consider using WrapTextAt instead. The initial desired size will not be clamped. This works best in cases where the text block's size is not affecting other widget's layout.

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


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

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: Whether to clear text selection when focus is lost

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


description: Menu extender for the right-click context menu

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


description: Delegate used to create text layouts for this widget. If none is provided thenFSlateTextLayoutwill be used.

code: WidgetArgsType & CreateSlateTextLayout &40; const FCreateSlateTextLayout & InDelegate &41;


description: Provide a alternative mechanism for error reporting.

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


description: Text color and opacity when this box has keyboard focus (overrides Style)

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


description: Font color and opacity (overrides Style)

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


description: Text color and opacity (overrides Style)

code: WidgetArgsType & ForegroundColor &40; const TAttribute< FSlateColor > & InAttribute &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: Padding around the horizontal scrollbar (overrides Style)

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


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

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


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

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


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

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


description: How the text should be aligned with the margin.

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


description: The amount to scale each lines height by.

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


description: The amount of blank space left around the edges of text area. This is different to Padding because this area is still considered part of the text area, and as such, can still be interacted with

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


description: The marshaller used to get/set the raw text to/from the text layout.

code: WidgetArgsType & Marshaller &40; TSharedPtr< ITextLayoutMarshaller > InArg &41;


description: The optional modifier key necessary to create a newline when typing into the editor.

code: WidgetArgsType & ModiferKeyForNewLine &40; EModifierKey::Type InArg &41;


description: Delegate to call before a context menu is opened. User returns the menu content or null to the disable context menu

code: WidgetArgsType & OnContextMenuOpening &40; const FOnContextMenuOpening & InDelegate &41;