 |
UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
|
|
UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
|
#include "CoreMinimal.h"#include "Misc/Attribute.h"#include "Layout/Visibility.h"#include "Layout/Clipping.h"#include "Widgets/WidgetPixelSnapping.h"#include "Layout/FlowDirection.h"#include "Rendering/SlateRenderTransform.h"#include "GenericPlatform/ICursor.h"#include "Types/ISlateMetaData.h"#include "Trace/SlateMemoryTags.h"#include "Widgets/SNullWidget.h"#include "Widgets/Accessibility/SlateWidgetAccessibleTypes.h"#include "Widgets/SWidget.h"#include "Templates/Identity.h"Go to the source code of this file.
Namespaces | |
| namespace | RequiredArgs |
| #define SArgumentNew | ( | InArgs, | |
| WidgetType, | |||
| ... | |||
| ) | MakeTDecl<WidgetType>( #WidgetType, __FILE__, __LINE__, RequiredArgs::MakeRequiredArgs(__VA_ARGS__) ) <<= InArgs |
| #define SAssignNew | ( | ExposeAs, | |
| WidgetType, | |||
| ... | |||
| ) | MakeTDecl<WidgetType>( #WidgetType, __FILE__, __LINE__, RequiredArgs::MakeRequiredArgs(__VA_ARGS__) ) . Expose( ExposeAs ) <<= TYPENAME_OUTSIDE_TEMPLATE WidgetType::FArguments() |
Use this macro to declare a slate argument. Arguments differ from attributes in that they can only be values
Like SLATE_ARGUMENT, but support a default value. e.g.
SLATE_ARGUMENT_DEFAULT(float, WheelScrollMultiplier) { 1.0f };
| #define SLATE_ARGUMENT_DEPRECATED | ( | ArgType, | |
| ArgName, | |||
| DeprecationVersion, | |||
| DeprecationMessage | |||
| ) |
Use when an argument used to be declared SLATE_ARGUMENT and it should no longer be used
| #define SLATE_ATTRIBUTE | ( | AttrType, | |
| AttrName | |||
| ) |
Use this macro to add a attribute to the declaration of your widget. An attribute can be a value or a function.
| #define SLATE_ATTRIBUTE_DEPRECATED | ( | AttrType, | |
| AttrName, | |||
| DeprecationVersion, | |||
| DeprecationMessage | |||
| ) |
Use when an argument used to be declared SLATE_ATTRIBUTE and it should no longer be used
| #define SLATE_BEGIN_ARGS | ( | InWidgetType | ) |
Widget authors can use SLATE_BEGIN_ARGS and SLATE_END_ARS to add support for widget construction via SNew and SAssignNew. e.g.
SLATE_BEGIN_ARGS( SMyWidget ) , _PreferredWidth( 150.0f ) , _ForegroundColor( FLinearColor::White ) {}
SLATE_ATTRIBUTE(float, PreferredWidth) SLATE_ATTRIBUTE(FSlateColor, ForegroundColor) SLATE_END_ARGS()
| #define SLATE_DEFAULT_SLOT | ( | DeclarationType, | |
| SlotName | |||
| ) |
| #define SLATE_END_ARGS | ( | ) | }; |
| #define SLATE_EVENT | ( | DelegateName, | |
| EventName | |||
| ) |
Use this macro to add event handler support to the declarative syntax of your widget. It is expected that the widget has a delegate called of type 'EventDelegateType' that is named 'EventName'.
| #define SLATE_EVENT_DEPRECATED | ( | DeprecationVersion, | |
| DeprecationMessage, | |||
| DelegateName, | |||
| EventName, | |||
| UpgradedEventName, | |||
| UpgradeFuncName | |||
| ) |
| #define SLATE_NAMED_SLOT | ( | DeclarationType, | |
| SlotName | |||
| ) |
Use this macro to add support for named slot properties such as Content and Header. See NamedSlotProperty for more details.
NOTE: If you're using this within a widget class that is templated, then you might have to specify a full name for the declaration. For example: SLATE_NAMED_SLOT( typename SSuperWidget<T>::Declaration, Content )
| #define SLATE_PRIVATE_ATTRIBUTE_FUNCTION | ( | AttrType, | |
| AttrName | |||
| ) |
| #define SLATE_PRIVATE_ATTRIBUTE_VARIABLE | ( | AttrType, | |
| AttrName | |||
| ) | TAttribute< AttrType > _##AttrName |
| #define SLATE_PRIVATE_SLOT_BEGIN_ARGS | ( | SlotType, | |
| SlotParentType | |||
| ) |
| #define SLATE_SLOT_ARGUMENT | ( | SlotType, | |
| SlotName | |||
| ) |
Use this macro between SLATE_BEGIN_ARGS and SLATE_END_ARGS in order to add support for slots with the construct pattern.
| #define SLATE_SLOT_BEGIN_ARGS | ( | SlotType, | |
| SlotParentType | |||
| ) |
| #define SLATE_SLOT_BEGIN_ARGS_FourMixins | ( | SlotType, | |
| SlotParentType, | |||
| Mixin1, | |||
| Mixin2, | |||
| Mixin3, | |||
| Mixin4 | |||
| ) |
| #define SLATE_SLOT_BEGIN_ARGS_OneMixin | ( | SlotType, | |
| SlotParentType, | |||
| Mixin1 | |||
| ) |
| #define SLATE_SLOT_BEGIN_ARGS_ThreeMixins | ( | SlotType, | |
| SlotParentType, | |||
| Mixin1, | |||
| Mixin2, | |||
| Mixin3 | |||
| ) |
| #define SLATE_SLOT_BEGIN_ARGS_TwoMixins | ( | SlotType, | |
| SlotParentType, | |||
| Mixin1, | |||
| Mixin2 | |||
| ) |
| #define SLATE_SLOT_END_ARGS | ( | ) | }; |
Use this macro to declare a slate style argument. Arguments differ from attributes in that they can only be values
| #define SLATE_STYLE_ARGUMENT_DEPRECATED | ( | ArgType, | |
| ArgName, | |||
| DeprecationVersion, | |||
| DeprecationMessage | |||
| ) |
Use when a style argument used to be declared SLATE_STYLE_ARGUMENT and it should no longer be used
| #define SLATE_SUPPORTS_SLOT | ( | SlotType | ) |
Use this macro between SLATE_BEGIN_ARGS and SLATE_END_ARGS in order to add support for slots.
| #define SLATE_SUPPORTS_SLOT_WITH_ARGS | ( | SlotType | ) |
Use this macro between SLATE_BEGIN_ARGS and SLATE_END_ARGS in order to add support for slots that have slate args.
| #define SLATE_USER_ARGS | ( | WidgetType | ) |
Just like SLATE_BEGIN_ARGS but requires the user to implement the New() method in the .CPP. Allows for widget implementation details to be entirely reside in the .CPP file. e.g.
SLATE_USER_ARGS( SMyWidget ) {} SLATE_END_ARGS()
virtual void DoStuff() = nullptr;
namespace Implementation{ class SMyWidget : public SMyWidget{ void Construct( const FArguments& InArgs ) { SUserWidget::Construct( SUSerWidget::FArguments() [ SNew(STextBlock) .Text( "Implementation Details!" ) ] ); }
virtual void DoStuff() override {}
// Truly private. All handlers can be inlined (less boilerplate). // All private members are truly private. private: FReply OnButtonClicked { } TSharedPtr<SButton> MyButton; } }
| #define SNew | ( | WidgetType, | |
| ... | |||
| ) | MakeTDecl<WidgetType>( #WidgetType, __FILE__, __LINE__, RequiredArgs::MakeRequiredArgs(__VA_ARGS__) ) <<= TYPENAME_OUTSIDE_TEMPLATE WidgetType::FArguments() |
Slate widgets are constructed through SNew and SAssignNew. e.g.
TSharedRef<SButton> MyButton = SNew(SButton); or TSharedPtr<SButton> MyButton; SAssignNew( MyButton, SButton );
Using SNew and SAssignNew ensures that widgets are populated
| TSlateDecl< WidgetType, RequiredArgsPayloadType > MakeTDecl | ( | const ANSICHAR * | InType, |
| const ANSICHAR * | InFile, | ||
| int32 | OnLine, | ||
| RequiredArgsPayloadType && | InRequiredArgs | ||
| ) |
1.9.8