UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
UWidget Class Reference

#include <Widget.h>

+ Inheritance diagram for UWidget:

Public Types

typedef TFunctionRef< TSharedPtr< SObjectWidget >(UUserWidget *, TSharedRef< SWidget >)> ConstructMethodType
 
- Public Types inherited from UObject
enum class  ENetFields_Private { NETFIELD_REP_START = 0 , NETFIELD_REP_END = -1 }
 
typedef UObject WithinClass
 
- Public Types inherited from INotifyFieldValueChanged
using FFieldValueChangedDelegate = TDelegate< void(UObject *, UE::FieldNotification::FFieldId), FNotThreadSafeNotCheckedDelegateUserPolicy >
 

Public Member Functions

 UE_FIELD_NOTIFICATION_DECLARE_CLASS_DESCRIPTOR_BASE_END ()
 
 DECLARE_DYNAMIC_DELEGATE_RetVal (bool, FGetBool)
 
 DECLARE_DYNAMIC_DELEGATE_RetVal (float, FGetFloat)
 
 DECLARE_DYNAMIC_DELEGATE_RetVal (int32, FGetInt32)
 
 DECLARE_DYNAMIC_DELEGATE_RetVal (FText, FGetText)
 
 DECLARE_DYNAMIC_DELEGATE_RetVal (FSlateColor, FGetSlateColor)
 
 DECLARE_DYNAMIC_DELEGATE_RetVal (FLinearColor, FGetLinearColor)
 
 DECLARE_DYNAMIC_DELEGATE_RetVal (FSlateBrush, FGetSlateBrush)
 
 DECLARE_DYNAMIC_DELEGATE_RetVal (ESlateVisibility, FGetSlateVisibility)
 
 DECLARE_DYNAMIC_DELEGATE_RetVal (EMouseCursor::Type, FGetMouseCursor)
 
 DECLARE_DYNAMIC_DELEGATE_RetVal (ECheckBoxState, FGetCheckBoxState)
 
 DECLARE_DYNAMIC_DELEGATE_RetVal (UWidget *, FGetWidget)
 
 DECLARE_DYNAMIC_DELEGATE_RetVal_OneParam (UWidget *, FGenerateWidgetForString, FString, Item)
 
 DECLARE_DYNAMIC_DELEGATE_RetVal_OneParam (UWidget *, FGenerateWidgetForObject, UObject *, Item)
 
 DECLARE_DYNAMIC_DELEGATE_RetVal (FEventReply, FOnReply)
 
 DECLARE_DYNAMIC_DELEGATE_RetVal_TwoParams (FEventReply, FOnPointerEvent, FGeometry, MyGeometry, const FPointerEvent &, MouseEvent)
 
 DECLARE_MULTICAST_DELEGATE_TwoParams (FOnWidgetStateBroadcast, UWidget *, const FWidgetStateBitfield &)
 
UMG_API const FWidgetTransformGetRenderTransform () const
 
UMG_API void SetRenderTransform (FWidgetTransform InTransform)
 
UMG_API void SetRenderScale (FVector2D Scale)
 
UMG_API void SetRenderShear (FVector2D Shear)
 
UMG_API void SetRenderTransformAngle (float Angle)
 
UMG_API float GetRenderTransformAngle () const
 
UMG_API void SetRenderTranslation (FVector2D Translation)
 
UMG_API FVector2D GetRenderTransformPivot () const
 
UMG_API void SetRenderTransformPivot (FVector2D Pivot)
 
UMG_API EFlowDirectionPreference GetFlowDirectionPreference () const
 
UMG_API void SetFlowDirectionPreference (EFlowDirectionPreference FlowDirection)
 
UMG_API bool GetIsEnabled () const
 
virtual UMG_API void SetIsEnabled (bool bInIsEnabled)
 
UMG_API bool IsInViewport () const
 
UMG_API FText GetToolTipText () const
 
UMG_API void SetToolTipText (const FText &InToolTipText)
 
UMG_API UWidgetGetToolTip () const
 
UMG_API void SetToolTip (UWidget *Widget)
 
UMG_API EMouseCursor::Type GetCursor () const
 
UMG_API void SetCursor (EMouseCursor::Type InCursor)
 
UMG_API void ResetCursor ()
 
UMG_API bool IsRendered () const
 
UMG_API bool IsVisible () const
 
UMG_API ESlateVisibility GetVisibility () const
 
virtual UMG_API void SetVisibility (ESlateVisibility InVisibility)
 
UMG_API float GetRenderOpacity () const
 
UMG_API void SetRenderOpacity (float InOpacity)
 
UMG_API EWidgetClipping GetClipping () const
 
UMG_API void SetClipping (EWidgetClipping InClipping)
 
UMG_API EWidgetPixelSnapping GetPixelSnapping () const
 
UMG_API void SetPixelSnapping (EWidgetPixelSnapping InPixelSnapping)
 
UMG_API void ForceVolatile (bool bForce)
 
virtual UMG_API bool IsHovered () const
 
UMG_API bool HasKeyboardFocus () const
 
UMG_API bool HasMouseCapture () const
 
UMG_API bool HasMouseCaptureByUser (int32 UserIndex, int32 PointerIndex=-1) const
 
UMG_API void SetKeyboardFocus ()
 
UMG_API bool HasUserFocus (APlayerController *PlayerController) const
 
UMG_API bool HasAnyUserFocus () const
 
UMG_API bool HasFocusedDescendants () const
 
UMG_API bool HasUserFocusedDescendants (APlayerController *PlayerController) const
 
UMG_API void SetFocus ()
 
UMG_API void SetUserFocus (APlayerController *PlayerController)
 
UMG_API void ForceLayoutPrepass ()
 
UMG_API void InvalidateLayoutAndVolatility ()
 
UMG_API FVector2D GetDesiredSize () const
 
UMG_API void SetAllNavigationRules (EUINavigationRule Rule, FName WidgetToFocus)
 
UMG_API void SetNavigationRule (EUINavigation Direction, EUINavigationRule Rule, FName WidgetToFocus)
 
UMG_API void SetNavigationRuleBase (EUINavigation Direction, EUINavigationRule Rule)
 
UMG_API void SetNavigationRuleExplicit (EUINavigation Direction, UWidget *InWidget)
 
UMG_API void SetNavigationRuleCustom (EUINavigation Direction, FCustomWidgetNavigationDelegate InCustomDelegate)
 
UMG_API void SetNavigationRuleCustomBoundary (EUINavigation Direction, FCustomWidgetNavigationDelegate InCustomDelegate)
 
UMG_API void SetNavigationMethod (const TInstancedStruct< FNavigationMethod > &NavigationMethod)
 
UMG_API class UPanelWidgetGetParent () const
 
virtual UMG_API void RemoveFromParent ()
 
UMG_API const FGeometryGetCachedGeometry () const
 
UMG_API const FGeometryGetTickSpaceGeometry () const
 
UMG_API const FGeometryGetPaintSpaceGeometry () const
 
virtual UMG_API FDelegateHandle AddFieldValueChangedDelegate (UE::FieldNotification::FFieldId InFieldId, FFieldValueChangedDelegate InNewDelegate) override final
 
virtual UMG_API bool RemoveFieldValueChangedDelegate (UE::FieldNotification::FFieldId InFieldId, FDelegateHandle InHandle) override final
 
virtual UMG_API int32 RemoveAllFieldValueChangedDelegates (FDelegateUserObjectConst InUserObject) override final
 
virtual UMG_API int32 RemoveAllFieldValueChangedDelegates (UE::FieldNotification::FFieldId InFieldId, FDelegateUserObjectConst InUserObject) override final
 
virtual UMG_API void BroadcastFieldValueChanged (UE::FieldNotification::FFieldId InFieldId) override final
 
UMG_API void K2_AddFieldValueChangedDelegate (FFieldNotificationId FieldId, FFieldValueChangedDynamicDelegate Delegate)
 
UMG_API void K2_RemoveFieldValueChangedDelegate (FFieldNotificationId FieldId, FFieldValueChangedDynamicDelegate Delegate)
 
UMG_API TSharedRef< SWidgetTakeWidget ()
 
template<class WidgetType = SObjectWidget>
TSharedRef< WidgetType > TakeDerivedWidget (ConstructMethodType ConstructMethod)
 
UMG_API TSharedPtr< SWidgetGetCachedWidget () const
 
UMG_API TSharedPtr< SWidgetGetCachedWrappedWidget () const
 
UMG_API bool IsConstructed () const
 
UMG_API UGameInstanceGetGameInstance () const
 
template<class TGameInstance = UGameInstance>
TGameInstanceGetGameInstance () const
 
virtual UMG_API APlayerControllerGetOwningPlayer () const
 
template<class TPlayerController = APlayerController>
TPlayerControllerGetOwningPlayer () const
 
virtual UMG_API ULocalPlayerGetOwningLocalPlayer () const
 
template<class T >
T * GetOwningLocalPlayer () const
 
UMG_API FText GetAccessibleText () const
 
UMG_API FText GetAccessibleSummaryText () const
 
virtual UMG_API void SynchronizeProperties ()
 
UMG_API void BuildNavigation ()
 
bool IsDesignTime () const
 
bool IsPreviewTime () const
 
UMG_API bool IsChildOf (UWidget *PossibleParent)
 
UMG_API bool AddBinding (FDelegateProperty *DelegateProperty, UObject *SourceObject, const FDynamicPropertyPath &BindingPath)
 
UMG_API FDelegateHandle RegisterPostStateListener (const FOnWidgetStateBroadcast::FDelegate &ListenerDelegate, bool bBroadcastCurrentState=true)
 
UMG_API void UnregisterPostStateListener (const FDelegateHandle &ListenerDelegate)
 
virtual UMG_API UWorldGetWorld () const override
 
virtual UMG_API void BeginDestroy () override
 
virtual UMG_API void FinishDestroy () override
 
virtual UMG_API void PreSave (FObjectPreSaveContext ObjectSaveContext) override
 
bool CanSafelyRouteEvent ()
 
bool CanSafelyRoutePaint ()
 
- Public Member Functions inherited from UVisual
virtual UMG_API void ReleaseSlateResources (bool bReleaseChildren)
 
virtual UMG_API bool NeedsLoadForServer () const override
 
- Public Member Functions inherited from UObject
COREUOBJECT_API UObject ()
 
COREUOBJECT_API UObject (const FObjectInitializer &ObjectInitializer)
 
COREUOBJECT_API UObject (EStaticConstructor, EObjectFlags InFlags)
 
COREUOBJECT_API UObject (FVTableHelper &Helper)
 
COREUOBJECT_API UObjectCreateDefaultSubobject (FName SubobjectFName, UClass *ReturnType, UClass *ClassToCreateByDefault, bool bIsRequired, bool bIsTransient)
 
template<class TReturnType >
TReturnTypeCreateEditorOnlyDefaultSubobject (FName SubobjectName, bool bTransient=false)
 
template<class TReturnType >
TReturnTypeCreateDefaultSubobject (FName SubobjectName, bool bTransient=false)
 
template<class TReturnType , class TClassToConstructByDefault >
TReturnTypeCreateDefaultSubobject (FName SubobjectName, bool bTransient=false)
 
template<class TReturnType >
TReturnTypeCreateOptionalDefaultSubobject (FName SubobjectName, bool bTransient=false)
 
template<class TReturnType , class TClassToConstructByDefault >
TReturnTypeCreateOptionalDefaultSubobject (FName SubobjectName, bool bTransient=false)
 
COREUOBJECT_API void GetDefaultSubobjects (TArray< UObject * > &OutDefaultSubobjects)
 
COREUOBJECT_API UObjectGetDefaultSubobjectByName (FName ToFind)
 
virtual COREUOBJECT_API void PostInitProperties ()
 
virtual COREUOBJECT_API void PostReinitProperties ()
 
virtual void PostCDOContruct ()
 
virtual COREUOBJECT_API void PreSaveRoot (FObjectPreSaveRootContext ObjectSaveContext)
 
virtual COREUOBJECT_API void PostSaveRoot (FObjectPostSaveRootContext ObjectSaveContext)
 
virtual COREUOBJECT_API void CollectSaveOverrides (FObjectCollectSaveOverridesContext SaveContext)
 
UE_FORCEINLINE_HINT bool Modify (bool bAlwaysMarkDirty=true)
 
UE_FORCEINLINE_HINT bool IsCapturingAsRootObjectForTransaction () const
 
virtual bool ResolveSubobject (const TCHAR *SubObjectPath, UObject *&OutObject, bool bLoadIfExists)
 
virtual bool IsReadyForAsyncPostLoad () const
 
virtual COREUOBJECT_API void PostLoad ()
 
virtual COREUOBJECT_API void PostLoadSubobjects (FObjectInstancingGraph *OuterInstanceGraph)
 
virtual bool IsReadyForFinishDestroy ()
 
virtual COREUOBJECT_API void Serialize (FArchive &Ar)
 
virtual COREUOBJECT_API void Serialize (FStructuredArchive::FRecord Record)
 
virtual void ShutdownAfterError ()
 
virtual void PostInterpChange (FProperty *PropertyThatChanged)
 
virtual COREUOBJECT_API void PostRename (UObject *OldOuter, const FName OldName)
 
virtual void PreDuplicate (FObjectDuplicationParameters &DupParams)
 
virtual void PostDuplicate (bool bDuplicateForPIE)
 
virtual void PostDuplicate (EDuplicateMode::Type DuplicateMode)
 
virtual COREUOBJECT_API bool NeedsLoadForClient () const
 
virtual COREUOBJECT_API bool NeedsLoadForTargetPlatform (const class ITargetPlatform *TargetPlatform) const
 
virtual bool NeedsLoadForEditorGame () const
 
virtual bool IsEditorOnly () const
 
virtual bool HasNonEditorOnlyReferences () const
 
virtual bool IsPostLoadThreadSafe () const
 
virtual COREUOBJECT_API bool IsDestructionThreadSafe () const
 
virtual COREUOBJECT_API void GetPreloadDependencies (TArray< UObject * > &OutDeps)
 
virtual void GetPrestreamPackages (TArray< UObject * > &OutPrestream)
 
virtual void ExportCustomProperties (FOutputDevice &Out, uint32 Indent)
 
virtual void ImportCustomProperties (const TCHAR *SourceText, FFeedbackContext *Warn)
 
virtual void PostEditImport ()
 
virtual void PostReloadConfig (class FProperty *PropertyThatWasLoaded)
 
virtual COREUOBJECT_API bool Rename (const TCHAR *NewName=nullptr, UObject *NewOuter=nullptr, ERenameFlags Flags=REN_None)
 
virtual FString GetDesc ()
 
COREUOBJECT_API UScriptStructGetSparseClassDataStruct () const
 
virtual bool GetNativePropertyValues (TMap< FString, FString > &out_PropertyValues, uint32 ExportFlags=0) const
 
virtual COREUOBJECT_API void GetResourceSizeEx (FResourceSizeEx &CumulativeResourceSize)
 
SIZE_T GetResourceSizeBytes (EResourceSizeMode::Type Mode)
 
virtual FName GetExporterName (void)
 
COREUOBJECT_API void CallAddReferencedObjects (FReferenceCollector &Collector)
 
virtual FRestoreForUObjectOverwriteGetRestoreForUObjectOverwrite ()
 
virtual bool AreNativePropertiesIdenticalTo (UObject *Other) const
 
virtual COREUOBJECT_API void GetAssetRegistryTags (FAssetRegistryTagsContext Context) const
 
virtual COREUOBJECT_API void GetAssetRegistryTags (TArray< FAssetRegistryTag > &OutTags) const
 
COREUOBJECT_API void GetAssetRegistryTags (FAssetData &Out) const
 
COREUOBJECT_API void GetAssetRegistryTags (FAssetRegistryTagsContext Context, FAssetData &Out) const
 
virtual COREUOBJECT_API bool IsAsset () const
 
virtual COREUOBJECT_API FPrimaryAssetId GetPrimaryAssetId () const
 
virtual COREUOBJECT_API bool IsLocalizedResource () const
 
virtual COREUOBJECT_API bool IsSafeForRootSet () const
 
virtual COREUOBJECT_API void TagSubobjects (EObjectFlags NewFlags)
 
virtual COREUOBJECT_API void GetLifetimeReplicatedProps (TArray< class FLifetimeProperty > &OutLifetimeProps) const
 
virtual COREUOBJECT_API void GetReplicatedCustomConditionState (FCustomPropertyConditionState &OutActiveState) const
 
virtual COREUOBJECT_API void RegisterReplicationFragments (UE::Net::FFragmentRegistrationContext &Context, UE::Net::EFragmentRegistrationFlags RegistrationFlags)
 
virtual COREUOBJECT_API bool IsNameStableForNetworking () const
 
virtual COREUOBJECT_API bool IsFullNameStableForNetworking () const
 
virtual COREUOBJECT_API bool IsSupportedForNetworking () const
 
virtual void GetSubobjectsWithStableNamesForNetworking (TArray< UObject * > &ObjList)
 
virtual COREUOBJECT_API void PreNetReceive ()
 
virtual COREUOBJECT_API void PostNetReceive ()
 
virtual void PostRepNotifies ()
 
virtual COREUOBJECT_API void PreDestroyFromReplication ()
 
COREUOBJECT_API bool IsSelected () const
 
COREUOBJECT_API void SerializeScriptProperties (FArchive &Ar) const
 
COREUOBJECT_API void SerializeScriptProperties (FStructuredArchive::FSlot Slot) const
 
COREUOBJECT_API void ReinitializeProperties (UObject *SourceObject=NULL, struct FObjectInstancingGraph *InstanceGraph=NULL)
 
COREUOBJECT_API FString GetDetailedInfo () const
 
COREUOBJECT_API bool ConditionalBeginDestroy ()
 
COREUOBJECT_API bool ConditionalFinishDestroy ()
 
COREUOBJECT_API void ConditionalPostLoad ()
 
COREUOBJECT_API void ConditionalPreload ()
 
COREUOBJECT_API void ConditionalPostLoadSubobjects (struct FObjectInstancingGraph *OuterInstanceGraph=NULL)
 
bool IsBasedOnArchetype (const UObject *const SomeObject) const
 
COREUOBJECT_API UFunctionFindFunction (FName InName) const
 
COREUOBJECT_API UFunctionFindFunctionChecked (FName InName) const
 
virtual COREUOBJECT_API void BuildSubobjectMapping (UObject *OtherObject, TMap< UObject *, UObject * > &ObjectMapping) const
 
COREUOBJECT_API void CollectDefaultSubobjects (TArray< UObject * > &OutDefaultSubobjects, bool bIncludeNestedSubobjects=false) const
 
COREUOBJECT_API bool CheckDefaultSubobjects (bool bForceCheck=false) const
 
COREUOBJECT_API void SaveConfig (uint64 RequiredPropertyFlags=CPF_Config, const TCHAR *Filename=nullptr, FConfigCacheIni *Config=GConfig, bool bAllowCopyToDefaultObject=true)
 
COREUOBJECT_API void SaveConfig (const FSaveConfigContext &Context)
 
COREUOBJECT_API void UpdateDefaultConfigFile (const FString &SpecificFileLocation="")
 
COREUOBJECT_API bool TryUpdateDefaultConfigFile (const FString &SpecificFileLocation="", bool bWarnIfFail=true)
 
COREUOBJECT_API void UpdateGlobalUserConfigFile ()
 
COREUOBJECT_API void UpdateProjectUserConfigFile ()
 
COREUOBJECT_API void UpdateSinglePropertyInConfigFile (const FProperty *InProperty, const FString &InConfigIniName)
 
COREUOBJECT_API FString GetDefaultConfigFilename () const
 
COREUOBJECT_API FString GetGlobalUserConfigFilename () const
 
COREUOBJECT_API FString GetProjectUserConfigFilename () const
 
virtual const TCHARGetConfigOverridePlatform () const
 
virtual void OverrideConfigSection (FString &SectionName)
 
virtual void OverridePerObjectConfigSection (FString &SectionName)
 
COREUOBJECT_API void LoadConfig (UClass *ConfigClass=nullptr, const TCHAR *Filename=nullptr, uint32 PropagationFlags=UE::LCPF_None, class FProperty *PropertyToLoad=nullptr, TArray< UE::ConfigAccessTracking::FConfigAccessData > *OutAccessedKeys=nullptr)
 
COREUOBJECT_API void ReloadConfig (UClass *ConfigClass=NULL, const TCHAR *Filename=NULL, uint32 PropagationFlags=UE::LCPF_None, class FProperty *PropertyToLoad=NULL)
 
COREUOBJECT_API void ParseParms (const TCHAR *Parms)
 
COREUOBJECT_API void OutputReferencers (FOutputDevice &Ar, FReferencerInformationList *Referencers=NULL)
 
COREUOBJECT_API void RetrieveReferencers (TArray< FReferencerInformation > *OutInternalReferencers, TArray< FReferencerInformation > *OutExternalReferencers)
 
COREUOBJECT_API void SetLinker (FLinkerLoad *LinkerLoad, int32 LinkerIndex, bool bShouldDetachExisting=true, bool bSilenceLogs=false)
 
COREUOBJECT_API UObjectGetArchetype () const
 
COREUOBJECT_API void GetArchetypeInstances (TArray< UObject * > &Instances)
 
COREUOBJECT_API void InstanceSubobjectTemplates (struct FObjectInstancingGraph *InstanceGraph=NULL)
 
template<class T >
bool Implements () const
 
virtual COREUOBJECT_API void ProcessEvent (UFunction *Function, void *Parms)
 
virtual int32 GetFunctionCallspace (UFunction *Function, FFrame *Stack)
 
virtual bool CallRemoteFunction (UFunction *Function, void *Parms, struct FOutParmRec *OutParms, FFrame *Stack)
 
COREUOBJECT_API bool CallFunctionByNameWithArguments (const TCHAR *Cmd, FOutputDevice &Ar, UObject *Executor, bool bForceCallWithNonExec=false)
 
COREUOBJECT_API void CallFunction (FFrame &Stack, RESULT_DECL, UFunction *Function)
 
 DECLARE_FUNCTION (ProcessInternal)
 
virtual bool ProcessConsoleExec (const TCHAR *Cmd, FOutputDevice &Ar, UObject *Executor)
 
COREUOBJECT_API void SkipFunction (FFrame &Stack, RESULT_DECL, UFunction *Function)
 
virtual UClassRegenerateClass (UClass *ClassToRegenerate, UObject *PreviousCDO)
 
COREUOBJECT_API bool IsInBlueprint () const
 
COREUOBJECT_API void DestroyNonNativeProperties ()
 
virtual void MarkAsEditorOnlySubobject ()
 
COREUOBJECT_API void AbortInsideMemberFunction () const
 
 DECLARE_FUNCTION (execUndefined)
 
 DECLARE_FUNCTION (execLocalVariable)
 
 DECLARE_FUNCTION (execInstanceVariable)
 
 DECLARE_FUNCTION (execDefaultVariable)
 
 DECLARE_FUNCTION (execLocalOutVariable)
 
 DECLARE_FUNCTION (execInterfaceVariable)
 
 DECLARE_FUNCTION (execClassSparseDataVariable)
 
 DECLARE_FUNCTION (execInterfaceContext)
 
 DECLARE_FUNCTION (execArrayElement)
 
 DECLARE_FUNCTION (execBoolVariable)
 
 DECLARE_FUNCTION (execClassDefaultVariable)
 
 DECLARE_FUNCTION (execEndFunctionParms)
 
 DECLARE_FUNCTION (execNothing)
 
 DECLARE_FUNCTION (execNothingInt32)
 
 DECLARE_FUNCTION (execNothingOp4a)
 
 DECLARE_FUNCTION (execBreakpoint)
 
 DECLARE_FUNCTION (execTracepoint)
 
 DECLARE_FUNCTION (execWireTracepoint)
 
 DECLARE_FUNCTION (execInstrumentation)
 
 DECLARE_FUNCTION (execEndOfScript)
 
 DECLARE_FUNCTION (execReturnNothing)
 
 DECLARE_FUNCTION (execEmptyParmValue)
 
 DECLARE_FUNCTION (execJump)
 
 DECLARE_FUNCTION (execJumpIfNot)
 
 DECLARE_FUNCTION (execAssert)
 
 DECLARE_FUNCTION (execPushExecutionFlow)
 
 DECLARE_FUNCTION (execPopExecutionFlow)
 
 DECLARE_FUNCTION (execComputedJump)
 
 DECLARE_FUNCTION (execPopExecutionFlowIfNot)
 
 DECLARE_FUNCTION (execLet)
 
 DECLARE_FUNCTION (execLetObj)
 
 DECLARE_FUNCTION (execLetWeakObjPtr)
 
 DECLARE_FUNCTION (execLetBool)
 
 DECLARE_FUNCTION (execLetDelegate)
 
 DECLARE_FUNCTION (execLetMulticastDelegate)
 
 DECLARE_FUNCTION (execAddMulticastDelegate)
 
 DECLARE_FUNCTION (execClearMulticastDelegate)
 
 DECLARE_FUNCTION (execEatReturnValue)
 
 DECLARE_FUNCTION (execRemoveMulticastDelegate)
 
 DECLARE_FUNCTION (execSelf)
 
 DECLARE_FUNCTION (execContext)
 
 DECLARE_FUNCTION (execContext_FailSilent)
 
 DECLARE_FUNCTION (execStructMemberContext)
 
 DECLARE_FUNCTION (execVirtualFunction)
 
 DECLARE_FUNCTION (execFinalFunction)
 
 DECLARE_FUNCTION (execLocalVirtualFunction)
 
 DECLARE_FUNCTION (execLocalFinalFunction)
 
 DECLARE_FUNCTION (execStructCmpEq)
 
 DECLARE_FUNCTION (execStructCmpNe)
 
 DECLARE_FUNCTION (execStructMember)
 
 DECLARE_FUNCTION (execEqualEqual_DelegateDelegate)
 
 DECLARE_FUNCTION (execNotEqual_DelegateDelegate)
 
 DECLARE_FUNCTION (execEqualEqual_DelegateFunction)
 
 DECLARE_FUNCTION (execNotEqual_DelegateFunction)
 
 DECLARE_FUNCTION (execIntConst)
 
 DECLARE_FUNCTION (execInt64Const)
 
 DECLARE_FUNCTION (execUInt64Const)
 
 DECLARE_FUNCTION (execSkipOffsetConst)
 
 DECLARE_FUNCTION (execFloatConst)
 
 DECLARE_FUNCTION (execDoubleConst)
 
 DECLARE_FUNCTION (execStringConst)
 
 DECLARE_FUNCTION (execUnicodeStringConst)
 
 DECLARE_FUNCTION (execTextConst)
 
 DECLARE_FUNCTION (execPropertyConst)
 
 DECLARE_FUNCTION (execObjectConst)
 
 DECLARE_FUNCTION (execSoftObjectConst)
 
 DECLARE_FUNCTION (execFieldPathConst)
 
 DECLARE_FUNCTION (execInstanceDelegate)
 
 DECLARE_FUNCTION (execNameConst)
 
 DECLARE_FUNCTION (execByteConst)
 
 DECLARE_FUNCTION (execIntZero)
 
 DECLARE_FUNCTION (execIntOne)
 
 DECLARE_FUNCTION (execTrue)
 
 DECLARE_FUNCTION (execFalse)
 
 DECLARE_FUNCTION (execNoObject)
 
 DECLARE_FUNCTION (execNullInterface)
 
 DECLARE_FUNCTION (execIntConstByte)
 
 DECLARE_FUNCTION (execRotationConst)
 
 DECLARE_FUNCTION (execVectorConst)
 
 DECLARE_FUNCTION (execVector3fConst)
 
 DECLARE_FUNCTION (execTransformConst)
 
 DECLARE_FUNCTION (execStructConst)
 
 DECLARE_FUNCTION (execSetArray)
 
 DECLARE_FUNCTION (execSetSet)
 
 DECLARE_FUNCTION (execSetMap)
 
 DECLARE_FUNCTION (execArrayConst)
 
 DECLARE_FUNCTION (execSetConst)
 
 DECLARE_FUNCTION (execMapConst)
 
 DECLARE_FUNCTION (execBitFieldConst)
 
 DECLARE_FUNCTION (execNew)
 
 DECLARE_FUNCTION (execClassContext)
 
 DECLARE_FUNCTION (execNativeParm)
 
 DECLARE_FUNCTION (execCast)
 
 DECLARE_FUNCTION (execDynamicCast)
 
 DECLARE_FUNCTION (execMetaCast)
 
 DECLARE_FUNCTION (execInterfaceCast)
 
 DECLARE_FUNCTION (execDoubleToFloatCast)
 
 DECLARE_FUNCTION (execFloatToDoubleCast)
 
 DECLARE_FUNCTION (execObjectToBool)
 
 DECLARE_FUNCTION (execInterfaceToBool)
 
 DECLARE_FUNCTION (execObjectToInterface)
 
 DECLARE_FUNCTION (execInterfaceToInterface)
 
 DECLARE_FUNCTION (execInterfaceToObject)
 
 DECLARE_FUNCTION (execGetDynArrayElement)
 
 DECLARE_FUNCTION (execSetDynArrayElement)
 
 DECLARE_FUNCTION (execGetDynArrayLength)
 
 DECLARE_FUNCTION (execSetDynArrayLength)
 
 DECLARE_FUNCTION (execDynArrayInsert)
 
 DECLARE_FUNCTION (execDynArrayRemove)
 
 DECLARE_FUNCTION (execDynArrayFind)
 
 DECLARE_FUNCTION (execDynArrayFindStruct)
 
 DECLARE_FUNCTION (execDynArrayAdd)
 
 DECLARE_FUNCTION (execDynArrayAddItem)
 
 DECLARE_FUNCTION (execDynArrayInsertItem)
 
 DECLARE_FUNCTION (execDynArrayRemoveItem)
 
 DECLARE_FUNCTION (execDynArraySort)
 
 DECLARE_FUNCTION (execBindDelegate)
 
 DECLARE_FUNCTION (execCallMulticastDelegate)
 
 DECLARE_FUNCTION (execLetValueOnPersistentFrame)
 
 DECLARE_FUNCTION (execCallMathFunction)
 
 DECLARE_FUNCTION (execSwitchValue)
 
 DECLARE_FUNCTION (execArrayGetByRef)
 
 DECLARE_FUNCTION (execAutoRtfmTransact)
 
 DECLARE_FUNCTION (execAutoRtfmStopTransact)
 
 DECLARE_FUNCTION (execAutoRtfmAbortIfNot)
 
void ExecuteUbergraph (int32 EntryPoint)
 
virtual void ValidateGeneratedRepEnums (const TArray< struct FRepRecord > &ClassReps) const
 
virtual uint64 GetNetPushIdDynamic () const
 
- Public Member Functions inherited from UObjectBaseUtility
 UObjectBaseUtility ()
 
 UObjectBaseUtility (EObjectFlags InFlags)
 
void SetFlags (EObjectFlags NewFlags)
 
void ClearFlags (EObjectFlags FlagsToClear)
 
bool HasAnyFlags (EObjectFlags FlagsToCheck) const
 
bool HasAllFlags (EObjectFlags FlagsToCheck) const
 
UE_FORCEINLINE_HINT EObjectFlags GetMaskedFlags (EObjectFlags Mask=RF_AllFlags) const
 
UE_FORCEINLINE_HINT void Mark (EObjectMark Marks) const
 
UE_FORCEINLINE_HINT void UnMark (EObjectMark Marks) const
 
UE_FORCEINLINE_HINT bool HasAnyMarks (EObjectMark Marks) const
 
UE_FORCEINLINE_HINT bool HasAllMarks (EObjectMark Marks) const
 
UE_FORCEINLINE_HINT EObjectMark GetAllMarks () const
 
void MarkAsGarbage ()
 
void ClearGarbage ()
 
UE_FORCEINLINE_HINT void AddToRoot ()
 
UE_FORCEINLINE_HINT void RemoveFromRoot ()
 
UE_FORCEINLINE_HINT bool IsRooted () const
 
UE_FORCEINLINE_HINT int32 GetRefCount () const
 
bool ThisThreadAtomicallyClearedRFUnreachable ()
 
UE_FORCEINLINE_HINT bool IsUnreachable () const
 
UE_FORCEINLINE_HINT bool IsNative () const
 
void SetInternalFlags (EInternalObjectFlags FlagsToSet) const
 
UE_FORCEINLINE_HINT EInternalObjectFlags GetInternalFlags () const
 
UE_FORCEINLINE_HINT bool HasAnyInternalFlags (EInternalObjectFlags FlagsToCheck) const
 
void ClearInternalFlags (EInternalObjectFlags FlagsToClear) const
 
bool AtomicallyClearInternalFlags (EInternalObjectFlags FlagsToClear) const
 
COREUOBJECT_API FString GetFullName (const UObject *StopOuter=NULL, EObjectFullNameFlags Flags=EObjectFullNameFlags::None) const
 
COREUOBJECT_API void GetFullName (const UObject *StopOuter, FString &ResultString, EObjectFullNameFlags Flags=EObjectFullNameFlags::None) const
 
COREUOBJECT_API void GetFullName (FStringBuilderBase &ResultString, const UObject *StopOuter=NULL, EObjectFullNameFlags Flags=EObjectFullNameFlags::None) const
 
COREUOBJECT_API FString GetPathName (const UObject *StopOuter=NULL) const
 
COREUOBJECT_API void GetPathName (const UObject *StopOuter, FString &ResultString) const
 
COREUOBJECT_API void GetPathName (const UObject *StopOuter, FStringBuilderBase &ResultString) const
 
virtual bool CanBeClusterRoot () const
 
virtual COREUOBJECT_API bool CanBeInCluster () const
 
virtual COREUOBJECT_API void CreateCluster ()
 
virtual void OnClusterMarkedAsPendingKill ()
 
COREUOBJECT_API void AddToCluster (UObjectBaseUtility *ClusterRootOrObjectFromCluster, bool bAddAsMutableObject=false)
 
COREUOBJECT_API FString GetFullGroupName (bool bStartWithOuter) const
 
UE_FORCEINLINE_HINT FString GetName () const
 
UE_FORCEINLINE_HINT void GetName (FString &ResultString) const
 
UE_FORCEINLINE_HINT void AppendName (FString &ResultString) const
 
COREUOBJECT_API bool IsPackageExternal () const
 
COREUOBJECT_API void DetachExternalPackage ()
 
COREUOBJECT_API void ReattachExternalPackage ()
 
COREUOBJECT_API UObjectGetOutermostObject () const
 
COREUOBJECT_API UPackageGetPackage () const
 
UE_INTERNAL virtual COREUOBJECT_API UE::Core::FVersePath GetVersePath () const
 
COREUOBJECT_API UPackageGetOutermost () const
 
COREUOBJECT_API bool MarkPackageDirty () const
 
COREUOBJECT_API bool IsTemplate (EObjectFlags TemplateTypes=RF_ArchetypeObject|RF_ClassDefaultObject) const
 
COREUOBJECT_API UObjectGetTypedOuter (UClass *Target) const
 
template<typename T >
T * GetTypedOuter () const
 
template<typename InterfaceClassType >
InterfaceClassTypeGetImplementingOuter () const
 
COREUOBJECT_API UObjectBaseUtilityGetImplementingOuterObject (const UClass *InInterfaceClass) const
 
COREUOBJECT_API bool IsIn (const UObject *SomeOuter) const
 
COREUOBJECT_API bool IsIn (const UPackage *SomePackage) const
 
COREUOBJECT_API bool IsInOuter (const UObject *SomeOuter) const
 
COREUOBJECT_API bool IsInPackage (const UPackage *SomePackage) const
 
COREUOBJECT_API bool IsInA (const UClass *SomeBaseClass) const
 
COREUOBJECT_API bool RootPackageHasAnyFlags (uint32 CheckFlagMask) const
 
template<typename OtherClassType >
bool IsA (OtherClassType SomeBase) const
 
template<class T >
bool IsA () const
 
COREUOBJECT_API const UClassFindNearestCommonBaseClass (const UClass *TestClass) const
 
COREUOBJECT_API voidGetInterfaceAddress (UClass *InterfaceClass)
 
COREUOBJECT_API voidGetNativeInterfaceAddress (UClass *InterfaceClass)
 
const voidGetNativeInterfaceAddress (UClass *InterfaceClass) const
 
COREUOBJECT_API bool IsTemplateForSubobjects (EObjectFlags TemplateTypes=RF_ClassDefaultObject|RF_DefaultSubObject|RF_InheritableComponentTemplate) const
 
COREUOBJECT_API bool IsDefaultSubobject () const
 
COREUOBJECT_API class FLinkerLoadGetLinker () const
 
COREUOBJECT_API int32 GetLinkerIndex () const
 
COREUOBJECT_API FPackageFileVersion GetLinkerUEVersion () const
 
int32 GetLinkerUE4Version () const
 
COREUOBJECT_API int32 GetLinkerLicenseeUEVersion () const
 
int32 GetLinkerLicenseeUE4Version () const
 
COREUOBJECT_API int32 GetLinkerCustomVersion (FGuid CustomVersionKey) const
 
UE_FORCEINLINE_HINT bool operator< (const UObjectBaseUtility &Other) const
 
TStatId GetStatID (bool bForDeferredUse=false) const
 
- Public Member Functions inherited from UObjectBase
COREUOBJECT_API UObjectBase (UClass *InClass, EObjectFlags InFlags, EInternalObjectFlags InInternalFlags, UObject *InOuter, FName InName, int32 InInternalIndex=-1, int32 InSerialNumber=0, FRemoteObjectId InRemoteId=FRemoteObjectId())
 
virtual COREUOBJECT_API ~UObjectBase ()
 
COREUOBJECT_API bool IsValidLowLevel () const
 
COREUOBJECT_API bool IsValidLowLevelFast (bool bRecursive=true) const
 
FORCEINLINE uint32 GetUniqueID () const
 
FORCEINLINE UClassGetClass () const
 
FORCEINLINE UObjectGetOuter () const
 
FORCEINLINE FName GetFName () const
 
virtual COREUOBJECT_API FName GetFNameForStatID () const
 
COREUOBJECT_API UPackageGetExternalPackage () const
 
COREUOBJECT_API void SetExternalPackage (UPackage *InPackage)
 
COREUOBJECT_API UPackageGetExternalPackageInternal () const
 
COREUOBJECT_API void MarkAsReachable () const
 
COREUOBJECT_API void AddRef () const
 
COREUOBJECT_API void ReleaseRef () const
 
FORCEINLINE EObjectFlags GetFlags () const
 
FORCENOINLINE void AtomicallySetFlags (EObjectFlags FlagsToAdd)
 
FORCENOINLINE void AtomicallyClearFlags (EObjectFlags FlagsToClear)
 
- Public Member Functions inherited from INotifyFieldValueChanged
virtual const UE::FieldNotification::IClassDescriptorGetFieldNotificationDescriptor () const =0
 

Static Public Member Functions

static UMG_API TSubclassOf< UPropertyBindingFindBinderClassForDestination (FProperty *Property)
 
static UMG_API EVisibility ConvertSerializedVisibilityToRuntime (ESlateVisibility Input)
 
static UMG_API ESlateVisibility ConvertRuntimeToSerializedVisibility (const EVisibility &Input)
 
static UMG_API FSizeParam ConvertSerializedSizeParamToRuntime (const FSlateChildSize &Input)
 
static UMG_API UWidgetFindChildContainingDescendant (UWidget *Root, UWidget *Descendant)
 
static UMG_API FString GetDefaultFontName ()
 
- Static Public Member Functions inherited from UObject
static COREUOBJECT_API void UpdateClassesExcludedFromDedicatedServer (const TArray< FString > &InClassNames, const TArray< FString > &InModulesNames)
 
static COREUOBJECT_API void UpdateClassesExcludedFromDedicatedClient (const TArray< FString > &InClassNames, const TArray< FString > &InModulesNames)
 
static COREUOBJECT_API bool CanCreateInCurrentContext (UObject *Template)
 
static COREUOBJECT_API void AddReferencedObjects (UObject *InThis, FReferenceCollector &Collector)
 
static COREUOBJECT_API const FNameSourceFileTagName ()
 
static COREUOBJECT_API UObjectGetArchetypeFromRequiredInfo (const UClass *Class, const UObject *Outer, FName Name, EObjectFlags ObjectFlags)
 
- Static Public Member Functions inherited from UObjectBaseUtility
static bool IsGarbageEliminationEnabled ()
 
static bool IsPendingKillEnabled ()
 
static void SetGarbageEliminationEnabled (bool bEnabled)
 
static COREUOBJECT_API void ReloadObjectsFromModifiedConfigSections (const class FConfigModificationTracker *ChangeTracker)
 
- Static Public Member Functions inherited from UObjectBase
static COREUOBJECT_API FString RemoveClassPrefix (const TCHAR *ClassName)
 
static void PrefetchClass (UObject *Object)
 
static void PrefetchOuter (UObject *Object)
 

Public Attributes

TObjectPtr< UPanelSlotSlot
 
FGetBool bIsEnabledDelegate
 
FGetText ToolTipTextDelegate
 
FText ToolTipText
 
TObjectPtr< UWidgetToolTipWidget
 
FGetWidget ToolTipWidgetDelegate
 
FGetSlateVisibility VisibilityDelegate
 
FWidgetTransform RenderTransform
 
FVector2D RenderTransformPivot
 
EFlowDirectionPreference FlowDirectionPreference
 
uint8 bIsVariable:1
 
uint8 bCreatedByConstructionScript:1
 
uint8 bIsEnabled:1
 
uint8 bOverride_Cursor: 1
 
uint8 bWrappedByComponent: 1
 
TEnumAsByte< EMouseCursor::TypeCursor
 
EWidgetClipping Clipping
 
ESlateVisibility Visibility
 
TObjectPtr< class UWidgetNavigationNavigation
 
TWeakObjectPtr< UClassWidgetGeneratedByClass
 

Protected Member Functions

UMG_API void SetVisibilityInternal (ESlateVisibility InVisibility)
 
UMG_API void K2_BroadcastFieldValueChanged (FFieldNotificationId FieldId)
 
bool CanSafelyRouteCall ()
 
virtual UMG_API void OnBindingChanged (const FName &Property)
 
UMG_API void BroadcastBinaryPostStateChange (const FWidgetStateBitfield &StateChange, bool bInValue)
 
UMG_API void BroadcastEnumPostStateChange (const FWidgetStateBitfield &StateChange)
 
UMG_API UObjectGetSourceAssetOrClass () const
 
virtual UMG_API TSharedRef< SWidgetRebuildWidget ()
 
virtual UMG_API void OnWidgetRebuilt ()
 
UMG_API void UpdateRenderTransform ()
 
UMG_API void SynchronizeAccessibleData ()
 
EVisibility ConvertVisibility (TAttribute< ESlateVisibility > SerializedType) const
 
TOptional< floatConvertFloatToOptionalFloat (TAttribute< float > InFloat) const
 
FSlateColor ConvertLinearColorToSlateColor (TAttribute< FLinearColor > InLinearColor) const
 
UMG_API void SetNavigationRuleInternal (EUINavigation Direction, EUINavigationRule Rule, FName WidgetToFocus=NAME_None, UWidget *InWidget=nullptr, FCustomWidgetNavigationDelegate InCustomDelegate=FCustomWidgetNavigationDelegate())
 
- Protected Member Functions inherited from UObject
virtual FString GetDetailedInfoInternal () const
 
COREUOBJECT_API bool CanCheckDefaultSubObjects (bool bForceCheck, bool &bResult) const
 
virtual COREUOBJECT_API bool CheckDefaultSubobjectsInternal () const
 
- Protected Member Functions inherited from UObjectBase
 UObjectBase ()
 
COREUOBJECT_API UObjectBase (EObjectFlags InFlags)
 
COREUOBJECT_API void LowLevelRename (FName NewName, UObject *NewOuter=NULL)
 
virtual void RegisterDependencies ()
 
COREUOBJECT_API void Register (class UClass *(*StaticClassFn)(), const TCHAR *PackageName, const TCHAR *Name)
 
COREUOBJECT_API void Register (const TCHAR *PackageName, const TCHAR *Name)
 
virtual COREUOBJECT_API void DeferredRegister (UClass *UClassStaticClass, const TCHAR *PackageName, const TCHAR *Name)
 
FORCEINLINE void SetFlagsTo (EObjectFlags NewFlags)
 

Protected Attributes

uint8 bIsVolatile:1
 
uint8 bIsManagedByGameViewportSubsystem:1
 
bool bShouldBroadcastState: 1
 
bool bWidgetStateInitialized: 1
 
float RenderOpacity
 
TWeakPtr< SWidgetMyWidget
 
TWeakPtr< SWidgetComponentWrapperWidget
 
TWeakPtr< SObjectWidgetMyGCWidget
 
FWidgetStateBitfield MyWidgetStateBitfield
 
FOnWidgetStateBroadcast PostWidgetStateChanged
 
TArray< TObjectPtr< UPropertyBinding > > NativeBindings
 

Static Protected Attributes

static UMG_API TArray< TSubclassOf< UPropertyBinding > > BinderClasses
 

Detailed Description

This is the base class for all wrapped Slate controls that are exposed to UObjects.

Examples
/work/Engine/Source/Runtime/UMG/Public/Components/Widget.h.

Member Typedef Documentation

◆ ConstructMethodType

Member Function Documentation

◆ AddBinding()

bool UWidget::AddBinding ( FDelegateProperty DelegateProperty,
UObject SourceObject,
const FDynamicPropertyPath BindingPath 
)

◆ AddFieldValueChangedDelegate()

FDelegateHandle UWidget::AddFieldValueChangedDelegate ( UE::FieldNotification::FFieldId  InFieldId,
FFieldValueChangedDelegate  InNewDelegate 
)
finaloverridevirtual

Add a delegate that will be notified when the FieldId is value changed.

Implements INotifyFieldValueChanged.

Examples
/work/Engine/Source/Runtime/UMG/Public/Components/Widget.h.

◆ BeginDestroy()

void UWidget::BeginDestroy ( )
overridevirtual

Called before destroying the object. This is called immediately upon deciding to destroy the object, to allow the object to begin an asynchronous cleanup process.

Reimplemented from UVisual.

Reimplemented in UUserWidget.

Examples
/work/Engine/Source/Runtime/UMG/Public/Components/Widget.h.

◆ BroadcastBinaryPostStateChange()

void UWidget::BroadcastBinaryPostStateChange ( const FWidgetStateBitfield StateChange,
bool  bInValue 
)
protected

Broadcast a binary state post change

Parameters
StateChangebitfield marking states that should be changed
bInValuetrue if marked states should be enabled, false otherwise
Examples
/work/Engine/Source/Runtime/UMG/Public/Components/Widget.h.

◆ BroadcastEnumPostStateChange()

void UWidget::BroadcastEnumPostStateChange ( const FWidgetStateBitfield StateChange)
protected

Broadcast an enum state post change

Parameters
StateChangebitfield marking states that should be changed
Examples
/work/Engine/Source/Runtime/UMG/Public/Components/Widget.h.

◆ BroadcastFieldValueChanged()

void UWidget::BroadcastFieldValueChanged ( UE::FieldNotification::FFieldId  InFieldId)
finaloverridevirtual

Broadcast to the registered delegate that the FieldId value changed.

Implements INotifyFieldValueChanged.

Examples
/work/Engine/Source/Runtime/UMG/Public/Components/Widget.h.

◆ BuildNavigation()

void UWidget::BuildNavigation ( )

Called by the owning user widget after the slate widget has been created. After the entire widget tree has been initialized, any widget reference that was needed to support navigating to another widget will now be initialized and ready for usage.

Examples
/work/Engine/Source/Runtime/UMG/Public/Components/Widget.h.

◆ CanSafelyRouteCall()

bool UWidget::CanSafelyRouteCall ( )
inlineprotected

◆ CanSafelyRouteEvent()

bool UWidget::CanSafelyRouteEvent ( )
inline

◆ CanSafelyRoutePaint()

bool UWidget::CanSafelyRoutePaint ( )
inline

◆ ConvertFloatToOptionalFloat()

TOptional< float > UWidget::ConvertFloatToOptionalFloat ( TAttribute< float InFloat) const
inlineprotected

◆ ConvertLinearColorToSlateColor()

FSlateColor UWidget::ConvertLinearColorToSlateColor ( TAttribute< FLinearColor InLinearColor) const
inlineprotected

◆ ConvertRuntimeToSerializedVisibility()

ESlateVisibility UWidget::ConvertRuntimeToSerializedVisibility ( const EVisibility Input)
static

◆ ConvertSerializedSizeParamToRuntime()

FSizeParam UWidget::ConvertSerializedSizeParamToRuntime ( const FSlateChildSize Input)
static

◆ ConvertSerializedVisibilityToRuntime()

EVisibility UWidget::ConvertSerializedVisibilityToRuntime ( ESlateVisibility  Input)
static

◆ ConvertVisibility()

EVisibility UWidget::ConvertVisibility ( TAttribute< ESlateVisibility SerializedType) const
inlineprotected

◆ DECLARE_DYNAMIC_DELEGATE_RetVal() [1/12]

UWidget::DECLARE_DYNAMIC_DELEGATE_RetVal ( bool  ,
FGetBool   
)

◆ DECLARE_DYNAMIC_DELEGATE_RetVal() [2/12]

UWidget::DECLARE_DYNAMIC_DELEGATE_RetVal ( ECheckBoxState  ,
FGetCheckBoxState   
)

◆ DECLARE_DYNAMIC_DELEGATE_RetVal() [3/12]

UWidget::DECLARE_DYNAMIC_DELEGATE_RetVal ( EMouseCursor::Type  ,
FGetMouseCursor   
)

◆ DECLARE_DYNAMIC_DELEGATE_RetVal() [4/12]

UWidget::DECLARE_DYNAMIC_DELEGATE_RetVal ( ESlateVisibility  ,
FGetSlateVisibility   
)

◆ DECLARE_DYNAMIC_DELEGATE_RetVal() [5/12]

UWidget::DECLARE_DYNAMIC_DELEGATE_RetVal ( FEventReply  ,
FOnReply   
)

◆ DECLARE_DYNAMIC_DELEGATE_RetVal() [6/12]

UWidget::DECLARE_DYNAMIC_DELEGATE_RetVal ( FLinearColor  ,
FGetLinearColor   
)

◆ DECLARE_DYNAMIC_DELEGATE_RetVal() [7/12]

UWidget::DECLARE_DYNAMIC_DELEGATE_RetVal ( float  ,
FGetFloat   
)

◆ DECLARE_DYNAMIC_DELEGATE_RetVal() [8/12]

UWidget::DECLARE_DYNAMIC_DELEGATE_RetVal ( FSlateBrush  ,
FGetSlateBrush   
)

◆ DECLARE_DYNAMIC_DELEGATE_RetVal() [9/12]

UWidget::DECLARE_DYNAMIC_DELEGATE_RetVal ( FSlateColor  ,
FGetSlateColor   
)

◆ DECLARE_DYNAMIC_DELEGATE_RetVal() [10/12]

UWidget::DECLARE_DYNAMIC_DELEGATE_RetVal ( FText  ,
FGetText   
)

◆ DECLARE_DYNAMIC_DELEGATE_RetVal() [11/12]

UWidget::DECLARE_DYNAMIC_DELEGATE_RetVal ( int32  ,
FGetInt32   
)

◆ DECLARE_DYNAMIC_DELEGATE_RetVal() [12/12]

UWidget::DECLARE_DYNAMIC_DELEGATE_RetVal ( UWidget ,
FGetWidget   
)

◆ DECLARE_DYNAMIC_DELEGATE_RetVal_OneParam() [1/2]

UWidget::DECLARE_DYNAMIC_DELEGATE_RetVal_OneParam ( UWidget ,
FGenerateWidgetForObject  ,
UObject ,
Item   
)

◆ DECLARE_DYNAMIC_DELEGATE_RetVal_OneParam() [2/2]

UWidget::DECLARE_DYNAMIC_DELEGATE_RetVal_OneParam ( UWidget ,
FGenerateWidgetForString  ,
FString  ,
Item   
)

◆ DECLARE_DYNAMIC_DELEGATE_RetVal_TwoParams()

UWidget::DECLARE_DYNAMIC_DELEGATE_RetVal_TwoParams ( FEventReply  ,
FOnPointerEvent  ,
FGeometry  ,
MyGeometry  ,
const FPointerEvent ,
MouseEvent   
)

◆ DECLARE_MULTICAST_DELEGATE_TwoParams()

UWidget::DECLARE_MULTICAST_DELEGATE_TwoParams ( FOnWidgetStateBroadcast  ,
UWidget ,
const FWidgetStateBitfield  
)

◆ FindBinderClassForDestination()

TSubclassOf< UPropertyBinding > UWidget::FindBinderClassForDestination ( FProperty Property)
static

◆ FindChildContainingDescendant()

UWidget * UWidget::FindChildContainingDescendant ( UWidget Root,
UWidget Descendant 
)
static

◆ FinishDestroy()

void UWidget::FinishDestroy ( )
overridevirtual

Called to finish destroying the object. After UObject::FinishDestroy is called, the object's memory should no longer be accessed.

Warning
Because properties are destroyed here, Super::FinishDestroy() should always be called at the end of your child class's FinishDestroy() method, rather than at the beginning.

Reimplemented from UObject.

Examples
/work/Engine/Source/Runtime/UMG/Public/Components/Widget.h.

◆ ForceLayoutPrepass()

void UWidget::ForceLayoutPrepass ( )

Forces a pre-pass. A pre-pass caches the desired size of the widget hierarchy owned by this widget.
One pre-pass already happens for every widget before Tick occurs. You only need to perform another pre-pass if you are adding child widgets this frame and want them to immediately be visible this frame.

Examples
/work/Engine/Source/Runtime/UMG/Public/Components/Widget.h.

◆ ForceVolatile()

void UWidget::ForceVolatile ( bool  bForce)

Sets the forced volatility of the widget.

Examples
/work/Engine/Source/Runtime/UMG/Public/Components/Widget.h.

◆ GetAccessibleSummaryText()

FText UWidget::GetAccessibleSummaryText ( ) const

Gets the accessible summary text from the underlying Slate accessible widget.

Returns
The accessible summary text of the underlying Slate accessible widget. Returns an empty text if accessibility is dsabled or the underlying accessible widget is invalid.
Examples
/work/Engine/Source/Runtime/UMG/Public/Components/Widget.h.

◆ GetAccessibleText()

FText UWidget::GetAccessibleText ( ) const

Gets the accessible text from the underlying Slate accessible widget

Returns
The accessible text of the underlying Slate accessible widget. Returns an empty text if accessibility is dsabled or the underlying accessible widget is invalid.
Examples
/work/Engine/Source/Runtime/UMG/Public/Components/Widget.h.

◆ GetCachedGeometry()

const FGeometry & UWidget::GetCachedGeometry ( ) const

Gets the last geometry used to Tick the widget. This data may not exist yet if this call happens prior to the widget having been ticked/painted, or it may be out of date, or a frame behind.

We recommend not to use this data unless there's no other way to solve your problem. Normally in Slate we try and handle these issues by making a dependent widget part of the hierarchy, as to avoid frame behind or what are referred to as hysteresis problems, both caused by depending on geometry from the previous frame being used to advise how to layout a dependent object the current frame.

Examples
/work/Engine/Source/Runtime/UMG/Public/Components/Widget.h.

◆ GetCachedWidget()

TSharedPtr< SWidget > UWidget::GetCachedWidget ( ) const

Gets the last created widget from RebuildWidget does not recreate the gc container for the widget if one is needed.

Examples
/work/Engine/Source/Runtime/UMG/Public/Components/Widget.h.

◆ GetCachedWrappedWidget()

TSharedPtr< SWidget > UWidget::GetCachedWrappedWidget ( ) const

Gets the last created widget from RebuildDesignWidget does not recreate the gc container for the widget if one is needed.

Examples
/work/Engine/Source/Runtime/UMG/Public/Components/Widget.h.

◆ GetClipping()

EWidgetClipping UWidget::GetClipping ( ) const

Gets the clipping state of this widget.

Examples
/work/Engine/Source/Runtime/UMG/Public/Components/Widget.h.

◆ GetCursor()

EMouseCursor::Type UWidget::GetCursor ( ) const

Sets the cursor to show over the widget.

Examples
/work/Engine/Source/Runtime/UMG/Public/Components/Widget.h.

◆ GetDefaultFontName()

FString UWidget::GetDefaultFontName ( )
static

◆ GetDesiredSize()

FVector2D UWidget::GetDesiredSize ( ) const

Gets the widgets desired size. NOTE: The underlying Slate widget must exist and be valid, also at least one pre-pass must have occurred before this value will be of any use.

Returns
The widget's desired size
Examples
/work/Engine/Source/Runtime/UMG/Public/Components/Widget.h.

◆ GetFlowDirectionPreference()

EFlowDirectionPreference UWidget::GetFlowDirectionPreference ( ) const

Gets the flow direction preference of the widget

Examples
/work/Engine/Source/Runtime/UMG/Public/Components/Widget.h.

◆ GetGameInstance() [1/2]

UGameInstance * UWidget::GetGameInstance ( ) const

Gets the game instance associated with this UI.

Returns
a pointer to the owning game instance
Examples
/work/Engine/Source/Runtime/UMG/Public/Components/Widget.h.

◆ GetGameInstance() [2/2]

template<class TGameInstance = UGameInstance>
TGameInstance * UWidget::GetGameInstance ( ) const
inline

Gets the game instance associated with this UI.

Returns
a pointer to the owning game instance

◆ GetIsEnabled()

bool UWidget::GetIsEnabled ( ) const

Gets the current enabled status of the widget

Examples
/work/Engine/Source/Runtime/UMG/Public/Components/Widget.h.

◆ GetOwningLocalPlayer() [1/2]

ULocalPlayer * UWidget::GetOwningLocalPlayer ( ) const
virtual

Gets the local player associated with this UI.

Returns
The owning local player.

Reimplemented in UUserWidget, and UUserWidget.

Examples
/work/Engine/Source/Runtime/UMG/Public/Components/Widget.h.

◆ GetOwningLocalPlayer() [2/2]

template<class T >
T * UWidget::GetOwningLocalPlayer ( ) const
inline

Gets the local player associated with this UI cast to the template type.

Returns
The owning local player. May be NULL if the cast fails.

◆ GetOwningPlayer() [1/2]

APlayerController * UWidget::GetOwningPlayer ( ) const
virtual

Gets the player controller associated with this UI.

Returns
The player controller that owns the UI.

Reimplemented in UUserWidget, and UUserWidget.

Examples
/work/Engine/Source/Runtime/UMG/Public/Components/Widget.h.

◆ GetOwningPlayer() [2/2]

template<class TPlayerController = APlayerController>
TPlayerController * UWidget::GetOwningPlayer ( ) const
inline

Gets the player controller associated with this UI cast to the template type.

Returns
The player controller that owns the UI. May be NULL if the cast fails.

◆ GetPaintSpaceGeometry()

const FGeometry & UWidget::GetPaintSpaceGeometry ( ) const

◆ GetParent()

UPanelWidget * UWidget::GetParent ( ) const

◆ GetPixelSnapping()

PRAGMA_ENABLE_DEPRECATION_WARNINGS EWidgetPixelSnapping UWidget::GetPixelSnapping ( ) const

Gets the pixel snapping method of this widget.

Examples
/work/Engine/Source/Runtime/UMG/Public/Components/Widget.h.

◆ GetRenderOpacity()

float UWidget::GetRenderOpacity ( ) const

Gets the current visibility of the widget.

Examples
/work/Engine/Source/Runtime/UMG/Public/Components/Widget.h.

◆ GetRenderTransform()

◆ GetRenderTransformAngle()

float UWidget::GetRenderTransformAngle ( ) const

◆ GetRenderTransformPivot()

FVector2D UWidget::GetRenderTransformPivot ( ) const

◆ GetSourceAssetOrClass()

UObject * UWidget::GetSourceAssetOrClass ( ) const
protected

◆ GetTickSpaceGeometry()

const FGeometry & UWidget::GetTickSpaceGeometry ( ) const

◆ GetToolTip()

UWidget * UWidget::GetToolTip ( ) const
Returns
the custom widget as the tooltip of the widget.
Examples
/work/Engine/Source/Runtime/UMG/Public/Components/Widget.h.

◆ GetToolTipText()

PRAGMA_DISABLE_DEPRECATION_WARNINGS FText UWidget::GetToolTipText ( ) const
Returns
the tooltip text for the widget.
Examples
/work/Engine/Source/Runtime/UMG/Public/Components/Widget.h.

◆ GetVisibility()

ESlateVisibility UWidget::GetVisibility ( ) const

Gets the current visibility of the widget.

Examples
/work/Engine/Source/Runtime/UMG/Public/Components/Widget.h.

◆ GetWorld()

UWorld * UWidget::GetWorld ( ) const
overridevirtual

◆ HasAnyUserFocus()

bool UWidget::HasAnyUserFocus ( ) const

Returns true if this widget is focused by any user.

Examples
/work/Engine/Source/Runtime/UMG/Public/Components/Widget.h.

◆ HasFocusedDescendants()

bool UWidget::HasFocusedDescendants ( ) const

Returns true if any descendant widget is focused by any user.

Examples
/work/Engine/Source/Runtime/UMG/Public/Components/Widget.h.

◆ HasKeyboardFocus()

bool UWidget::HasKeyboardFocus ( ) const

Checks to see if this widget currently has the keyboard focus

Returns
True if this widget has keyboard focus
Examples
/work/Engine/Source/Runtime/UMG/Public/Components/Widget.h.

◆ HasMouseCapture()

bool UWidget::HasMouseCapture ( ) const

Checks to see if this widget is the current mouse captor

Returns
True if this widget has captured the mouse
Examples
/work/Engine/Source/Runtime/UMG/Public/Components/Widget.h.

◆ HasMouseCaptureByUser()

bool UWidget::HasMouseCaptureByUser ( int32  UserIndex,
int32  PointerIndex = -1 
) const

Checks to see if this widget is the current mouse captor

Parameters
Userindex to check for capture
Optionalpointer index to check for capture
Returns
True if this widget has captured the mouse with given user and pointer
Examples
/work/Engine/Source/Runtime/UMG/Public/Components/Widget.h.

◆ HasUserFocus()

bool UWidget::HasUserFocus ( APlayerController PlayerController) const

Returns true if this widget is focused by a specific user.

Examples
/work/Engine/Source/Runtime/UMG/Public/Components/Widget.h.

◆ HasUserFocusedDescendants()

bool UWidget::HasUserFocusedDescendants ( APlayerController PlayerController) const

Returns true if any descendant widget is focused by a specific user.

Examples
/work/Engine/Source/Runtime/UMG/Public/Components/Widget.h.

◆ InvalidateLayoutAndVolatility()

void UWidget::InvalidateLayoutAndVolatility ( )

Invalidates the widget from the view of a layout caching widget that may own this widget. will force the owning widget to redraw and cache children on the next paint pass.

Examples
/work/Engine/Source/Runtime/UMG/Public/Components/Widget.h.

◆ IsChildOf()

bool UWidget::IsChildOf ( UWidget PossibleParent)

Recurses up the list of parents and returns true if this widget is a descendant of the PossibleParent

Returns
true if this widget is a child of the PossibleParent

◆ IsConstructed()

bool UWidget::IsConstructed ( ) const

Gets the last created widget does not recreate the gc container for the widget if one is needed.

Examples
/work/Engine/Source/Runtime/UMG/Public/Components/Widget.h.

◆ IsDesignTime()

bool UWidget::IsDesignTime ( ) const
inline

◆ IsHovered()

PRAGMA_ENABLE_DEPRECATION_WARNINGS bool UWidget::IsHovered ( ) const
virtual

Returns true if the widget is currently being hovered by a pointer device

Examples
/work/Engine/Source/Runtime/UMG/Public/Components/Widget.h.

◆ IsInViewport()

bool UWidget::IsInViewport ( ) const

◆ IsPreviewTime()

bool UWidget::IsPreviewTime ( ) const
inline

◆ IsRendered()

bool UWidget::IsRendered ( ) const

Returns true if the widget is Visible, HitTestInvisible or SelfHitTestInvisible and the Render Opacity is greater than 0.

Examples
/work/Engine/Source/Runtime/UMG/Public/Components/Widget.h.

◆ IsVisible()

bool UWidget::IsVisible ( ) const

Returns true if the widget is Visible, HitTestInvisible or SelfHitTestInvisible.

Examples
/work/Engine/Source/Runtime/UMG/Public/Components/Widget.h.

◆ K2_AddFieldValueChangedDelegate()

void UWidget::K2_AddFieldValueChangedDelegate ( FFieldNotificationId  FieldId,
FFieldValueChangedDynamicDelegate  Delegate 
)

◆ K2_BroadcastFieldValueChanged()

void UWidget::K2_BroadcastFieldValueChanged ( FFieldNotificationId  FieldId)
protected

◆ K2_RemoveFieldValueChangedDelegate()

void UWidget::K2_RemoveFieldValueChangedDelegate ( FFieldNotificationId  FieldId,
FFieldValueChangedDynamicDelegate  Delegate 
)

◆ OnBindingChanged()

void UWidget::OnBindingChanged ( const FName Property)
protectedvirtual

◆ OnWidgetRebuilt()

void UWidget::OnWidgetRebuilt ( )
protectedvirtual

Function called after the underlying SWidget is constructed.

Reimplemented in UUserWidget.

Examples
/work/Engine/Source/Runtime/UMG/Public/Components/Widget.h.

◆ PreSave()

void UWidget::PreSave ( FObjectPreSaveContext  SaveContext)
overridevirtual

Presave function. Gets called once before an object gets serialized for saving. This function is necessary for save time computation as Serialize gets called three times per object from within SavePackage.

Warning
: Objects created from within PreSave will NOT have PreSave called on them!!!

Reimplemented from UObject.

Reimplemented in UUserWidget.

◆ RebuildWidget()

◆ RegisterPostStateListener()

FDelegateHandle UWidget::RegisterPostStateListener ( const FOnWidgetStateBroadcast::FDelegate &  ListenerDelegate,
bool  bBroadcastCurrentState = true 
)

Add a post-state-changed listener to this widget, will fire after a state changed and all related side effects are resolved.

Note: Currently we only support post-state-changed broadcasts.

Parameters
ListenerDelegateDelegate to fire when state changes
bBroadcastCurrentStatetrue if we should trigger this delegate once on registration with the current widget state (Does not globally broadcast).
Examples
/work/Engine/Source/Runtime/UMG/Public/Components/Widget.h.

◆ RemoveAllFieldValueChangedDelegates() [1/2]

int32 UWidget::RemoveAllFieldValueChangedDelegates ( FDelegateUserObjectConst  InUserObject)
finaloverridevirtual

Remove all the delegate that are bound to the specified UserObject.

Implements INotifyFieldValueChanged.

Examples
/work/Engine/Source/Runtime/UMG/Public/Components/Widget.h.

◆ RemoveAllFieldValueChangedDelegates() [2/2]

int32 UWidget::RemoveAllFieldValueChangedDelegates ( UE::FieldNotification::FFieldId  InFieldId,
FDelegateUserObjectConst  InUserObject 
)
finaloverridevirtual

Remove all the delegate that are bound to the specified Field and UserObject.

Implements INotifyFieldValueChanged.

◆ RemoveFieldValueChangedDelegate()

bool UWidget::RemoveFieldValueChangedDelegate ( UE::FieldNotification::FFieldId  InFieldId,
FDelegateHandle  InHandle 
)
finaloverridevirtual

Remove a delegate that was added.

Implements INotifyFieldValueChanged.

Examples
/work/Engine/Source/Runtime/UMG/Public/Components/Widget.h.

◆ RemoveFromParent()

void UWidget::RemoveFromParent ( )
virtual

Removes the widget from its parent widget. If this widget was added to the player's screen or the viewport it will also be removed from those containers.

Examples
/work/Engine/Source/Runtime/UMG/Public/Components/Widget.h.

◆ ResetCursor()

void UWidget::ResetCursor ( )

Resets the cursor to use on the widget, removing any customization for it.

Examples
/work/Engine/Source/Runtime/UMG/Public/Components/Widget.h.

◆ SetAllNavigationRules()

void UWidget::SetAllNavigationRules ( EUINavigationRule  Rule,
FName  WidgetToFocus 
)

Sets the widget navigation rules for all directions. This can only be called on widgets that are in a widget tree.

Parameters
RuleThe rule to use when navigation is taking place
WidgetToFocusWhen using the Explicit rule, focus on this widget
Examples
/work/Engine/Source/Runtime/UMG/Public/Components/Widget.h.

◆ SetClipping()

void UWidget::SetClipping ( EWidgetClipping  InClipping)

Sets the clipping state of this widget.

Examples
/work/Engine/Source/Runtime/UMG/Public/Components/Widget.h.

◆ SetCursor()

void UWidget::SetCursor ( EMouseCursor::Type  InCursor)

Sets the cursor to show over the widget.

Examples
/work/Engine/Source/Runtime/UMG/Public/Components/Widget.h.

◆ SetFlowDirectionPreference()

void UWidget::SetFlowDirectionPreference ( EFlowDirectionPreference  FlowDirection)

Sets the flow direction preference of the widget

Examples
/work/Engine/Source/Runtime/UMG/Public/Components/Widget.h.

◆ SetFocus()

void UWidget::SetFocus ( )

Sets the focus to this widget for the owning user

Examples
/work/Engine/Source/Runtime/UMG/Public/Components/Widget.h.

◆ SetIsEnabled()

void UWidget::SetIsEnabled ( bool  bInIsEnabled)
virtual

Sets the current enabled status of the widget

Examples
/work/Engine/Source/Runtime/UMG/Public/Components/Widget.h.

◆ SetKeyboardFocus()

void UWidget::SetKeyboardFocus ( )

Sets the focus to this widget.

Examples
/work/Engine/Source/Runtime/UMG/Public/Components/Widget.h.

◆ SetNavigationMethod()

void UWidget::SetNavigationMethod ( const TInstancedStruct< FNavigationMethod > &  NavigationMethod)

Sets the widget navigation method for this widget hierarchy. This can only be called on widgets that are in a widget tree.

Parameters
NavigationMethodStruct.Must be the StaticStruct of type FNavigationMethod
Examples
/work/Engine/Source/Runtime/UMG/Public/Components/Widget.h.

◆ SetNavigationRule()

void UWidget::SetNavigationRule ( EUINavigation  Direction,
EUINavigationRule  Rule,
FName  WidgetToFocus 
)

Sets the widget navigation rules for a specific direction. This can only be called on widgets that are in a widget tree.

Parameters
Direction
RuleThe rule to use when navigation is taking place
WidgetToFocusWhen using the Explicit rule, focus on this widget
Examples
/work/Engine/Source/Runtime/UMG/Public/Components/Widget.h.

◆ SetNavigationRuleBase()

void UWidget::SetNavigationRuleBase ( EUINavigation  Direction,
EUINavigationRule  Rule 
)

Sets the widget navigation rules for a specific direction. This can only be called on widgets that are in a widget tree. This works only for non Explicit, non Custom and non CustomBoundary Rules.

Parameters
Direction
RuleThe rule to use when navigation is taking place
Examples
/work/Engine/Source/Runtime/UMG/Public/Components/Widget.h.

◆ SetNavigationRuleCustom()

void UWidget::SetNavigationRuleCustom ( EUINavigation  Direction,
FCustomWidgetNavigationDelegate  InCustomDelegate 
)

Sets the widget navigation rules for a specific direction. This can only be called on widgets that are in a widget tree. This works only for Custom Rule.

Parameters
Direction
InCustomDelegateCustom Delegate that will be called
Examples
/work/Engine/Source/Runtime/UMG/Public/Components/Widget.h.

◆ SetNavigationRuleCustomBoundary()

void UWidget::SetNavigationRuleCustomBoundary ( EUINavigation  Direction,
FCustomWidgetNavigationDelegate  InCustomDelegate 
)

Sets the widget navigation rules for a specific direction. This can only be called on widgets that are in a widget tree. This works only for CustomBoundary Rule.

Parameters
Direction
InCustomDelegateCustom Delegate that will be called
Examples
/work/Engine/Source/Runtime/UMG/Public/Components/Widget.h.

◆ SetNavigationRuleExplicit()

void UWidget::SetNavigationRuleExplicit ( EUINavigation  Direction,
UWidget InWidget 
)

Sets the widget navigation rules for a specific direction. This can only be called on widgets that are in a widget tree. This works only for Explicit Rule.

Parameters
Direction
InWidgetFocus on this widget instance
Examples
/work/Engine/Source/Runtime/UMG/Public/Components/Widget.h.

◆ SetNavigationRuleInternal()

void UWidget::SetNavigationRuleInternal ( EUINavigation  Direction,
EUINavigationRule  Rule,
FName  WidgetToFocus = NAME_None,
UWidget InWidget = nullptr,
FCustomWidgetNavigationDelegate  InCustomDelegate = FCustomWidgetNavigationDelegate() 
)
protected

◆ SetPixelSnapping()

void UWidget::SetPixelSnapping ( EWidgetPixelSnapping  InPixelSnapping)

Sets the pixel snapping method of this widget.

Examples
/work/Engine/Source/Runtime/UMG/Public/Components/Widget.h.

◆ SetRenderOpacity()

void UWidget::SetRenderOpacity ( float  InOpacity)

Sets the visibility of the widget.

Examples
/work/Engine/Source/Runtime/UMG/Public/Components/Widget.h.

◆ SetRenderScale()

void UWidget::SetRenderScale ( FVector2D  Scale)

◆ SetRenderShear()

void UWidget::SetRenderShear ( FVector2D  Shear)

◆ SetRenderTransform()

void UWidget::SetRenderTransform ( FWidgetTransform  InTransform)

◆ SetRenderTransformAngle()

void UWidget::SetRenderTransformAngle ( float  Angle)

◆ SetRenderTransformPivot()

void UWidget::SetRenderTransformPivot ( FVector2D  Pivot)

◆ SetRenderTranslation()

void UWidget::SetRenderTranslation ( FVector2D  Translation)

◆ SetToolTip()

void UWidget::SetToolTip ( UWidget Widget)

Sets a custom widget as the tooltip of the widget.

Examples
/work/Engine/Source/Runtime/UMG/Public/Components/Widget.h.

◆ SetToolTipText()

void UWidget::SetToolTipText ( const FText InToolTipText)

Sets the tooltip text for the widget.

Examples
/work/Engine/Source/Runtime/UMG/Public/Components/Widget.h.

◆ SetUserFocus()

void UWidget::SetUserFocus ( APlayerController PlayerController)

Sets the focus to this widget for a specific user (if setting focus for the owning user, prefer SetFocus())

Examples
/work/Engine/Source/Runtime/UMG/Public/Components/Widget.h.

◆ SetVisibility()

void UWidget::SetVisibility ( ESlateVisibility  InVisibility)
virtual

Sets the visibility of the widget.

Reimplemented in UUserWidget.

Examples
/work/Engine/Source/Runtime/UMG/Public/Components/Widget.h.

◆ SetVisibilityInternal()

void UWidget::SetVisibilityInternal ( ESlateVisibility  InVisibility)
protected

◆ SynchronizeAccessibleData()

void UWidget::SynchronizeAccessibleData ( )
protected

Copy all accessible properties to the AccessibleWidgetData object

Examples
/work/Engine/Source/Runtime/UMG/Public/Components/Widget.h.

◆ SynchronizeProperties()

void UWidget::SynchronizeProperties ( )
virtual

Applies all properties to the native widget if possible. This is called after a widget is constructed. It can also be called by the editor to update modified state, so ensure all initialization to a widgets properties are performed here, or the property and visual state may become unsynced.

Reimplemented in URadialSlider, UUserWidget, UBackgroundBlur, UBorder, UButton, UCheckBox, UCircularThrobber, UDynamicEntryBox, UDynamicEntryBoxBase, UEditableText, UEditableTextBox, UExpandableArea, UGridPanel, UImage, UInputKeySelector, UListViewBase, UPostBufferUpdate, UProgressBar, URetainerBox, URichTextBlock, UScaleBox, UScrollBar, UScrollBox, USizeBox, USlider, USpacer, USpinBox, UStackBox, UTextBlock, UThrobber, UUniformGridPanel, UWidgetSwitcher, and UWrapBox.

Examples
/work/Engine/Source/Runtime/UMG/Public/Components/Widget.h.

◆ TakeDerivedWidget()

template<class WidgetType = SObjectWidget>
TSharedRef< WidgetType > UWidget::TakeDerivedWidget ( ConstructMethodType  ConstructMethod)
inline

◆ TakeWidget()

TSharedRef< SWidget > UWidget::TakeWidget ( )

Gets the underlying slate widget or constructs it if it doesn't exist. If you're looking to replace what slate widget gets constructed look for RebuildWidget. For extremely special cases where you actually need to change the GC Root widget of the constructed User Widget - you need to use TakeDerivedWidget you must also take care to not call TakeWidget before calling TakeDerivedWidget, as that would put the wrong expected wrapper around the resulting widget being constructed.

Examples
/work/Engine/Source/Runtime/UMG/Public/Components/Widget.h.

◆ UE_FIELD_NOTIFICATION_DECLARE_CLASS_DESCRIPTOR_BASE_END()

UWidget::UE_FIELD_NOTIFICATION_DECLARE_CLASS_DESCRIPTOR_BASE_END ( )

◆ UnregisterPostStateListener()

void UWidget::UnregisterPostStateListener ( const FDelegateHandle ListenerDelegate)

Remove a post-state-changed listener from this widget, resets state bitfield if no other state listeners exist

Parameters
ListenerDelegateDelegate to remove
Examples
/work/Engine/Source/Runtime/UMG/Public/Components/Widget.h.

◆ UpdateRenderTransform()

void UWidget::UpdateRenderTransform ( )
protected

Member Data Documentation

◆ bCreatedByConstructionScript

uint8 UWidget::bCreatedByConstructionScript

Flag if the Widget was created from a blueprint

Examples
/work/Engine/Source/Runtime/UMG/Public/Components/Widget.h.

◆ BinderClasses

◆ bIsEnabled

uint8 UWidget::bIsEnabled

Sets whether this widget can be modified interactively by the user

Examples
/work/Engine/Source/Runtime/UMG/Public/Components/Widget.h.

◆ bIsEnabledDelegate

FGetBool UWidget::bIsEnabledDelegate

A bindable delegate for bIsEnabled

Examples
/work/Engine/Source/Runtime/UMG/Public/Components/Widget.h.

◆ bIsManagedByGameViewportSubsystem

uint8 UWidget::bIsManagedByGameViewportSubsystem
protected

Cached value that indicate if the widget was added to the GameViewportSubsystem.

Examples
/work/Engine/Source/Runtime/UMG/Public/Components/Widget.h.

◆ bIsVariable

uint8 UWidget::bIsVariable

Allows controls to be exposed as variables in a blueprint. Not all controls need to be exposed as variables, so this allows only the most useful ones to end up being exposed.

Examples
/work/Engine/Source/Runtime/UMG/Public/Components/Widget.h.

◆ bIsVolatile

uint8 UWidget::bIsVolatile
protected

If true prevents the widget or its child's geometry or layout information from being cached. If this widget changes every frame, but you want it to still be in an invalidation panel you should make it as volatile instead of invalidating it every frame, which would prevent the invalidation panel from actually ever caching anything.

Examples
/work/Engine/Source/Runtime/UMG/Public/Components/Widget.h.

◆ bOverride_Cursor

◆ bShouldBroadcastState

bool UWidget::bShouldBroadcastState
protected

False will skip state broadcasts. Useful for child classes to call Super methods without broadcasting early / late.

Examples
/work/Engine/Source/Runtime/UMG/Public/Components/Widget.h.

◆ bWidgetStateInitialized

bool UWidget::bWidgetStateInitialized
protected

True implies widget state has been initialized.

Examples
/work/Engine/Source/Runtime/UMG/Public/Components/Widget.h.

◆ bWrappedByComponent

uint8 UWidget::bWrappedByComponent

True if the SWidget should be Wrapped in a Component

Examples
/work/Engine/Source/Runtime/UMG/Public/Components/Widget.h.

◆ Clipping

EWidgetClipping UWidget::Clipping

Controls how the clipping behavior of this widget. Normally content that overflows the bounds of the widget continues rendering. Enabling clipping prevents that overflowing content from being seen.

NOTE: Elements in different clipping spaces can not be batched together, and so there is a performance cost to clipping. Do not enable clipping unless a panel actually needs to prevent content from showing up outside its bounds.

Examples
/work/Engine/Source/Runtime/UMG/Public/Components/Widget.h.

◆ ComponentWrapperWidget

TWeakPtr<SWidget> UWidget::ComponentWrapperWidget
protected

The underlying SWidget for the Component wrapper widget.

Examples
/work/Engine/Source/Runtime/UMG/Public/Components/Widget.h.

◆ Cursor

TEnumAsByte<EMouseCursor::Type> UWidget::Cursor

The cursor to show when the mouse is over the widget

Examples
/work/Engine/Source/Runtime/UMG/Public/Components/Widget.h.

◆ FlowDirectionPreference

EFlowDirectionPreference UWidget::FlowDirectionPreference

Allows you to set a new flow direction

Examples
/work/Engine/Source/Runtime/UMG/Public/Components/Widget.h.

◆ MyGCWidget

TWeakPtr<SObjectWidget> UWidget::MyGCWidget
protected

◆ MyWidget

TWeakPtr<SWidget> UWidget::MyWidget
protected

◆ MyWidgetStateBitfield

FWidgetStateBitfield UWidget::MyWidgetStateBitfield
protected

The bitfield for this widget's state

Examples
/work/Engine/Source/Runtime/UMG/Public/Components/Widget.h.

◆ NativeBindings

TArray<TObjectPtr<UPropertyBinding> > UWidget::NativeBindings
protected

◆ Navigation

TObjectPtr<class UWidgetNavigation> UWidget::Navigation

The navigation object for this widget is optionally created if the user has configured custom navigation rules for this widget in the widget designer. Those rules determine how navigation transitions can occur between widgets.

Examples
/work/Engine/Source/Runtime/UMG/Public/Components/Widget.h.

◆ PostWidgetStateChanged

FOnWidgetStateBroadcast UWidget::PostWidgetStateChanged
protected

Delegate that broadcasts after current widget state has fully changed, including all state-related side effects

Examples
/work/Engine/Source/Runtime/UMG/Public/Components/Widget.h.

◆ RenderOpacity

float UWidget::RenderOpacity
protected

◆ RenderTransform

FWidgetTransform UWidget::RenderTransform

The render transform of the widget allows for arbitrary 2D transforms to be applied to the widget.

Examples
/work/Engine/Source/Runtime/UMG/Public/Components/Widget.h.

◆ RenderTransformPivot

FVector2D UWidget::RenderTransformPivot

The render transform pivot controls the location about which transforms are applied.
This value is a normalized coordinate about which things like rotations will occur.

Examples
/work/Engine/Source/Runtime/UMG/Public/Components/Widget.h.

◆ Slot

TObjectPtr<UPanelSlot> UWidget::Slot

The parent slot of the UWidget. Allows us to easily inline edit the layout controlling this widget.

Examples
/work/Engine/Source/Runtime/UMG/Public/Components/Widget.h.

◆ ToolTipText

FText UWidget::ToolTipText

Tooltip text to show when the user hovers over the widget with the mouse

Examples
/work/Engine/Source/Runtime/UMG/Public/Components/Widget.h.

◆ ToolTipTextDelegate

FGetText UWidget::ToolTipTextDelegate

A bindable delegate for ToolTipText

Examples
/work/Engine/Source/Runtime/UMG/Public/Components/Widget.h.

◆ ToolTipWidget

TObjectPtr<UWidget> UWidget::ToolTipWidget

Tooltip widget to show when the user hovers over the widget with the mouse

Examples
/work/Engine/Source/Runtime/UMG/Public/Components/Widget.h.

◆ ToolTipWidgetDelegate

FGetWidget UWidget::ToolTipWidgetDelegate

A bindable delegate for ToolTipWidget

Examples
/work/Engine/Source/Runtime/UMG/Public/Components/Widget.h.

◆ Visibility

ESlateVisibility UWidget::Visibility

The visibility of the widget

Examples
/work/Engine/Source/Runtime/UMG/Public/Components/Widget.h.

◆ VisibilityDelegate

FGetSlateVisibility UWidget::VisibilityDelegate

A bindable delegate for Visibility

Examples
/work/Engine/Source/Runtime/UMG/Public/Components/Widget.h.

◆ WidgetGeneratedByClass

TWeakObjectPtr<UClass> UWidget::WidgetGeneratedByClass

Stores a reference to the class responsible for this widgets construction.

Examples
/work/Engine/Source/Runtime/UMG/Public/Components/Widget.h.

The documentation for this class was generated from the following files: