UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
WidgetStateRegistration.h
Go to the documentation of this file.
1// Copyright Epic Games, Inc. All Rights Reserved.
2
3#pragma once
4
5#include "CoreMinimal.h"
6#include "UObject/Object.h"
9
10#include "WidgetStateRegistration.generated.h"
11
12class UWidget;
14
21UCLASS(Transient, MinimalAPI)
23{
25
26public:
29
31 UMG_API virtual FName GetStateName() const;
32
34 UMG_API virtual bool GetRegisteredWidgetState(const UWidget* InWidget) const;
35
36protected:
38
40 UMG_API virtual void InitializeStaticBitfields() const;
41};
42
43UCLASS(Transient, MinimalAPI)
45{
47
48public:
49
52
53 static const inline FName StateName = FName("Hovered");
54
55 //~ Begin UWidgetBinaryStateRegistration Interface.
56 UMG_API virtual FName GetStateName() const override;
57 UMG_API virtual bool GetRegisteredWidgetState(const UWidget* InWidget) const override;
58 //~ End UWidgetBinaryStateRegistration Interface
59
60protected:
62
63 //~ Begin UWidgetBinaryStateRegistration Interface.
64 UMG_API virtual void InitializeStaticBitfields() const override;
65 //~ End UWidgetBinaryStateRegistration Interface
66};
67
68UCLASS(Transient, MinimalAPI)
70{
72
73public:
74
77
78 static const inline FName StateName = FName("Pressed");
79
80 //~ Begin UWidgetBinaryStateRegistration Interface.
81 UMG_API virtual FName GetStateName() const override;
82 UMG_API virtual bool GetRegisteredWidgetState(const UWidget* InWidget) const override;
83 //~ End UWidgetBinaryStateRegistration Interface
84
85protected:
87
88 //~ Begin UWidgetBinaryStateRegistration Interface.
89 UMG_API virtual void InitializeStaticBitfields() const override;
90 //~ End UWidgetBinaryStateRegistration Interface
91};
92
93UCLASS(Transient, MinimalAPI)
95{
97
98public:
99
102
103 static const inline FName StateName = FName("Disabled");
104
105 //~ Begin UWidgetBinaryStateRegistration Interface.
106 UMG_API virtual FName GetStateName() const override;
107 UMG_API virtual bool GetRegisteredWidgetState(const UWidget* InWidget) const override;
108 //~ End UWidgetBinaryStateRegistration Interface
109
110protected:
112
113 //~ Begin UWidgetBinaryStateRegistration Interface.
114 UMG_API virtual void InitializeStaticBitfields() const override;
115 //~ End UWidgetBinaryStateRegistration Interface
116};
117
118UCLASS(Transient, MinimalAPI)
120{
122
123public:
124
127
128 static const inline FName StateName = FName("Selected");
129
130 //~ Begin UWidgetBinaryStateRegistration Interface.
131 UMG_API virtual FName GetStateName() const override;
132 UMG_API virtual bool GetRegisteredWidgetState(const UWidget* InWidget) const override;
133 //~ End UWidgetBinaryStateRegistration Interface
134
135protected:
137
138 //~ Begin UWidgetBinaryStateRegistration Interface.
139 UMG_API virtual void InitializeStaticBitfields() const override;
140 //~ End UWidgetBinaryStateRegistration Interface
141};
142
146UCLASS(Transient, MinimalAPI)
148{
150
151public:
153 virtual ~UWidgetEnumStateRegistration() = default;
154
156 UMG_API virtual FName GetStateName() const;
157
159 UMG_API virtual bool GetRegisteredWidgetUsesState(const UWidget* InWidget) const;
160
162 UMG_API virtual uint8 GetRegisteredWidgetState(const UWidget* InWidget) const;
163
164protected:
166
168 UMG_API virtual void InitializeStaticBitfields() const;
169};
UE_FORCEINLINE_HINT TSharedRef< CastToType, Mode > StaticCastSharedRef(TSharedRef< CastFromType, Mode > const &InSharedRef)
Definition SharedPointer.h:127
#define GENERATED_BODY(...)
Definition ObjectMacros.h:765
#define UCLASS(...)
Definition ObjectMacros.h:776
uint8_t uint8
Definition binka_ue_file_header.h:8
Definition NameTypes.h:617
Definition Object.h:95
Definition WidgetStateRegistration.h:23
friend UWidgetStateSettings
Definition WidgetStateRegistration.h:37
virtual ~UWidgetBinaryStateRegistration()=default
Definition WidgetStateRegistration.h:95
static UMG_API FWidgetStateBitfield Bit
Definition WidgetStateRegistration.h:101
friend UWidgetStateSettings
Definition WidgetStateRegistration.h:111
Definition WidgetStateRegistration.h:148
virtual ~UWidgetEnumStateRegistration()=default
friend UWidgetStateSettings
Definition WidgetStateRegistration.h:165
Definition WidgetStateRegistration.h:45
friend UWidgetStateSettings
Definition WidgetStateRegistration.h:61
static UMG_API FWidgetStateBitfield Bit
Definition WidgetStateRegistration.h:51
Definition WidgetStateRegistration.h:70
static UMG_API FWidgetStateBitfield Bit
Definition WidgetStateRegistration.h:76
friend UWidgetStateSettings
Definition WidgetStateRegistration.h:86
Definition WidgetStateRegistration.h:120
static UMG_API FWidgetStateBitfield Bit
Definition WidgetStateRegistration.h:126
friend UWidgetStateSettings
Definition WidgetStateRegistration.h:136
Definition WidgetStateSettings.h:27
Definition Widget.h:217
Definition WidgetStateBitfield.h:23