Navigation
API > API/Runtime > API/Runtime/Slate > API/Runtime/Slate/SButton
| Name | FArguments |
| Type | struct |
| Header File | /Engine/Source/Runtime/Slate/Public/Widgets/Input/SButton.h |
| Include Path | #include "Widgets/Input/SButton.h" |
Syntax
struct FArguments : public TSlateBaseNamedArgs< SButton >
Inheritance Hierarchy
- FSlateBaseNamedArgs → TSlateBaseNamedArgs → SButton::FArguments
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FArguments() |
Widgets/Input/SButton.h |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| WidgetArgsType | FArguments | Widgets/Input/SButton.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
WidgetArgsType & AllowDragDrop
(
bool InArg |
True if the button should detect drag on mouse down. | Widgets/Input/SButton.h | |
WidgetArgsType & ButtonColorAndOpacity
(
const TAttribute< FSlateColor >& InAttribute |
Widgets/Input/SButton.h | ||
WidgetArgsType & ButtonStyle
(
const FButtonStyle* InArg |
The visual style of the button | Widgets/Input/SButton.h | |
WidgetArgsType & ClickedSoundOverride
(
TOptional< FSlateSound > InArg |
The sound to play when the button is clicked | Widgets/Input/SButton.h | |
WidgetArgsType & ClickMethod
(
EButtonClickMethod::Type InArg |
Sets the rules to use for determining whether the button was clicked. | Widgets/Input/SButton.h | |
NamedSlotProperty< FArguments > Content() |
Slot for this button's content (optional) | Widgets/Input/SButton.h | |
WidgetArgsType & ContentPadding
(
const TAttribute< FMargin >& InAttribute |
Spacing between button's border and the content. | Widgets/Input/SButton.h | |
WidgetArgsType & ContentScale
(
const TAttribute< FVector2D >& InAttribute |
Widgets/Input/SButton.h | ||
WidgetArgsType & DesiredSizeScale
(
const TAttribute< FVector2D >& InAttribute |
Widgets/Input/SButton.h | ||
WidgetArgsType & ForegroundColor
(
const TAttribute< FSlateColor >& InAttribute |
Widgets/Input/SButton.h | ||
WidgetArgsType & HAlign
(
EHorizontalAlignment InArg |
Horizontal alignment | Widgets/Input/SButton.h | |
WidgetArgsType & HoveredSoundOverride
(
TOptional< FSlateSound > InArg |
The sound to play when the button is hovered | Widgets/Input/SButton.h | |
WidgetArgsType & IsFocusable
(
bool InArg |
Sometimes a button should only be mouse-clickable and never keyboard focusable. | Widgets/Input/SButton.h | |
WidgetArgsType & NormalPaddingOverride
(
const TAttribute< FMargin >& InAttribute |
If set, overrides the button style's additional spacing between the button's border and the content when not pressed. | Widgets/Input/SButton.h | |
WidgetArgsType & OnClicked
(
const FOnClicked& InDelegate |
Called when the button is clicked | Widgets/Input/SButton.h | |
WidgetArgsType & OnHovered
(
const FSimpleDelegate& InDelegate |
Widgets/Input/SButton.h | ||
WidgetArgsType & OnLostFocus
(
const FSimpleDelegate& InDelegate |
Widgets/Input/SButton.h | ||
WidgetArgsType & OnPressed
(
const FSimpleDelegate& InDelegate |
Called when the button is pressed | Widgets/Input/SButton.h | |
WidgetArgsType & OnReceivedFocus
(
const FSimpleDelegate& InDelegate |
Widgets/Input/SButton.h | ||
WidgetArgsType & OnReleased
(
const FSimpleDelegate& InDelegate |
Called when the button is released | Widgets/Input/SButton.h | |
WidgetArgsType & OnSlateButtonDragDetected
(
const FOnDragDetected& InDelegate |
Drag and Drop. | Widgets/Input/SButton.h | |
WidgetArgsType & OnSlateButtonDragEnter
(
const FOnDragEnter& InDelegate |
Widgets/Input/SButton.h | ||
WidgetArgsType & OnSlateButtonDragLeave
(
const FOnDragLeave& InDelegate |
Widgets/Input/SButton.h | ||
WidgetArgsType & OnSlateButtonDragOver
(
const FOnDragOver& InDelegate |
Widgets/Input/SButton.h | ||
WidgetArgsType & OnSlateButtonDrop
(
const FOnDrop& InDelegate |
Widgets/Input/SButton.h | ||
WidgetArgsType & OnUnhovered
(
const FSimpleDelegate& InDelegate |
Widgets/Input/SButton.h | ||
WidgetArgsType & PressedPaddingOverride
(
const TAttribute< FMargin >& InAttribute |
If set, overrides the button style's additional spacing between the button's border and the content when pressed. | Widgets/Input/SButton.h | |
WidgetArgsType & PressedSoundOverride
(
TOptional< FSlateSound > InArg |
The sound to play when the button is pressed | Widgets/Input/SButton.h | |
WidgetArgsType & PressMethod
(
EButtonPressMethod::Type InArg |
How should the button be clicked with keyboard/controller button events? | Widgets/Input/SButton.h | |
WidgetArgsType & Text
(
const TAttribute< FText >& InAttribute |
The text to display in this button, if no custom content is specified | Widgets/Input/SButton.h | |
WidgetArgsType & TextFlowDirection
(
TOptional< ETextFlowDirection > InArg |
Which text flow direction should we use? (unset to use the default returned by GetDefaultTextFlowDirection) | Widgets/Input/SButton.h | |
WidgetArgsType & TextShapingMethod
(
TOptional< ETextShapingMethod > InArg |
Which text shaping method should we use? (unset to use the default returned by GetDefaultTextShapingMethod) | Widgets/Input/SButton.h | |
WidgetArgsType & TextStyle
(
const FTextBlockStyle* InArg |
The text style of the button | Widgets/Input/SButton.h | |
WidgetArgsType & TouchMethod
(
EButtonTouchMethod::Type InArg |
How should the button be clicked with touch events? | Widgets/Input/SButton.h | |
WidgetArgsType & VAlign
(
EVerticalAlignment InArg |
Vertical alignment | Widgets/Input/SButton.h |
Operators
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FArguments & operator[]
(
const TSharedRef< SWidget >& InChild |
Widgets/Input/SButton.h |