className
stringlengths
1
167
headerPath
stringlengths
14
166
description
stringlengths
0
1.62k
module
stringlengths
0
76
code
stringlengths
0
11.4k
variables
listlengths
0
395
FArguments
/Engine/Source/Runtime/Slate/Public/Widgets/Images/SThrobber.h
Slate
struct FArguments : public [TSlateBaseNamedArgs< SThrobber >](API\Runtime\SlateCore\Widgets\TSlateBaseNamedArgs)
[]
SThrobber::InvalidatePieceImage
/Engine/Source/Runtime/Slate/Public/Widgets/Images/SThrobber.h
Invalidate theSCircularThrobberwith the correct reason. You should invalidate when you are changing a property of SlateBrush after the SlateBrush was set to theSCircularThrobber.
Slate
void InvalidatePieceImage()
[]
SThrobber::FArguments::Animate
/Engine/Source/Runtime/Slate/Public/Widgets/Images/SThrobber.h
Which aspects of the throbber to animate
Slate
WidgetArgsType & Animate &40; EAnimation InArg &41;
[]
SThrobber::SetAnimate
/Engine/Source/Runtime/Slate/Public/Widgets/Images/SThrobber.h
Sets which aspects of the throbber to animate
Slate
void SetAnimate ( [EAnimation](API\Runtime\Slate\Widgets\Images\SThrobber\EAnimation) InAnimate )
[]
SThrobber::SetNumPieces
/Engine/Source/Runtime/Slate/Public/Widgets/Images/SThrobber.h
Sets how many pieces there are
Slate
void SetNumPieces ( int InNumPieces )
[]
SThrobber::SetPieceImage
/Engine/Source/Runtime/Slate/Public/Widgets/Images/SThrobber.h
Sets what each segment of the throbber looks like.
Slate
void SetPieceImage ( const [FSlateBrush](API\Runtime\SlateCore\Styling\FSlateBrush) * InPieceImage )
[]
SThrobber
/Engine/Source/Runtime/Slate/Public/Widgets/Images/SThrobber.h
A throbber widget that uses 5 zooming circles in a row.
Slate
class SThrobber : public [SCompoundWidget](API\Runtime\SlateCore\Widgets\SCompoundWidget)
[]
FVirtualKeyboardOptions::FVirtualKeyboardOptions
/Engine/Source/Runtime/Slate/Public/Widgets/Input/IVirtualKeyboardEntry.h
Slate
FVirtualKeyboardOptions()
[]
FVirtualKeyboardOptions
/Engine/Source/Runtime/Slate/Public/Widgets/Input/IVirtualKeyboardEntry.h
Slate
struct FVirtualKeyboardOptions
[ { "type": "bool", "name": "bEnableAutocorrect", "description": "Enables autocorrect for this widget, if supported by the platform's virtual keyboard." } ]
INumericTypeInterface::GetMaxFractionalDigits
/Engine/Source/Runtime/Slate/Public/Widgets/Input/NumericTypeInterface.h
Slate
int32 GetMaxFractionalDigits() const
[]
INumericTypeInterface::FromString
/Engine/Source/Runtime/Slate/Public/Widgets/Input/NumericTypeInterface.h
Slate
[TOptional](API\Runtime\Core\IO\TOptional)< NumericType > FromString ( const [FString](API\Runtime\Core\Containers\FString) & InString, const NumericType & ExistingValue )
[]
INumericTypeInterface::GetMinFractionalDigits
/Engine/Source/Runtime/Slate/Public/Widgets/Input/NumericTypeInterface.h
Gets the minimum and maximum fractional digits.
Slate
int32 GetMinFractionalDigits() const
[]
INumericTypeInterface::GetOnSettingChanged
/Engine/Source/Runtime/Slate/Public/Widgets/Input/NumericTypeInterface.h
Optional callback to broadcast when a setting in the type interface changes
Slate
virtual FOnSettingChanged * GetOnSettingChanged()
[]
INumericTypeInterface::IsCharacterValid
/Engine/Source/Runtime/Slate/Public/Widgets/Input/NumericTypeInterface.h
Check whether the typed character is valid
Slate
bool IsCharacterValid ( TCHAR InChar ) const
[]
INumericTypeInterface::SetMinFractionalDigits
/Engine/Source/Runtime/Slate/Public/Widgets/Input/NumericTypeInterface.h
Sets the minimum and maximum fractional digits - A minimum greater than 0 will always have that many trailing zeros
Slate
void SetMinFractionalDigits ( const [TAttribute](API\Runtime\Core\Misc\TAttribute)< [TOptional](API\Runtime\Core\IO\TOptional)< int32 >> & NewValue )
[]
INumericTypeInterface::SetMaxFractionalDigits
/Engine/Source/Runtime/Slate/Public/Widgets/Input/NumericTypeInterface.h
Slate
void SetMaxFractionalDigits ( const [TAttribute](API\Runtime\Core\Misc\TAttribute)< [TOptional](API\Runtime\Core\IO\TOptional)< int32 >> & NewValue )
[]
INumericTypeInterface::ToString
/Engine/Source/Runtime/Slate/Public/Widgets/Input/NumericTypeInterface.h
Convert the type to/from a string
Slate
[FString](API\Runtime\Core\Containers\FString) ToString ( const NumericType & Value ) const
[]
INumericTypeInterface
/Engine/Source/Runtime/Slate/Public/Widgets/Input/NumericTypeInterface.h
Interface to provide specific functionality for dealing with a numeric type. Currently includes string conversion functionality.
Slate
template<typename NumericType> struct INumericTypeInterface
[]
INumericTypeInterface::~INumericTypeInterface
/Engine/Source/Runtime/Slate/Public/Widgets/Input/NumericTypeInterface.h
Slate
virtual ~INumericTypeInterface()
[]
IVirtualKeyboardEntry::GetHintText
/Engine/Source/Runtime/Slate/Public/Widgets/Input/IVirtualKeyboardEntry.h
Returns the hint text. HintText
Slate
[FText](API\Runtime\Core\Internationalization\FText) GetHintText() const
[]
IVirtualKeyboardEntry::GetSelection
/Engine/Source/Runtime/Slate/Public/Widgets/Input/IVirtualKeyboardEntry.h
Slate
bool GetSelection ( int & OutSelStart, int & OutSelEnd )
[]
IVirtualKeyboardEntry::GetVirtualKeyboardOptions
/Engine/Source/Runtime/Slate/Public/Widgets/Input/IVirtualKeyboardEntry.h
Returns additional virtual keyboard options
Slate
[FVirtualKeyboardOptions](API\Runtime\Slate\Widgets\Input\FVirtualKeyboardOptions) GetVirtualKeyboardOptions() const
[]
IVirtualKeyboardEntry::GetVirtualKeyboardType
/Engine/Source/Runtime/Slate/Public/Widgets/Input/IVirtualKeyboardEntry.h
Returns the virtual keyboard type. VirtualKeyboardType
Slate
EKeyboardType GetVirtualKeyboardType() const
[]
IVirtualKeyboardEntry::GetText
/Engine/Source/Runtime/Slate/Public/Widgets/Input/IVirtualKeyboardEntry.h
Returns the text. Text
Slate
[FText](API\Runtime\Core\Internationalization\FText) GetText() const
[]
IVirtualKeyboardEntry::IsMultilineEntry
/Engine/Source/Runtime/Slate/Public/Widgets/Input/IVirtualKeyboardEntry.h
Returns whether the entry is multi-line Whether the entry is multi-line
Slate
bool IsMultilineEntry() const
[]
IVirtualKeyboardEntry::SetSelectionFromVirtualKeyboard
/Engine/Source/Runtime/Slate/Public/Widgets/Input/IVirtualKeyboardEntry.h
Slate
void SetSelectionFromVirtualKeyboard ( int InSelStart, int SelEnd )
[]
IVirtualKeyboardEntry::~IVirtualKeyboardEntry
/Engine/Source/Runtime/Slate/Public/Widgets/Input/IVirtualKeyboardEntry.h
Slate
virtual ~IVirtualKeyboardEntry()
[]
IVirtualKeyboardEntry::SetTextFromVirtualKeyboard
/Engine/Source/Runtime/Slate/Public/Widgets/Input/IVirtualKeyboardEntry.h
Sets the text to that entered by the virtual keyboard
Slate
void SetTextFromVirtualKeyboard ( const [FText](API\Runtime\Core\Internationalization\FText) & InNewText, ETextEntryType TextEntryType )
[]
IVirtualKeyboardEntry
/Engine/Source/Runtime/Slate/Public/Widgets/Input/IVirtualKeyboardEntry.h
Slate
class IVirtualKeyboardEntry
[ { "type": "FOnSelectionCha...", "name": "OnSelectionChanged", "description": "" } ]
SButton::ComputeDesiredSize
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SButton.h
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.
Slate
virtual FVector2D ComputeDesiredSize ( float LayoutScaleMultiplier ) const
[]
SButton::Construct
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SButton.h
Construct this widget
Slate
void Construct ( const [FArguments](API\Runtime\Slate\Widgets\Input\SButton\FArguments) & InArgs )
[]
SButton::CreateAccessibleWidget
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SButton.h
Slate
virtual [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< FSlateAccessibleWidget > CreateAccessibleWidget()
[]
SButton::ExecuteHoverStateChanged
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SButton.h
Slate
void ExecuteHoverStateChanged ( bool bPlaySound )
[]
SButton::ExecuteOnClick
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SButton.h
Execute the "OnClicked" delegate, and get the reply
Slate
[FReply](API\Runtime\SlateCore\Input\FReply) ExecuteOnClick()
[]
SButton::FArguments::ButtonStyle
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SButton.h
The visual style of the button
Slate
WidgetArgsType & ButtonStyle &40; const FButtonStyle &42; InArg &41;
[]
SButton::FArguments::ButtonColorAndOpacity
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SButton.h
Slate
WidgetArgsType & ButtonColorAndOpacity &40; const TAttribute< FSlateColor > & InAttribute &41;
[]
SButton::FArguments::ClickMethod
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SButton.h
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.
Slate
WidgetArgsType & ClickMethod &40; EButtonClickMethod::Type InArg &41;
[]
SButton::FArguments::Content
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SButton.h
Slot for this button's content (optional)
Slate
NamedSlotProperty< FArguments > Content&40;&41;
[]
SButton::FArguments::ContentPadding
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SButton.h
Spacing between button's border and the content.
Slate
WidgetArgsType & ContentPadding &40; const TAttribute< FMargin > & InAttribute &41;
[]
SButton::FArguments::ContentScale
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SButton.h
Slate
WidgetArgsType & ContentScale &40; const TAttribute< FVector2D > & InAttribute &41;
[]
SButton::FArguments::DesiredSizeScale
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SButton.h
Slate
WidgetArgsType & DesiredSizeScale &40; const TAttribute< FVector2D > & InAttribute &41;
[]
SButton::FArguments::ForegroundColor
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SButton.h
Slate
WidgetArgsType & ForegroundColor &40; const TAttribute< FSlateColor > & InAttribute &41;
[]
SButton::FArguments::HAlign
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SButton.h
Horizontal alignment
Slate
WidgetArgsType & HAlign &40; EHorizontalAlignment InArg &41;
[]
SButton::FArguments::HoveredSoundOverride
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SButton.h
The sound to play when the button is hovered
Slate
WidgetArgsType & HoveredSoundOverride &40; TOptional< FSlateSound > InArg &41;
[]
SButton::FArguments::IsFocusable
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SButton.h
Sometimes a button should only be mouse-clickable and never keyboard focusable.
Slate
WidgetArgsType & IsFocusable &40; bool InArg &41;
[]
SButton::FArguments::OnClicked
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SButton.h
Called when the button is clicked
Slate
WidgetArgsType & OnClicked &40; const FOnClicked & InDelegate &41;
[]
SButton::FArguments::OnPressed
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SButton.h
Called when the button is pressed
Slate
WidgetArgsType & OnPressed &40; const FSimpleDelegate & InDelegate &41;
[]
SButton::FArguments::OnHovered
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SButton.h
Slate
WidgetArgsType & OnHovered &40; const FSimpleDelegate & InDelegate &41;
[]
SButton::FArguments::OnReleased
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SButton.h
Called when the button is released
Slate
WidgetArgsType & OnReleased &40; const FSimpleDelegate & InDelegate &41;
[]
SButton::FArguments::OnUnhovered
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SButton.h
Slate
WidgetArgsType & OnUnhovered &40; const FSimpleDelegate & InDelegate &41;
[]
SButton::FArguments::operator[]
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SButton.h
Slate
FArguments & operator&91;&93; &40; const TSharedRef< SWidget > & InChild &41;
[]
SButton::FArguments::PressMethod
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SButton.h
How should the button be clicked with keyboard/controller button events?
Slate
WidgetArgsType & PressMethod &40; EButtonPressMethod::Type InArg &41;
[]
SButton::FArguments::TextFlowDirection
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SButton.h
Which text flow direction should we use? (unset to use the default returned by GetDefaultTextFlowDirection)
Slate
WidgetArgsType & TextFlowDirection &40; TOptional< ETextFlowDirection > InArg &41;
[]
SButton::FArguments::Text
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SButton.h
The text to display in this button, if no custom content is specified
Slate
WidgetArgsType & Text &40; const TAttribute< FText > & InAttribute &41;
[]
SButton::FArguments::PressedSoundOverride
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SButton.h
The sound to play when the button is pressed
Slate
WidgetArgsType & PressedSoundOverride &40; TOptional< FSlateSound > InArg &41;
[]
SButton::FArguments::TextShapingMethod
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SButton.h
Which text shaping method should we use? (unset to use the default returned by GetDefaultTextShapingMethod)
Slate
WidgetArgsType & TextShapingMethod &40; TOptional< ETextShapingMethod > InArg &41;
[]
SButton::FArguments::TextStyle
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SButton.h
The text style of the button
Slate
WidgetArgsType & TextStyle &40; const FTextBlockStyle &42; InArg &41;
[]
SButton::FArguments::VAlign
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SButton.h
Vertical alignment
Slate
WidgetArgsType & VAlign &40; EVerticalAlignment InArg &41;
[]
SButton::FArguments::FArguments
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SButton.h
Slate
FArguments&40;&41;
[]
WidgetArgsType
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SButton.h
Slate
typedef FArguments WidgetArgsType
[]
FArguments
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SButton.h
Slate
struct FArguments : public [TSlateBaseNamedArgs< SButton >](API\Runtime\SlateCore\Widgets\TSlateBaseNamedArgs)
[]
SButton::GetBorder
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SButton.h
An image that represents this button's border
Slate
virtual const [FSlateBrush](API\Runtime\SlateCore\Styling\FSlateBrush) * GetBorder() const
[]
SButton::GetAppearPressedAttribute
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SButton.h
the AppearPressed attribute.
Slate
[TSlateAttributeRef](API\Runtime\SlateCore\Widgets\SWidget\TSlateAttributeRef)< bool > GetAppearPressedAttribute() const
[]
SButton::GetBorderForegroundColorAttribute
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SButton.h
the BorderForegroundColor attribute.
Slate
[TSlateAttributeRef](API\Runtime\SlateCore\Widgets\SWidget\TSlateAttributeRef)< [FSlateColor](API\Runtime\SlateCore\Styling\FSlateColor) > GetBorderForegroundColorAttribute() const
[]
SButton::FArguments::TouchMethod
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SButton.h
How should the button be clicked with touch events?
Slate
WidgetArgsType & TouchMethod &40; EButtonTouchMethod::Type InArg &41;
[]
SButton::GetCombinedPadding
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SButton.h
combines the user-specified margin and the button's internal margin.
Slate
[FMargin](API\Runtime\SlateCore\Layout\FMargin) GetCombinedPadding() const
[]
SButton::GetClickMethodFromInputType
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SButton.h
Utility function to translate other input click methods to regular ones.
Slate
[TEnumAsByte](API\Runtime\Core\Containers\TEnumAsByte)< [EButtonClickMethod::Type](API\Runtime\SlateCore\Types\EButtonClickMethod__Type) > GetClickMethodFromInputType ( const [FPointerEvent](API\Runtime\SlateCore\Input\FPointerEvent) & MouseEvent ) const
[]
SButton::GetContentPaddingAttribute
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SButton.h
the ContentPadding attribute.
Slate
[TSlateAttributeRef](API\Runtime\SlateCore\Widgets\SWidget\TSlateAttributeRef)< [FMargin](API\Runtime\SlateCore\Layout\FMargin) > GetContentPaddingAttribute() const
[]
SButton::GetDisabledForegroundColor
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SButton.h
the Foreground color that this widget sets when this widget or any of its ancestors are disabled; unset options if the widget does not set a foreground color
Slate
virtual [FSlateColor](API\Runtime\SlateCore\Styling\FSlateColor) GetDisabledForegroundColor() const
[]
SButton::GetForegroundColor
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SButton.h
the Foreground color that this widget sets; unset options if the widget does not set a foreground color
Slate
virtual [FSlateColor](API\Runtime\SlateCore\Styling\FSlateColor) GetForegroundColor() const
[]
SButton::GetShowDisabledEffect
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SButton.h
True if the disabled effect should be shown.
Slate
bool GetShowDisabledEffect() const
[]
SButton::GetWidgetClass
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SButton.h
Slate
virtual const [FSlateWidgetClassData](API\Runtime\SlateCore\Widgets\FSlateWidgetClassData) & GetWidgetClass() const
[]
SButton::IsInteractable
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SButton.h
Is this widget interactive or not? Defaults to false
Slate
virtual bool IsInteractable() const
[]
SButton::IsPreciseTapOrClick
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SButton.h
Utility function to determine if the incoming mouse event is for a precise tap or click
Slate
bool IsPreciseTapOrClick ( const [FPointerEvent](API\Runtime\SlateCore\Input\FPointerEvent) & MouseEvent ) const
[]
SButton::IsPressed
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SButton.h
IsPressed used to be virtual. Use SetAppearPressed to assign an attribute if you need to override the default behavior. True if pressed, otherwise false
Slate
bool IsPressed() const
[]
SButton::OnFocusLost
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SButton.h
Called when this widget loses focus. This event does not bubble.
Slate
virtual void OnFocusLost ( const [FFocusEvent](API\Runtime\SlateCore\Input\FFocusEvent) & InFocusEvent )
[]
SButton::OnKeyDown
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SButton.h
Called after a key is pressed when this widget has focus (this event bubbles if not handled) Returns whether the event was handled, along with other possible actions
Slate
virtual [FReply](API\Runtime\SlateCore\Input\FReply) OnKeyDown ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FKeyEvent](API\Runtime\SlateCore\Input\FKeyEvent) & InKeyEvent )
[]
SButton::OnKeyUp
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SButton.h
Called after a key is released when this widget has focus Returns whether the event was handled, along with other possible actions
Slate
virtual [FReply](API\Runtime\SlateCore\Input\FReply) OnKeyUp ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FKeyEvent](API\Runtime\SlateCore\Input\FKeyEvent) & InKeyEvent )
[]
SButton::OnMouseButtonDoubleClick
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SButton.h
Called when a mouse button is double clicked. Override this in derived classes. Returns whether the event was handled, along with other possible actions
Slate
virtual [FReply](API\Runtime\SlateCore\Input\FReply) OnMouseButtonDoubleClick ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & InMyGeometry, const [FPointerEvent](API\Runtime\SlateCore\Input\FPointerEvent) & InMouseEvent )
[]
SButton::OnMouseButtonDown
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SButton.h
MOUSE INPUT The system calls this method to notify the widget that a mouse button was pressed within it. This event is bubbled. Whether the event was handled along with possible requests for the system to take action.
Slate
virtual [FReply](API\Runtime\SlateCore\Input\FReply) OnMouseButtonDown ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FPointerEvent](API\Runtime\SlateCore\Input\FPointerEvent) & MouseEvent )
[]
SButton::OnMouseButtonUp
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SButton.h
The system calls this method to notify the widget that a mouse button was release within it. This event is bubbled. Whether the event was handled along with possible requests for the system to take action.
Slate
virtual [FReply](API\Runtime\SlateCore\Input\FReply) OnMouseButtonUp ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FPointerEvent](API\Runtime\SlateCore\Input\FPointerEvent) & MouseEvent )
[]
SButton::OnMouseCaptureLost
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SButton.h
Called when this widget had captured the mouse, but that capture has been revoked for some reason.
Slate
virtual void OnMouseCaptureLost ( const [FCaptureLostEvent](API\Runtime\SlateCore\Input\FCaptureLostEvent) & CaptureLostEvent )
[]
SButton::OnMouseEnter
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SButton.h
The system will use this event to notify a widget that the cursor has entered it. This event is uses a custom bubble strategy.
Slate
virtual void OnMouseEnter ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FPointerEvent](API\Runtime\SlateCore\Input\FPointerEvent) & MouseEvent )
[]
SButton::OnMouseLeave
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SButton.h
The system will use this event to notify a widget that the cursor has left it. This event is uses a custom bubble strategy.
Slate
virtual void OnMouseLeave ( const [FPointerEvent](API\Runtime\SlateCore\Input\FPointerEvent) & MouseEvent )
[]
SButton::OnMouseMove
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SButton.h
The system calls this method to notify the widget that a mouse moved within it. This event is bubbled. Whether the event was handled along with possible requests for the system to take action.
Slate
virtual [FReply](API\Runtime\SlateCore\Input\FReply) OnMouseMove ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FPointerEvent](API\Runtime\SlateCore\Input\FPointerEvent) & MouseEvent )
[]
SButton::PlayHoverSound
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SButton.h
Play the hovered sound
Slate
void PlayHoverSound() const
[]
SButton::OnPaint
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SButton.h
The widget should respond by populating the OutDrawElements array with FDrawElements that represent it and any of its children. Called by the non-virtual OnPaint to enforce pre/post conditions during OnPaint. The maximum layer ID attained by this widget or any of its children.
Slate
virtual int32 OnPaint ( const [FPaintArgs](API\Runtime\SlateCore\Types\FPaintArgs) & Args, const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & AllottedGeometry, const [FSlateRect](API\Runtime\SlateCore\Layout\FSlateRect) & MyCullingRect, [FSlateWindowElementList](API\Runtime\SlateCore\Rendering\FSlateWindowElementList) & OutDrawElements, int32 LayerId, const [FWidgetStyle](API\Runtime\SlateCore\Styling\FWidgetStyle) & InWidgetStyle, bool bParentEnabled ) const
[]
SButton::PlayPressedSound
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SButton.h
Play the pressed sound
Slate
void PlayPressedSound() const
[]
SButton::Press
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SButton.h
Press the button
Slate
virtual void Press()
[]
PrivateParentType
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SButton.h
Slate
typedef [SBorder](API\Runtime\Slate\Widgets\Layout\SBorder) PrivateParentType
[]
PrivateThisType
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SButton.h
Slate
typedef [SButton](API\Runtime\Slate\Widgets\Input\SButton) PrivateThisType
[]
SButton::Release
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SButton.h
Release the button
Slate
virtual void Release()
[]
SButton::SetAppearPressed
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SButton.h
Set the AppearPressed look.
Slate
void SetAppearPressed ( [TAttribute](API\Runtime\Core\Misc\TAttribute)< bool > InValue )
[]
SButton::SetButtonStyle
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SButton.h
See ButtonStyle attribute
Slate
void SetButtonStyle ( const [FButtonStyle](API\Runtime\SlateCore\Styling\FButtonStyle) * ButtonStyle )
[]
SButton::SetClickMethod
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SButton.h
Slate
void SetClickMethod ( [EButtonClickMethod::Type](API\Runtime\SlateCore\Types\EButtonClickMethod__Type) InClickMethod )
[]
SButton::SetContentPadding
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SButton.h
See ContentPadding attribute
Slate
void SetContentPadding ( [TAttribute](API\Runtime\Core\Misc\TAttribute)< [FMargin](API\Runtime\SlateCore\Layout\FMargin) > InContentPadding )
[]
SButton::SetHoveredSound
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SButton.h
See HoveredSound attribute
Slate
void SetHoveredSound ( [TOptional](API\Runtime\Core\IO\TOptional)< [FSlateSound](API\Runtime\SlateCore\Sound\FSlateSound) > InHoveredSound )
[]
SButton::SetIsFocusable
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SButton.h
Set if this button can be focused
Slate
void SetIsFocusable ( bool bInIsFocusable )
[]
SButton::SetOnClicked
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SButton.h
See OnClicked event
Slate
void SetOnClicked ( FOnClicked InOnClicked )
[]
SButton::SetOnHovered
/Engine/Source/Runtime/Slate/Public/Widgets/Input/SButton.h
Set OnHovered event
Slate
void SetOnHovered ( FSimpleDelegate InOnHovered )
[]