1. Epic GamesDeveloper
  3. UWidget

UWidget

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

API > API/Runtime > API/Runtime/UMG

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

   
Name UWidget
Type class
Header File /Engine/Source/Runtime/UMG/Public/Components/Widget.h
Include Path #include "Components/Widget.h"

Syntax

UCLASS (Abstract, BlueprintType, Blueprintable, CustomFieldNotify, MinimalAPI)  
class UWidget :  
    public UVisual ,  
    public INotifyFieldValueChanged

Inheritance Hierarchy

Implements Interfaces

Derived Classes

UWidget derived class hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UWidget ( const FObjectInitializer& ObjectInitializer
)

   Components/Widget.h  

Classes

Name Remarks
FGenerateWidgetForObject  
FGenerateWidgetForString Events.
FGetBool Common Bindings - If you add any new common binding, you must provide a UPropertyBinding for it.
FGetCheckBoxState  
FGetFloat  
FGetInt32  
FGetLinearColor  
FGetMouseCursor  
FGetSlateBrush  
FGetSlateColor  
FGetSlateVisibility  
FGetText  
FGetWidget  
FOnPointerEvent  
FOnReply Events.

Typedefs

Name Type Remarks Include Path
ConstructMethodType TFunctionRef< TSharedPtr< SObjectWidget >(UUserWidget *, TSharedRef< SWidget >)>   Components/Widget.h
FOnWidgetStateBroadcast TMulticastDelegate_TwoParams< void, UWidget *, const FWidgetStateBitfield & >   Components/Widget.h

Constants

Name Type Remarks Include Path
BinderClasses TArray< TSubclassOf< UPropertyBinding > >   Components/Widget.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
AccessibleBehavior ESlateAccessibleBehavior Whether or not the widget is accessible, and how to describe it. Components/Widget.h
  • EditAnywhere
  • Category="Accessibility"
  • Meta=(EditCondition="bOverrideAccessibleDefaults")
AccessibleSummaryBehavior ESlateAccessibleBehavior How to describe this widget when it's being presented through a summary of a parent widget. Components/Widget.h
  • EditAnywhere
  • Category="Accessibility"
  • AdvancedDisplay
  • Meta=(EditCondition="bOverrideAccessibleDefaults")
AccessibleSummaryText FText When AccessibleSummaryBehavior is set to Custom, this is the text that will be used to describe the widget. Components/Widget.h
  • EditAnywhere
  • Category="Accessibility"
  • Meta=(MultiLine=true)
  • AdvancedDisplay
AccessibleSummaryTextDelegate USlateAccessibleWidgetData::FGetText An optional delegate that may be assigned in place of AccessibleSummaryText for creating a TAttribute Components/Widget.h  
AccessibleText FText When AccessibleBehavior is set to Custom, this is the text that will be used to describe the widget. Components/Widget.h
  • EditAnywhere
  • Category="Accessibility"
  • Meta=(MultiLine=true)
AccessibleTextDelegate USlateAccessibleWidgetData::FGetText An optional delegate that may be assigned in place of AccessibleText for creating a TAttribute Components/Widget.h  
bCanChildrenBeAccessible uint8 Whether or not children of this widget can appear as distinct accessible widgets. Components/Widget.h
  • EditAnywhere
  • Category="Accessibility"
  • Meta=(EditCondition="bOverrideAccessibleDefaults")
bCreatedByConstructionScript uint8 Flag if the Widget was created from a blueprint Components/Widget.h
  • Transient
bExpandedInDesigner uint8 Stores the design time flag setting if the widget is expanded inside the designer Components/Widget.h  
bHiddenInDesigner uint8 Stores the design time flag setting if the widget is hidden inside the designer Components/Widget.h  
bIsEnabled uint8 Sets whether this widget can be modified interactively by the user Components/Widget.h
  • EditAnywhere
  • BlueprintReadWrite
  • FieldNotify
  • Getter="GetIsEnabled"
  • Setter="SetIsEnabled"
  • BlueprintGetter="GetIsEnabled"
  • BlueprintSetter="SetIsEnabled"
  • Category="Behavior"
bIsEnabledDelegate FGetBool A bindable delegate for bIsEnabled Components/Widget.h  
bIsVariable uint8 Allows controls to be exposed as variables in a blueprint. Components/Widget.h  
bLockedInDesigner uint8 Stores the design time flag setting if the widget is locked inside the designer Components/Widget.h  
bOverride_Cursor uint8   Components/Widget.h
  • EditAnywhere
  • Category="Behavior"
  • Meta=(InlineEditConditionToggle)
bOverrideAccessibleDefaults uint8 These editor-only properties exist for two reasons: Components/Widget.h
  • EditAnywhere
  • Category="Accessibility"
bWrappedByComponent uint8 True if the SWidget should be Wrapped in a Component Components/Widget.h
  • Transient
Clipping EWidgetClipping Controls how the clipping behavior of this widget. Components/Widget.h
  • EditAnywhere
  • BlueprintReadWrite
  • Getter
  • Setter
  • Category="Rendering"
Cursor TEnumAsByte< EMouseCursor::Type > The cursor to show when the mouse is over the widget Components/Widget.h
  • EditAnywhere
  • BlueprintReadWrite
  • Getter
  • Setter
  • BlueprintSetter="SetCursor"
  • Category="Behavior"
  • AdvancedDisplay
  • Meta=(editcondition="bOverride_Cursor")
FlowDirectionPreference EFlowDirectionPreference Allows you to set a new flow direction Components/Widget.h
  • EditAnywhere
  • BlueprintReadWrite
  • Getter
  • Setter
  • Category="Localization"
Navigation TObjectPtr< class UWidgetNavigation > The navigation object for this widget is optionally created if the user has configured custom navigation rules for this widget in the widget designer. Components/Widget.h
  • Instanced
  • EditAnywhere
  • BlueprintReadOnly
  • Category="Navigation"
RenderTransform FWidgetTransform The render transform of the widget allows for arbitrary 2D transforms to be applied to the widget. Components/Widget.h
  • EditAnywhere
  • BlueprintReadWrite
  • Getter
  • Setter
  • BlueprintSetter="SetRenderTransform"
  • Category="Render Transform"
  • Meta=(DisplayName="Transform")
RenderTransformPivot FVector2D The render transform pivot controls the location about which transforms are applied. Components/Widget.h
  • EditAnywhere
  • BlueprintReadWrite
  • Getter
  • Setter
  • BlueprintSetter="SetRenderTransformPivot"
  • Category="Render Transform"
  • Meta=(DisplayName="Pivot")
Slot TObjectPtr< UPanelSlot > The parent slot of the UWidget. Components/Widget.h
  • Instanced
  • TextExportTransient
  • EditAnywhere
  • BlueprintReadOnly
  • Category=Layout
  • Meta=(ShowOnlyInnerProperties)
ToolTipText FText Tooltip text to show when the user hovers over the widget with the mouse Components/Widget.h
  • EditAnywhere
  • BlueprintReadWrite
  • Getter
  • Setter
  • BlueprintSetter="SetToolTipText"
  • Category="Behavior"
  • Meta=(MultiLine=true)
ToolTipTextDelegate FGetText A bindable delegate for ToolTipText Components/Widget.h  
ToolTipWidget TObjectPtr< UWidget > Tooltip widget to show when the user hovers over the widget with the mouse Components/Widget.h
  • VisibleAnywhere
  • BlueprintReadWrite
  • Getter="GetToolTip"
  • Setter="SetToolTip"
  • BlueprintSetter="SetToolTip"
  • Category="Behavior"
  • AdvancedDisplay
ToolTipWidgetDelegate FGetWidget A bindable delegate for ToolTipWidget Components/Widget.h  
UGameViewportSubsystem friend   Components/Widget.h  
Visibility ESlateVisibility The visibility of the widget Components/Widget.h
  • EditAnywhere
  • BlueprintReadWrite
  • FieldNotify
  • Getter
  • Setter
  • BlueprintGetter="GetVisibility"
  • BlueprintSetter="SetVisibility"
  • Category="Behavior"
VisibilityDelegate FGetSlateVisibility A bindable delegate for Visibility Components/Widget.h  
WidgetGeneratedBy TWeakObjectPtr< UObject > Stores a reference to the asset responsible for this widgets construction. Components/Widget.h  
WidgetGeneratedByClass TWeakObjectPtr< UClass > Stores a reference to the class responsible for this widgets construction. Components/Widget.h  

Protected

Name Type Remarks Include Path Unreal Specifiers
AccessibleWidgetData TObjectPtr< USlateAccessibleWidgetData > A custom set of accessibility rules for this widget. Components/Widget.h
  • Instanced
bRoutedSynchronizeProperties bool Did we route the synchronize properties call? Components/Widget.h  
CategoryName FString Category name used in the widget designer for sorting purpose Components/Widget.h  
DesignerFlags uint8 Any flags used by the designer at edit time. Components/Widget.h
  • Transient
DesignWrapperWidget TWeakPtr< SWidget > The underlying SWidget for the design time wrapper widget. Components/Widget.h  
DisplayLabel FString The friendly name for this widget displayed in the designer and BP graph. Components/Widget.h  
EnabledFieldNotifications TBitArray   Components/Widget.h  
K2_Cache_AccessibleSummaryText FText   Components/Widget.h  
K2_Cache_AccessibleText FText   Components/Widget.h  
K2_Cache_bIsEnabled bool   Components/Widget.h  
K2_Cache_ToolTipText FText   Components/Widget.h  
PixelSnapping EWidgetPixelSnapping If the widget will draw snapped to the nearest pixel. Components/Widget.h
  • EditAnywhere
  • BlueprintReadWrite
  • Getter
  • Setter
  • Category="Rendering"
  • Meta=(AllowPrivateAccess=true)

Functions

Public

Name Remarks Include Path Unreal Specifiers

bool AddBinding ( FDelegateProperty* DelegateProperty,
UObject* SourceObject,
const FDynamicPropertyPath& BindingPath
)

   Components/Widget.h  

void BuildNavigation ()

 Called by the owning user widget after the slate widget has been created. Components/Widget.h  

bool CanSafelyRouteEvent()

   Components/Widget.h  

bool CanSafelyRoutePaint()

   Components/Widget.h  

virtual void ConnectEditorData()

 Allows general fixups and connections only used at editor time. Components/Widget.h  

void CreatedFromPalette()

 Called by the palette after constructing a new widget. Components/Widget.h  

void DeselectByDesigner()

   Components/Widget.h  
Forces a pre-pass. Components/Widget.h
  • BlueprintCallable
  • Category="Widget"

void ForceVolatile ( bool bForce
)

 Sets the forced volatility of the widget. Components/Widget.h
  • BlueprintCallable
  • Category="Widget"

FText GetAccessibleSummaryText()

 Gets the accessible summary text from the underlying Slate accessible widget. Components/Widget.h
  • BlueprintCallable
  • Category="Widget"

FText GetAccessibleText()

 Gets the accessible text from the underlying Slate accessible widget Components/Widget.h
  • BlueprintCallable
  • Category="Widget"
Gets the last geometry used to Tick the widget. Components/Widget.h
  • BlueprintCallable
  • Category="Widget"

TSharedPtr< SWidget > GetCachedWidget()

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

TSharedPtr< SWidget > GetCachedWrappedWidget()

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

const FString & GetCategoryName()

 Returns the category name of the widget Components/Widget.h  

EWidgetClipping GetClipping()

 Gets the clipping state of this widget. Components/Widget.h
  • BlueprintCallable
  • Category="Widget"

EMouseCursor::Type GetCursor()

 Sets the cursor to show over the widget. Components/Widget.h  

EWidgetDesignFlags GetDesignerFlags()

 Gets the designer flags currently set on the widget. Components/Widget.h  

FVector2D GetDesiredSize ()

 Gets the widgets desired size. Components/Widget.h
  • BlueprintCallable
  • Category="Widget"

const FString & GetDisplayLabel()

 Returns the friendly name of the widget to display in the editor Components/Widget.h  

EFlowDirectionPreference GetFlowDirectionPreference()

 Gets the flow direction preference of the widget Components/Widget.h  

TGameInstance * GetGameInstance ()

 Gets the game instance associated with this UI. Components/Widget.h  
Gets the game instance associated with this UI. Components/Widget.h
  • BlueprintCallable
  • BlueprintCosmetic
  • Category="Widget"

bool GetIsEnabled()

 Gets the current enabled status of the widget Components/Widget.h
  • BlueprintCallable
  • Category="Widget"

virtual FString GetLabelMetadata()

 Get Label Metadata, which may be as simple as a bit of string data to help identify an anonymous text block. Components/Widget.h  

FText GetLabelText()

 Gets the label to display to the user for this widget. Components/Widget.h  

FText GetLabelTextWithMetadata()

 Gets the label to display to the user for this widget, including any extra metadata like the text string for text. Components/Widget.h  
Gets the local player associated with this UI cast to the template type. Components/Widget.h  
Gets the local player associated with this UI. Components/Widget.h
  • BlueprintCallable
  • BlueprintCosmetic
  • Category="Widget"

TPlayerController * GetOwningPlayer ()

 Gets the player controller associated with this UI cast to the template type. Components/Widget.h  
Gets the player controller associated with this UI. Components/Widget.h
  • BlueprintCallable
  • BlueprintCosmetic
  • Category="Widget"

const FGeometry & GetPaintSpaceGeometry()

   Components/Widget.h
  • BlueprintCallable
  • Category="Widget"

virtual const FText GetPaletteCategory()

 Gets the palette category of the widget Components/Widget.h  

UPanelWidget * GetParent()

 Gets the parent widget Components/Widget.h
  • BlueprintCallable
  • Category="Widget"

EWidgetPixelSnapping GetPixelSnapping()

 Gets the pixel snapping method of this widget. Components/Widget.h  

float GetRenderOpacity()

 Gets the current visibility of the widget. Components/Widget.h
  • BlueprintCallable
  • Category="Widget"

const FWidgetTransform & GetRenderTransform()

   Components/Widget.h  

float GetRenderTransformAngle()

   Components/Widget.h
  • BlueprintCallable
  • Category="Widget|Transform"

FVector2D GetRenderTransformPivot()

   Components/Widget.h  

const FGeometry & GetTickSpaceGeometry()

   Components/Widget.h
  • BlueprintCallable
  • Category="Widget"

UWidget * GetToolTip()

   Components/Widget.h  

FText GetToolTipText()

   Components/Widget.h  

ESlateVisibility GetVisibility()

 Gets the current visibility of the widget. Components/Widget.h
  • BlueprintCallable
  • Category="Widget"

virtual UWorld * GetWorld()

   Components/Widget.h  

bool HasAnyDesignerFlags ( EWidgetDesignFlags FlagsToCheck
) const

 Tests if any of the flags exist on this widget. Components/Widget.h  

bool HasAnyUserFocus()

 Returns true if this widget is focused by any user. Components/Widget.h
  • BlueprintCallable
  • Category="Widget"

bool HasFocusedDescendants()

 Returns true if any descendant widget is focused by any user. Components/Widget.h
  • BlueprintCallable
  • Category="Widget"
  • Meta=(DisplayName="HasAnyUserFocusedDescendants")

bool HasKeyboardFocus()

 Checks to see if this widget currently has the keyboard focus Components/Widget.h
  • BlueprintCallable
  • Category="Widget"

bool HasMouseCapture()

 Checks to see if this widget is the current mouse captor Components/Widget.h
  • BlueprintCallable
  • Category="Widget"

bool HasMouseCaptureByUser ( int32 UserIndex,
int32 PointerIndex
) const

 Checks to see if this widget is the current mouse captor Components/Widget.h
  • BlueprintCallable
  • Category="Widget"

bool HasUserFocus ( APlayerController* PlayerController
) const

 Returns true if this widget is focused by a specific user. Components/Widget.h
  • BlueprintCallable
  • Category="Widget"

bool HasUserFocusedDescendants ( APlayerController* PlayerController
) const

 Returns true if any descendant widget is focused by a specific user. Components/Widget.h
  • BlueprintCallable
  • Category="Widget"
Invalidates the widget from the view of a layout caching widget that may own this widget. Components/Widget.h
  • BlueprintCallable
  • Category="Widget"

bool IsChildOf ( UWidget* PossibleParent
)

 Recurses up the list of parents and returns true if this widget is a descendant of the PossibleParent Components/Widget.h  

bool IsConstructed()

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

bool IsDesignTime()

 Returns if the widget is currently being displayed in the designer, it may want to display different data. Components/Widget.h  

bool IsGeneratedName()

 Is the label generated or provided by the user? Components/Widget.h  

virtual bool IsHovered()

 Returns true if the widget is currently being hovered by a pointer device Components/Widget.h
  • BlueprintCallable
  • Category="Widget"

bool IsInViewport()

   Components/Widget.h
  • BlueprintPure
  • BlueprintCosmetic
  • Category="Appearance"

bool IsLockedInDesigner()

 Is this widget locked in the designer UI Components/Widget.h  

bool IsPreviewTime()

   Components/Widget.h  

bool IsRendered()

 Returns true if the widget is Visible, HitTestInvisible or SelfHitTestInvisible and the Render Opacity is greater than 0. Components/Widget.h
  • BlueprintCallable
  • Category="Widget"

bool IsVisible()

 Returns true if the widget is Visible, HitTestInvisible or SelfHitTestInvisible. Components/Widget.h
  • BlueprintCallable
  • Category="Widget"

bool IsVisibleInDesigner()

 Is the widget visible in the designer? If this widget is 'hidden in the designer' or a parent is, this widget will also return false here. Components/Widget.h  

void K2_AddFieldValueChangedDelegate ( FFieldNotificationId FieldId,
FFieldValueChangedDynamicDelegate Delegate
)

   Components/Widget.h
  • BlueprintCallable
  • Category="FieldNotify"
  • Meta=(DisplayName="Add Field Value Changed Delegate", ScriptName="AddFieldValueChangedDelegate")

void K2_RemoveFieldValueChangedDelegate ( FFieldNotificationId FieldId,
FFieldValueChangedDynamicDelegate Delegate
)

   Components/Widget.h
  • BlueprintCallable
  • Category="FieldNotify"
  • Meta=(DisplayName="Remove Field Value Changed Delegate", ScriptName="RemoveFieldValueChangedDelegate")

virtual void OnBeginEditByDesigner()

   Components/Widget.h  

virtual void OnCreationFromPalette ()

 Called after constructing a new widget from the palette. Components/Widget.h  

virtual void OnDescendantDeselectedByDesigner ( UWidget* DescendantWidget
)

   Components/Widget.h  

virtual void OnDescendantSelectedByDesigner ( UWidget* DescendantWidget
)

   Components/Widget.h  

virtual void OnDeselectedByDesigner()

   Components/Widget.h  

virtual void OnDesignerChanged ( const FDesignerChangedEventArgs& EventArgs
)

   Components/Widget.h  

virtual void OnEndEditByDesigner()

   Components/Widget.h  

virtual void OnSelectedByDesigner()

   Components/Widget.h  

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

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

virtual void RemoveFromParent ()

 Removes the widget from its parent widget. Components/Widget.h
  • BlueprintCallable
  • Category="Widget"

void ResetCursor()

 Resets the cursor to use on the widget, removing any customization for it. Components/Widget.h
  • BlueprintCallable
  • Category="Widget"

void SelectByDesigner()

 Begin Designer contextual events. Components/Widget.h  

void SetAllNavigationRules ( EUINavigationRule Rule,
FName WidgetToFocus
)

 Sets the widget navigation rules for all directions. Components/Widget.h
  • BlueprintCallable
  • Category="Widget"

void SetCategoryName ( const FString& InValue
)

 Sets the category name of the widget Components/Widget.h  

void SetClipping ( EWidgetClipping InClipping
)

 Sets the clipping state of this widget. Components/Widget.h
  • BlueprintCallable
  • Category="Widget"

void SetCursor ( EMouseCursor::Type InCursor
)

 Sets the cursor to show over the widget. Components/Widget.h
  • BlueprintCallable
  • Category="Widget"

virtual void SetDesignerFlags ( EWidgetDesignFlags NewFlags
)

 Sets the designer flags on the widget. Components/Widget.h  

void SetDisplayLabel ( const FString& DisplayLabel
)

 Sets the friendly name of the widget to display in the editor Components/Widget.h  

void SetFlowDirectionPreference ( EFlowDirectionPreference FlowDirection
)

 Sets the flow direction preference of the widget Components/Widget.h  

void SetFocus()

 Sets the focus to this widget for the owning user Components/Widget.h
  • BlueprintCallable
  • Category="Widget"

virtual void SetIsEnabled ( bool bInIsEnabled
)

 Sets the current enabled status of the widget Components/Widget.h
  • BlueprintCallable
  • Category="Widget"

void SetKeyboardFocus()

 Sets the focus to this widget. Components/Widget.h
  • BlueprintCallable
  • Category="Widget"

virtual void SetLockedInDesigner ( bool NewLockedInDesigner
)

   Components/Widget.h  

void SetNavigationMethod ( const TInstancedStruct< FNavigationMethod >& NavigationMethod
)

 Sets the widget navigation method for this widget hierarchy. Components/Widget.h  

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

 Sets the widget navigation rules for a specific direction. Components/Widget.h
  • BlueprintCallable
  • Category="Widget"
  • Meta=(DeprecatedFunction, DeprecatedMessage="Please use either SetNavigationRuleBase or SetNavigationRuleExplicit or SetNavigationRuleCustom or SetNavigationRuleCustomBoundary.")
Sets the widget navigation rules for a specific direction. Components/Widget.h
  • BlueprintCallable
  • Category="Widget"
Sets the widget navigation rules for a specific direction. Components/Widget.h
  • BlueprintCallable
  • Category="Widget"
Sets the widget navigation rules for a specific direction. Components/Widget.h
  • BlueprintCallable
  • Category="Widget"

void SetNavigationRuleExplicit ( EUINavigation Direction,
UWidget* InWidget
)

 Sets the widget navigation rules for a specific direction. Components/Widget.h
  • BlueprintCallable
  • Category="Widget"

void SetPixelSnapping ( EWidgetPixelSnapping InPixelSnapping
)

 Sets the pixel snapping method of this widget. Components/Widget.h  

void SetRenderOpacity ( float InOpacity
)

 Sets the visibility of the widget. Components/Widget.h
  • BlueprintCallable
  • Category="Widget"

void SetRenderScale ( FVector2D Scale
)

   Components/Widget.h
  • BlueprintCallable
  • Category="Widget|Transform"

void SetRenderShear ( FVector2D Shear
)

   Components/Widget.h
  • BlueprintCallable
  • Category="Widget|Transform"

void SetRenderTransform ( FWidgetTransform InTransform
)

   Components/Widget.h
  • BlueprintCallable
  • Category="Widget|Transform"

void SetRenderTransformAngle ( float Angle
)

   Components/Widget.h
  • BlueprintCallable
  • Category="Widget|Transform"

void SetRenderTransformPivot ( FVector2D Pivot
)

   Components/Widget.h
  • BlueprintCallable
  • Category="Widget|Transform"

void SetRenderTranslation ( FVector2D Translation
)

   Components/Widget.h
  • BlueprintCallable
  • Category="Widget|Transform"

void SetToolTip ( UWidget* Widget
)

 Sets a custom widget as the tooltip of the widget. Components/Widget.h
  • BlueprintCallable
  • Category="Widget"

void SetToolTipText ( const FText& InToolTipText
)

 Sets the tooltip text for the widget. Components/Widget.h
  • BlueprintCallable
  • Category="Widget"

void SetUserFocus ( APlayerController* PlayerController
)

 Sets the focus to this widget for a specific user (if setting focus for the owning user, prefer SetFocus()) Components/Widget.h
  • BlueprintCallable
  • Category="Widget"

virtual void SetVisibility ( ESlateVisibility InVisibility
)

 Sets the visibility of the widget. Components/Widget.h
  • BlueprintCallable
  • Category="Widget"

virtual void SynchronizeProperties ()

 Applies all properties to the native widget if possible. Components/Widget.h  

TSharedRef< WidgetType > TakeDerivedWidget ( ConstructMethodType ConstructMethod
)

   Components/Widget.h  
Gets the underlying slate widget or constructs it if it doesn't exist. Components/Widget.h  

UE_FIELD_NOTIFICATION_DECLARE_CLASS_DESCRIPTOR_BASE_BEGIN ( UMG_API
)

   Components/Widget.h  

UMG_APIUMG_API UE_FIELD_NOTIFICATION_DECLARE_ENUM_FIELD_BEGIN ( ToolTipText
)

   Components/Widget.h  

UMG_API UE_FIELD_NOTIFICATION_DECLARE_FIELD ( Visibility,
UMG_API
)

   Components/Widget.h  

void UnregisterPostStateListener ( const FDelegateHandle& ListenerDelegate
)

 Remove a post-state-changed listener from this widget, resets state bitfield if no other state listeners exist Components/Widget.h  

virtual void ValidateCompiledDefaults ( IWidgetCompilerLog& CompileLog
) const

 Called at the end of Widget Blueprint compilation. Components/Widget.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void BeginDestroy()

   Components/Widget.h  

virtual void FinishDestroy()

   Components/Widget.h  

virtual bool Modify ( bool bAlwaysMarkDirty
)

 Mark this object as modified, also mark the slot as modified. Components/Widget.h  

virtual void PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

   Components/Widget.h  

virtual void PreSave ( FObjectPreSaveContext ObjectSaveContext
)

   Components/Widget.h  

Overridden from INotifyFieldValueChanged

Name Remarks Include Path Unreal Specifiers

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

   Components/Widget.h  

virtual void BroadcastFieldValueChanged ( UE::FieldNotification::FFieldId InFieldId
)

   Components/Widget.h  

virtual int32 RemoveAllFieldValueChangedDelegates ( FDelegateUserObjectConst InUserObject
)

   Components/Widget.h  

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

   Components/Widget.h  

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

   Components/Widget.h  

Protected

Name Remarks Include Path Unreal Specifiers

void BroadcastBinaryPostStateChange ( const FWidgetStateBitfield& StateChange,
bool bInValue
)

 Broadcast a binary state post change Components/Widget.h  

void BroadcastEnumPostStateChange ( const FWidgetStateBitfield& StateChange
)

 Broadcast an enum state post change Components/Widget.h  

bool CanSafelyRouteCall()

   Components/Widget.h  

TOptional< float > ConvertFloatToOptionalFloat ( TAttribute< float > InFloat
) const

   Components/Widget.h  

FSlateColor ConvertLinearColorToSlateColor ( TAttribute< FLinearColor > InLinearColor
) const

   Components/Widget.h  

EVisibility ConvertVisibility ( TAttribute< ESlateVisibility > SerializedType
) const

 TODO UMG Consider moving conversion functions into another class. Conversion functions Components/Widget.h  

TSharedRef< SWidget > CreateDesignerOutline ( TSharedRef< SWidget > Content
) const

   Components/Widget.h  

virtual TSharedPtr< SWidget > GetAccessibleWidget()

 Gets the widget that accessibility properties should synchronize to. Components/Widget.h  

FText GetDisplayNameBase()

 Gets the base name used to generate the display label/name of this widget. Components/Widget.h  

UObject * GetSourceAssetOrClass()

   Components/Widget.h  

EVisibility GetVisibilityInDesigner()

 This is an implementation detail that allows us to show and hide the widget in the designer regardless of the actual visibility state set by the user. Components/Widget.h  

bool IsEditorWidget()

   Components/Widget.h  

void K2_BroadcastFieldValueChanged ( FFieldNotificationId FieldId
)

   Components/Widget.h
  • BlueprintCallable
  • Category="FieldNotify"
  • Meta=(DisplayName="Broadcast Field Value Changed", ScriptName="BroadcastFieldValueChanged")

virtual void OnBindingChanged ( const FName& Property
)

   Components/Widget.h  

virtual void OnWidgetRebuilt()

 Function called after the underlying SWidget is constructed. Components/Widget.h  

virtual TSharedRef< SWidget > RebuildDesignWidget ( TSharedRef< SWidget > Content
)

   Components/Widget.h  

virtual TSharedRef< SWidget > RebuildWidget()

 Function implemented by all subclasses of UWidget is called when the underlying SWidget needs to be constructed. Components/Widget.h  

void SetNavigationRuleInternal ( EUINavigation Direction,
EUINavigationRule Rule,
FName WidgetToFocus,
UWidget* InWidget,
FCustomWidgetNavigationDelegate InCustomDelegate
)

   Components/Widget.h  

void SetVisibilityInternal ( ESlateVisibility InVisibility
)

   Components/Widget.h  

void SynchronizeAccessibleData()

 Copy all accessible properties to the AccessibleWidgetData object Components/Widget.h  

void UpdateRenderTransform()

   Components/Widget.h  

Static

Name Remarks Include Path Unreal Specifiers

static ESlateVisibility ConvertRuntimeToSerializedVisibility ( const EVisibility& Input
)

   Components/Widget.h  

static FSizeParam ConvertSerializedSizeParamToRuntime ( const FSlateChildSize& Input
)

   Components/Widget.h  

static EVisibility ConvertSerializedVisibilityToRuntime ( ESlateVisibility Input
)

 End Designer contextual events. Components/Widget.h  

static TSubclassOf< UPropertyBinding > FindBinderClassForDestination ( FProperty* Property
)

   Components/Widget.h  

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

   Components/Widget.h  

static FString GetDefaultFontName()

   Components/Widget.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page