Navigation
API > API/Runtime > API/Runtime/UMG
This is the base class to for UI Components that can be added to any UMG Widgets in UMG Designer.When initialized, it will pass the widget it's attached to.
| Name | UUIComponent |
| Type | class |
| Header File | /Engine/Source/Runtime/UMG/Public/Extensions/UIComponent.h |
| Include Path | #include "Extensions/UIComponent.h" |
Syntax
UCLASS (Abstract, MinimalAPI, CustomFieldNotify)
class UUIComponent :
public UObject ,
public INotifyFieldValueChanged
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UUIComponent
Implements Interfaces
Derived Classes
Structs
| Name | Remarks |
|---|---|
| FFieldNotificationClassDescriptor |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bInitialized | bool | Extensions/UIComponent.h | ||
| Delegates | UE::FieldNotification::FFieldMulticastDelegate | Extensions/UIComponent.h |
|
|
| Owner | TWeakObjectPtr< UWidget > | Extensions/UIComponent.h |
|
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void Construct() |
Called when the owner widget is constructed. | Extensions/UIComponent.h | |
void Destruct() |
Called when the owner widget is destructed. | Extensions/UIComponent.h | |
TWeakObjectPtr< UWidget > GetOwner() |
Returns the Owner Widget this component is attached to. | Extensions/UIComponent.h | |
| Called when a graph owned by the user widget is renamed. | Extensions/UIComponent.h | ||
void Initialize
(
UWidget* Target |
Called when the owner widget is initialized. | Extensions/UIComponent.h | |
void PreConstruct
(
bool bIsDesignTime |
Called when the owner widget is pre-constructed. Called in both Editor and runtime. | Extensions/UIComponent.h | |
virtual TSharedRef< SWidget > RebuildWidgetWithContent
(
TSharedRef< SWidget > Content |
Called when the OwnerWidget is Rebuilt to allow to build a more complex hierarchy between the owner parents and the Owner widget. | Extensions/UIComponent.h |
Overridden from INotifyFieldValueChanged
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FDelegateHandle AddFieldValueChangedDelegate
(
UE::FieldNotification::FFieldId InFieldId, |
Extensions/UIComponent.h | ||
virtual void BroadcastFieldValueChanged
(
UE::FieldNotification::FFieldId InFieldId |
Extensions/UIComponent.h | ||
virtual const UE::FieldNotification::IClassDescriptor & GetFieldNotificationDescriptor() |
Extensions/UIComponent.h | ||
virtual int32 RemoveAllFieldValueChangedDelegates
(
FDelegateUserObjectConst InUserObject |
Extensions/UIComponent.h | ||
virtual int32 RemoveAllFieldValueChangedDelegates
(
UE::FieldNotification::FFieldId InFieldId, |
Extensions/UIComponent.h | ||
virtual bool RemoveFieldValueChangedDelegate
(
UE::FieldNotification::FFieldId InFieldId, |
Extensions/UIComponent.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void OnConstruct() |
Extensions/UIComponent.h | ||
virtual void OnDestruct() |
Extensions/UIComponent.h | ||
| Extensions/UIComponent.h | |||
virtual void OnInitialize() |
Extensions/UIComponent.h | ||
virtual void OnPreConstruct
(
bool bIsDesignTime |
Extensions/UIComponent.h |