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 > API/Runtime/UMG/Components

Inheritance Hierarchy

References

   
Module UMG
Header /Engine/Source/Runtime/UMG/Public/Components/Widget.h
Include #include "Components/Widget.h"

Syntax

class UWidget :  
    public UVisual,  
    public INotifyFieldValueChanged

Remarks

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

Variables

  Type Name Description
Public variable ESlateAccessibleBehavior AccessibleBehavior Whether or not the widget is accessible, and how to describe it.
Public variable ESlateAccessibleBehavior AccessibleSummaryBehavior How to describe this widget when it's being presented through a summary of a parent widget.
Public variable FText AccessibleSummaryText When AccessibleSummaryBehavior is set to Custom, this is the text that will be used to describe the widget.
Public variable USlateAccessibleWidgetData::FGetText AccessibleSummaryTextDelegate An optional delegate that may be assigned in place of AccessibleSummaryText for creating a TAttribute
Public variable FText AccessibleText When AccessibleBehavior is set to Custom, this is the text that will be used to describe the widget.
Public variable USlateAccessibleWidgetData::FGetText AccessibleTextDelegate An optional delegate that may be assigned in place of AccessibleText for creating a TAttribute
Public variable uint8: 1 bCanChildrenBeAccessible Whether or not children of this widget can appear as distinct accessible widgets.
Public variable uint8: 1 bCreatedByConstructionScript Flag if the Widget was created from a blueprint
Public variable uint8: 1 bExpandedInDesigner Stores the design time flag setting if the widget is expanded inside the designer
Public variable uint8: 1 bHiddenInDesigner Stores the design time flag setting if the widget is hidden inside the designer
Public variable FGetBool bIsEnabledDelegate A bindable delegate for bIsEnabled
Protected variable uint8: 1 bIsManagedByGameViewportSubsystem Cached value that indicate if the widget was added to the GameViewportSubsystem.
Public variable uint8: 1 bIsVariable Allows controls to be exposed as variables in a blueprint.
Protected variable uint8: 1 bIsVolatile If true prevents the widget or its child's geometry or layout information from being cached.
Public variable uint8: 1 bLockedInDesigner Stores the design time flag setting if the widget is locked inside the designer
Public variable uint8: 1 bOverride_Cursor  
Public variable uint8: 1 bOverrideAccessibleDefaults These editor-only properties exist for two reasons:
Protected variable bool bShouldBroadcastState False will skip state broadcasts.
Protected variable TWeakPtr< SObjectWidget > MyGCWidget The underlying SWidget contained in a SObjectWidget
Protected variable TWeakPtr< SWidget > MyWidget The underlying SWidget.
Protected variable TSharedPtr< FWidgetStateBitfield > MyWidgetStateBitfield The bitfield for this widget's state
Protected variable TArray< TObjectPtr< UPropertyBinding > > NativeBindings Native property bindings.
Public variable TObjectPtr< class UWidgetNavigation > 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.
Protected variable FOnWidgetStateBroadcast PostWidgetStateChanged Delegate that broadcasts after current widget state has fully changed, including all state-related side effects
Public variable TObjectPtr< UPanelSlot > Slot The parent slot of the UWidget.
Public variable FGetText ToolTipTextDelegate A bindable delegate for ToolTipText
Public variable FGetWidget ToolTipWidgetDelegate A bindable delegate for ToolTipWidget
Public variable friend UGameViewportSubsystem  
Public variable FGetSlateVisibility VisibilityDelegate A bindable delegate for Visibility
Public variable TWeakObjectPtr< UObject > WidgetGeneratedBy Stores a reference to the asset responsible for this widgets construction.
Public variable TWeakObjectPtr< UClass > WidgetGeneratedByClass Stores a reference to the class responsible for this widgets construction.

Constructors

  Type Name Description
Public function  

UWidget ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function bool

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

  
Protected function void

BroadcastBinaryPostStateChange ( const FWidgetStateBitfield& StateChange,
bool bInValue
)

 Broadcast a binary state post change
Protected function void Broadcast an enum state post change
Public function void Called by the owning user widget after the slate widget has been created.
Protected function bool  
Public function bool  
Public function bool  
Public function Virtual void Allows general fixups and connections only used at editor time.
Protected function Const TOptional< float >  
Protected function Const FSlateColor  
Public function Static ESlateVisibility  
Public function Static FSizeParam  
Public function Static EVisibility

ConvertSerializedVisibilityToRuntime ( ESlateVisibility Input
)

 End Designer contextual events.
Protected function Const EVisibility

ConvertVisibility ( TAttribute< ESlateVisibility > SerializedType
)

 TODO UMG Consider moving conversion functions into another class. Conversion functions
Protected function Const TSharedRef< SWidget >  
Public function void Called by the palette after constructing a new widget.
Public function void  
Public function Static TSubclassOf< UPropertyBinding >  
Public function Static UWidget *  
Public function void Forces a pre-pass.
Public function void

ForceVolatile ( bool bForce
)

 Sets the forced volatility of the widget.
Public function Const FText Gets the accessible summary text from the underlying Slate accessible widget.
Public function Const FText Gets the accessible text from the underlying Slate accessible widget
Protected function Virtual Const TSharedPtr< SWidget > Gets the widget that accessibility properties should synchronize to.
Public function Const const FGeometry & Gets the last geometry used to Tick the widget.
Public function Const TSharedPtr< SWidget > Gets the last created widget does not recreate the gc container for the widget if one is needed.
Public function Const const FString & Returns the category name of the widget
Public function Const EWidgetClipping Gets the clipping state of this widget.
Public function Const EMouseCursor::Type Sets the cursor to show over the widget.
Public function Static FString  
Public function Const EWidgetDesignFlags Gets the designer flags currently set on the widget.
Public function Const FVector2D Gets the widgets desired size.
Public function Const const FString & Returns the friendly name of the widget to display in the editor
Protected function Const FText Gets the base name used to generate the display label/name of this widget.
Public function Const EFlowDirectionPreference Gets the flow direction preference of the widget
Public function Const UGameInstance * Gets the game instance associated with this UI.
Public function Const TGameInstance * Gets the game instance associated with this UI.
Public function Const bool Gets the current enabled status of the widget
Public function Virtual Const FString Get Label Metadata, which may be as simple as a bit of string data to help identify an anonymous text block.
Public function Const FText Gets the label to display to the user for this widget.
Public function Const FText Gets the label to display to the user for this widget, including any extra metadata like the text string for text.
Public function Const T * Gets the local player associated with this UI cast to the template type.
Public function Virtual Const ULocalPlayer * Gets the local player associated with this UI.
Public function Virtual Const APlayerController * Gets the player controller associated with this UI.
Public function Const TPlayerController * Gets the player controller associated with this UI cast to the template type.
Public function Const const FGeometry &  
Public function Virtual const FText Gets the palette category of the widget
Public function Const UPanelWidget * Gets the parent widget
Public function Const EWidgetPixelSnapping Gets the pixel snapping method of this widget.
Public function Const float Gets the current visibility of the widget.
Public function Const const FWidgetTransform &  
Public function Const float  
Public function Const FVector2D  
Protected function Const UObject *  
Public function Const const FGeometry &  
Public function Const UWidget *  
Public function Const FText  
Public function Const ESlateVisibility Gets the current visibility of the widget.
Protected function Const EVisibility 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.
Public function Virtual Const UWorld *  
Public function Const bool

HasAnyDesignerFlags ( EWidgetDesignFlags FlagsToCheck
)

 Tests if any of the flags exist on this widget.
Public function Const bool Returns true if this widget is focused by any user.
Public function Const bool Returns true if any descendant widget is focused by any user.
Public function Const bool Checks to see if this widget currently has the keyboard focus
Public function Const bool Checks to see if this widget is the current mouse captor
Public function Const bool

HasMouseCaptureByUser ( int32 UserIndex,
int32 PointerIndex
)

 Checks to see if this widget is the current mouse captor
Public function Const bool

HasUserFocus ( APlayerController* PlayerController
)

 Returns true if this widget is focused by a specific user.
Public function Const bool Returns true if any descendant widget is focused by a specific user.
Public function void Invalidates the widget from the view of a layout caching widget that may own this widget.
Public function bool

IsChildOf ( UWidget* PossibleParent
)

 Recurses up the list of parents and returns true if this widget is a descendant of the PossibleParent
Public function Const bool Gets the last created widget does not recreate the gc container for the widget if one is needed.
Public function Const bool Returns if the widget is currently being displayed in the designer, it may want to display different data.
Protected function Const bool  
Public function Const bool Is the label generated or provided by the user?
Public function Virtual Const bool Returns true if the widget is currently being hovered by a pointer device
Public function Const bool  
Public function Const bool Is this widget locked in the designer UI
Public function Const bool  
Public function Const bool Returns true if the widget is Visible, HitTestInvisible or SelfHitTestInvisible and the Render Opacity is greater than 0.
Public function Const bool Returns true if the widget is Visible, HitTestInvisible or SelfHitTestInvisible.
Public function Const bool 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.
Public function void  
Protected function void  
Public function void  
Public function Virtual void  
Protected function Virtual void

OnBindingChanged ( const FName& Property
)

  
Public function Virtual void Called after constructing a new widget from the palette.
Public function Virtual void  
Public function Virtual void

OnDescendantSelectedByDesigner ( UWidget* DescendantWidget
)

  
Public function Virtual void  
Public function Virtual void  
Public function Virtual void  
Public function Virtual void  
Protected function Virtual void Function called after the underlying SWidget is constructed.
Protected function Virtual TSharedRef< SWidget >  
Protected function Virtual TSharedRef< SWidget > Function implemented by all subclasses of UWidget is called when the underlying SWidget needs to be constructed.
Public function 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.
Public function Virtual void Removes the widget from its parent widget.
Public function void Resets the cursor to use on the widget, removing any customization for it.
Public function void Begin Designer contextual events.
Public function void

SetAllNavigationRules ( EUINavigationRule Rule,
FName WidgetToFocus
)

 Sets the widget navigation rules for all directions.
Public function void

SetCategoryName ( const FString& InValue
)

 Sets the category name of the widget
Public function void

SetClipping ( EWidgetClipping InClipping
)

 Sets the clipping state of this widget.
Public function void Sets the cursor to show over the widget.
Public function Virtual void

SetDesignerFlags ( EWidgetDesignFlags NewFlags
)

 Sets the designer flags on the widget.
Public function void

SetDisplayLabel ( const FString& DisplayLabel
)

 Sets the friendly name of the widget to display in the editor
Public function void

SetFlowDirectionPreference ( EFlowDirectionPreference FlowDirection
)

 Sets the flow direction preference of the widget
Public function void Sets the focus to this widget for the owning user
Public function Virtual void

SetIsEnabled ( bool bInIsEnabled
)

 Sets the current enabled status of the widget
Public function void Sets the focus to this widget.
Public function Virtual void

SetLockedInDesigner ( bool NewLockedInDesigner
)

  
Public function void

SetNavigationRuleBase ( EUINavigation Direction,
EUINavigationRule Rule
)

 Sets the widget navigation rules for a specific direction.
Public function void

SetNavigationRuleCustom ( EUINavigation Direction,
FCustomWidgetNavigationDelegate InCustomDelegate
)

 Sets the widget navigation rules for a specific direction.
Public function void

SetNavigationRuleCustomBoundary ( EUINavigation Direction,
FCustomWidgetNavigationDelegate InCustomDelegate
)

 Sets the widget navigation rules for a specific direction.
Public function void

SetNavigationRuleExplicit ( EUINavigation Direction,
UWidget* InWidget
)

 Sets the widget navigation rules for a specific direction.
Protected function void

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

  
Public function void

SetPixelSnapping ( EWidgetPixelSnapping InPixelSnapping
)

 Sets the pixel snapping method of this widget.
Public function void

SetRenderOpacity ( float InOpacity
)

 Sets the visibility of the widget.
Public function void

SetRenderScale ( FVector2D Scale
)

  
Public function void

SetRenderShear ( FVector2D Shear
)

  
Public function void  
Public function void

SetRenderTransformAngle ( float Angle
)

  
Public function void

SetRenderTransformPivot ( FVector2D Pivot
)

  
Public function void

SetRenderTranslation ( FVector2D Translation
)

  
Public function void

SetToolTip ( UWidget* Widget
)

 Sets a custom widget as the tooltip of the widget.
Public function void

SetToolTipText ( const FText& InToolTipText
)

 Sets the tooltip text for the widget.
Public function void

SetUserFocus ( APlayerController* PlayerController
)

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

SetVisibility ( ESlateVisibility InVisibility
)

 Sets the visibility of the widget.
Protected function void

SetVisibilityInternal ( ESlateVisibility InVisibility
)

  
Protected function void Copy all accessible properties to the AccessibleWidgetData object
Public function Virtual void Applies all properties to the native widget if possible.
Public function TSharedRef< WidgetType >  
Public function TSharedRef< SWidget > Gets the underlying slate widget or constructs it if it doesn't exist.
Public function void

UnregisterPostStateListener ( const FDelegateHandle& ListenerDelegate
)

 Remove a post-state-changed listener from this widget, resets state bitfield if no other state listeners exist
Protected function void  
Public function Virtual Const void Called at the end of Widget Blueprint compilation.

Overridden from UVisual

  Type Name Description
Public function Virtual void

ReleaseSlateResources ( bool bReleaseChildren
)

  

Overridden from UObject

  Type Name Description
Public function Virtual void Called before destroying the object.
Public function Virtual void Called to finish destroying the object.
Public function Virtual bool

Modify ( bool bAlwaysMarkDirty
)

 Mark this object as modified, also mark the slot as modified.
Public function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

 Called when a property on this object has been modified externally
Public function Virtual void

PreSave ( FObjectPreSaveContext SaveContext
)

 Presave function.

Overridden from INotifyFieldValueChanged

  Type Name Description
Public function Virtual FDelegateHandle Add a delegate that will be notified when the FieldId is value changed.
Public function Virtual void Broadcast to the registered delegate that the FieldId value changed.
Public function Virtual Const const ::UE::FieldNotification::IClassDescriptor &  
Public function Virtual int32

RemoveAllFieldValueChangedDelegates ( const void* InUserObject
)

 Remove all the delegate that are bound to the specified UserObject.
Public function Virtual int32 Remove all the delegate that are bound to the specified Field and UserObject.
Public function Virtual bool Remove a delegate that was added.

Classes

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

Typedefs

Name Description
ConstructMethodType  
FOnWidgetStateBroadcast  

Constants

Name Description
BinderClasses  

Deprecated Variables

  Type Name Description
Public variable uint8: 1 bIsEnabled Direct access to bIsEnabled is deprecated. Please use the getter or setter.
Public variable EWidgetClipping Clipping Direct access to Clipping is deprecated. Please use the getter or setter.
Public variable TEnumAsByte< EMouseCursor::Type > Cursor Direct access to Cursor is deprecated. Please use the getter or setter.
Public variable EFlowDirectionPreference FlowDirectionPreference Direct access to FlowDirectionPreference is deprecated. Please use the getter or setter.
Public variable float RenderOpacity Direct access to RenderOpacity is deprecated. Please use the getter or setter.
Public variable FWidgetTransform RenderTransform Direct access to RenderTransform is deprecated. Please use the getter or setter.
Public variable FVector2D RenderTransformPivot Direct access to RenderTransformPivot is deprecated. Please use the getter or setter.
Public variable FText ToolTipText Direct access to ToolTipText is deprecated. Please use the getter or setter.
Public variable TObjectPtr< UWidget > ToolTipWidget Direct access to ToolTipWidget is deprecated. Please use the getter or setter.
Public variable ESlateVisibility Visibility Direct access to Visibility is deprecated. Please use the getter or setter.

Deprecated Functions

  Type Name Description
Public function void

SetNavigationRule ( EUINavigation Direction,
EUINavigationRule Rule,
FName WidgetToFocus
)

 SetNavigationRule is deprecated. Please use either SetNavigationRuleBase or SetNavigationRuleExplicit or SetNavigationRuleCustom or SetNavigationRuleCustomBoundary.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page