Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > UMG > Components > UWidget

Light Theme

Dark Theme

UWidget

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

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UVisual

UWidget

UAudioMeter

UAudioRadialSlider

	UAudioFrequencyRadialSlider
	UAudioVolumeRadialSlider

UAudioSliderBase

UAudioFrequencySlider

UAudioSlider

UAudioVolumeSlider

UCircularThrobber

UComboBox

UComboBoxKey

UComboBoxString

UCommonActionWidget

UCommonActivatableWidgetContainerBase

	UCommonActivatableWidgetQueue
	UCommonActivatableWidgetStack

UCommonLazyWidget

UCommonVideoPlayer

UCommonWidgetCarouselNavBar

UDynamicEntryBoxBase

	UCommonBoundActionBar
	UDynamicEntryBox

UEditableText

UEditableTextBox

UExpandableArea

UImage

UCommonLazyImage

UInputKeySelector

UListViewBase

UListView

UCommonListView

UTileView

UCommonTileView

UTreeView

UCommonTreeView

UNativeWidgetHost

UObjectMixerEditorUWidget

UPanelWidget

UProgressBar

UPropertyViewBase

	UDetailsView
	USinglePropertyView

URadialSlider

UScrollBar

USlider

UAnalogSlider

USpacer

USpinBox

USynth2DSlider

USynthKnob

UTextLayoutWidget

UMultiLineEditableText

UMultiLineEditableTextBox

URichTextBlock

UCommonRichTextBlock

UTextBlock

UCommonTextBlock

	UCommonDateTimeTextBlock
	UCommonNumericTextBlock

UThrobber

UUserWidget

UWebBrowser

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

	Name	Description
ESlateAccessibl...	AccessibleBehavior	Whether or not the widget is accessible, and how to describe it.
ESlateAccessibl...	AccessibleSummaryBehavior	How to describe this widget when it's being presented through a summary of a parent widget.
FText	AccessibleSummaryText	When AccessibleSummaryBehavior is set to Custom, this is the text that will be used to describe the widget.
USlateAccessibl...	AccessibleSummaryTextDelegate	An optional delegate that may be assigned in place of AccessibleSummaryText for creating a TAttribute
FText	AccessibleText	When AccessibleBehavior is set to Custom, this is the text that will be used to describe the widget.
USlateAccessibl...	AccessibleTextDelegate	An optional delegate that may be assigned in place of AccessibleText for creating a TAttribute
uint8: 1	bCanChildrenBeAccessible	Whether or not children of this widget can appear as distinct accessible widgets.
uint8: 1	bCreatedByConstructionScript	Flag if the Widget was created from a blueprint
uint8: 1	bExpandedInDesigner	Stores the design time flag setting if the widget is expanded inside the designer
uint8: 1	bHiddenInDesigner	Stores the design time flag setting if the widget is hidden inside the designer
FGetBool	bIsEnabledDelegate	A bindable delegate for bIsEnabled
uint8: 1	bIsManagedByGameViewportSubsystem	Cached value that indicate if the widget was added to the GameViewportSubsystem.
uint8: 1	bIsVariable	Allows controls to be exposed as variables in a blueprint.
uint8: 1	bIsVolatile	If true prevents the widget or its child's geometry or layout information from being cached.
uint8: 1	bLockedInDesigner	Stores the design time flag setting if the widget is locked inside the designer
uint8: 1	bOverride_Cursor
uint8: 1	bOverrideAccessibleDefaults	These editor-only properties exist for two reasons:
TWeakPtr< SObje...	MyGCWidget	The underlying SWidget contained in a SObjectWidget
TWeakPtr< SWidg...	MyWidget	The underlying SWidget.
TArray< TObject...	NativeBindings	Native property bindings.
TObjectPtr< cla...	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.
TObjectPtr< UPa...	Slot	The parent slot of the UWidget.
FGetText	ToolTipTextDelegate	A bindable delegate for ToolTipText
FGetWidget	ToolTipWidgetDelegate	A bindable delegate for ToolTipWidget
friend	UGameViewportSubsystem
FGetSlateVisibi...	VisibilityDelegate	A bindable delegate for Visibility
TWeakObjectPtr<...	WidgetGeneratedBy	Stores a reference to the asset responsible for this widgets construction.
TWeakObjectPtr<...	WidgetGeneratedByClass	Stores a reference to the class responsible for this widgets construction.

Constructors

	Name	Description
	UWidget ( const FObjectInitializer& ObjectIn... )

Functions

	Name	Description
bool	AddBinding ( FDelegateProperty* DelegatePro..., UObject* SourceObject, const FDynamicPropertyPath& Bindin... )
void	BroadcastFieldValueChanged ( UE::FieldNotification::FFieldId InF... )
void	BuildNavigation()	Called by the owning user widget after the slate widget has been created.
bool	CanSafelyRouteCall()
bool	CanSafelyRouteEvent()
bool	CanSafelyRoutePaint()
void	ConnectEditorData()	Allows general fixups and connections only used at editor time.
TOptional< f...	ConvertFloatToOptionalFloat ( TAttribute< float > InFloat )
FSlateColor	ConvertLinearColorToSlateColor ( TAttribute< FLinearColor > InLinear... )
ESlateVisibi...	ConvertRuntimeToSerializedVisibility ( const EVisibility& Input )
FSizeParam	ConvertSerializedSizeParamToRuntime ( const FSlateChildSize& Input )
EVisibility	ConvertSerializedVisibilityToRuntime ( ESlateVisibility Input )	End Designer contextual events.
EVisibility	ConvertVisibility ( TAttribute< ESlateVisibility > Seri... )	TODO UMG Consider moving conversion functions into another class. Conversion functions
TSharedRef< ...	CreateDesignerOutline ( TSharedRef< SWidget > Content )
void	CreatedFromPalette()	Called by the palette after constructing a new widget.
void	DeselectByDesigner()
TSubclassOf<...	FindBinderClassForDestination ( FProperty* Property )
UWidget *...	FindChildContainingDescendant ( UWidget* Root, UWidget* Descendant )
void	ForceLayoutPrepass()	Forces a pre-pass.
void	ForceVolatile ( bool bForce )	Sets the forced volatility of the widget.
FText	GetAccessibleSummaryText()	Gets the accessible summary text from the underlying Slate accessible widget.
FText	GetAccessibleText()	Gets the accessible text from the underlying Slate accessible widget
TSharedPtr< ...	GetAccessibleWidget()	Gets the widget that accessibility properties should synchronize to.
const FGeome...	GetCachedGeometry()	Gets the last geometry used to Tick the widget.
TSharedPtr< ...	GetCachedWidget()	Gets the last created widget does not recreate the gc container for the widget if one is needed.
const FStrin...	GetCategoryName()	Returns the category name of the widget
EWidgetClipp...	GetClipping()	Gets the clipping state of this widget.
EMouseCursor...	GetCursor()	Sets the cursor to show over the widget.
FString	GetDefaultFontName()
EWidgetDesig...	GetDesignerFlags()	Gets the designer flags currently set on the widget.
FVector2D	GetDesiredSize()	Gets the widgets desired size.
const FStrin...	GetDisplayLabel()	Returns the friendly name of the widget to display in the editor
FText	GetDisplayNameBase()	Gets the base name used to generate the display label/name of this widget.
EFlowDirecti...	GetFlowDirectionPreference()	Gets the flow direction preference of the widget
UGameInstanc...	GetGameInstance()	Gets the game instance associated with this UI.
TGameInstanc...	GetGameInstance()	Gets the game instance associated with this UI.
bool	GetIsEnabled()	Gets the current enabled status of the widget
FString	GetLabelMetadata()	Get Label Metadata, which may be as simple as a bit of string data to help identify an anonymous text block.
FText	GetLabelText()	Gets the label to display to the user for this widget.
FText	GetLabelTextWithMetadata()	Gets the label to display to the user for this widget, including any extra metadata like the text string for text.
T *	GetOwningLocalPlayer()	Gets the local player associated with this UI cast to the template type.
ULocalPlayer...	GetOwningLocalPlayer()	Gets the local player associated with this UI.
TPlayerContr...	GetOwningPlayer()	Gets the player controller associated with this UI cast to the template type.
APlayerContr...	GetOwningPlayer()	Gets the player controller associated with this UI.
const FGeome...	GetPaintSpaceGeometry()
const FText	GetPaletteCategory()	Gets the palette category of the widget
UPanelWidget...	GetParent()	Gets the parent widget
float	GetRenderOpacity()	Gets the current visibility of the widget.
const FWidge...	GetRenderTransform()
float	GetRenderTransformAngle()
FVector2D	GetRenderTransformPivot()
UObject *...	GetSourceAssetOrClass()
const FGeome...	GetTickSpaceGeometry()
UWidget *...	GetToolTip()
FText	GetToolTipText()
ESlateVisibi...	GetVisibility()	Gets the current visibility of the widget.
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.
UWorld *	GetWorld()
bool	HasAnyDesignerFlags ( EWidgetDesignFlags FlagsToCheck )	Tests if any of the flags exist on this widget.
bool	HasAnyUserFocus()	Returns true if this widget is focused by any user.
bool	HasFocusedDescendants()	Returns true if any descendant widget is focused by any user.
bool	HasKeyboardFocus()	Checks to see if this widget currently has the keyboard focus
bool	HasMouseCapture()	Checks to see if this widget is the current mouse captor
bool	HasMouseCaptureByUser ( int32 UserIndex, int32 PointerIndex )	Checks to see if this widget is the current mouse captor
bool	HasUserFocus ( APlayerController* PlayerContr... )	Returns true if this widget is focused by a specific user.
bool	HasUserFocusedDescendants ( APlayerController* PlayerContr... )	Returns true if any descendant widget is focused by a specific user.
void	InvalidateLayoutAndVolatility()	Invalidates the widget from the view of a layout caching widget that may own this widget.
bool	IsChildOf ( UWidget* PossibleParent )	Recurses up the list of parents and returns true if this widget is a descendant of the PossibleParent
bool	IsConstructed()	Gets the last created widget does not recreate the gc container for the widget if one is needed.
bool	IsDesignTime()	Returns if the widget is currently being displayed in the designer, it may want to display different data.
bool	IsEditorWidget()
bool	IsGeneratedName()	Is the label generated or provided by the user?
bool	IsHovered()	Returns true if the widget is currently being hovered by a pointer device
bool	IsInViewport()
bool	IsLockedInDesigner()	Is this widget locked in the designer UI
bool	IsPreviewTime()
bool	IsRendered()	Returns true if the widget is Visible, HitTestInvisible or SelfHitTestInvisible and the Render Opacity is greater than 0.
bool	IsVisible()	Returns true if the widget is Visible, HitTestInvisible or SelfHitTestInvisible.
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.
void	K2_AddFieldValueChangedDelegate ( FFieldNotificationId FieldId, FFieldValueChangedDynamicDelegate D... )
void	K2_BroadcastFieldValueChanged ( FFieldNotificationId FieldId )
void	K2_RemoveFieldValueChangedDelegate ( FFieldNotificationId FieldId, FFieldValueChangedDynamicDelegate D... )
void	OnBeginEditByDesigner()
void	OnBindingChanged ( const FName& Property )
void	OnCreationFromPalette()	Called after constructing a new widget from the palette.
void	OnDescendantDeselectedByDesigner ( UWidget* DescendantWidget )
void	OnDescendantSelectedByDesigner ( UWidget* DescendantWidget )
void	OnDeselectedByDesigner()
void	OnDesignerChanged ( const FDesignerChangedEventArgs& E... )
void	OnEndEditByDesigner()
void	OnSelectedByDesigner()
void	OnWidgetRebuilt()	Function called after the underlying SWidget is constructed.
TSharedRef< ...	RebuildDesignWidget ( TSharedRef< SWidget > Content )
TSharedRef< ...	RebuildWidget()	Function implemented by all subclasses of UWidget is called when the underlying SWidget needs to be constructed.
void	RemoveFromParent()	Removes the widget from its parent widget.
void	ResetCursor()	Resets the cursor to use on the widget, removing any customization for it.
void	SelectByDesigner()	Begin Designer contextual events.
void	SetAllNavigationRules ( EUINavigationRule Rule, FName WidgetToFocus )	Sets the widget navigation rules for all directions.
void	SetCategoryName ( const FString& InValue )	Sets the category name of the widget
void	SetClipping ( EWidgetClipping InClipping )	Sets the clipping state of this widget.
void	SetCursor ( EMouseCursor::Type InCursor )	Sets the cursor to show over the widget.
void	SetDesignerFlags ( EWidgetDesignFlags NewFlags )	Sets the designer flags on the widget.
void	SetDisplayLabel ( const FString& DisplayLabel )	Sets the friendly name of the widget to display in the editor
void	SetFlowDirectionPreference ( EFlowDirectionPreference FlowDirect... )	Sets the flow direction preference of the widget
void	SetFocus()	Sets the focus to this widget for the owning user
void	SetIsEnabled ( bool bInIsEnabled )	Sets the current enabled status of the widget
void	SetKeyboardFocus()	Sets the focus to this widget.
void	SetLockedInDesigner ( bool NewLockedInDesigner )
void	SetNavigationRuleBase ( EUINavigation Direction, EUINavigationRule Rule )	Sets the widget navigation rules for a specific direction.
void	SetNavigationRuleCustom ( EUINavigation Direction, FCustomWidgetNavigationDelegate InC... )	Sets the widget navigation rules for a specific direction.
void	SetNavigationRuleCustomBoundary ( EUINavigation Direction, FCustomWidgetNavigationDelegate InC... )	Sets the widget navigation rules for a specific direction.
void	SetNavigationRuleExplicit ( EUINavigation Direction, UWidget* InWidget )	Sets the widget navigation rules for a specific direction.
void	SetNavigationRuleInternal ( EUINavigation Direction, EUINavigationRule Rule, FName WidgetToFocus, UWidget* InWidget, FCustomWidgetNavigationDelegate InC... )
void	SetRenderOpacity ( float InOpacity )	Sets the visibility of the widget.
void	SetRenderScale ( FVector2D Scale )
void	SetRenderShear ( FVector2D Shear )
void	SetRenderTransform ( FWidgetTransform InTransform )
void	SetRenderTransformAngle ( float Angle )
void	SetRenderTransformPivot ( FVector2D Pivot )
void	SetRenderTranslation ( FVector2D Translation )
void	SetToolTip ( UWidget* Widget )	Sets a custom widget as the tooltip of the widget.
void	SetToolTipText ( const FText& InToolTipText )	Sets the tooltip text for the widget.
void	SetUserFocus ( APlayerController* PlayerContr... )	Sets the focus to this widget for a specific user (if setting focus for the owning user, prefer SetFocus())
void	SetVisibility ( ESlateVisibility InVisibility )	Sets the visibility of the widget.
void	SetVisibilityInternal ( ESlateVisibility InVisibility )
void	SynchronizeAccessibleData()	Copy all accessible properties to the AccessibleWidgetData object
void	SynchronizeProperties()	Applies all properties to the native widget if possible.
TSharedRef< ...	TakeDerivedWidget ( ConstructMethodType ConstructMethod )
TSharedRef< ...	TakeWidget()	Gets the underlying slate widget or constructs it if it doesn't exist.
void	UpdateRenderTransform()
void	ValidateCompiledDefaults ( IWidgetCompilerLog& CompileLog )	Called at the end of Widget Blueprint compilation.

Overridden from UObject

	Name	Description
void	BeginDestroy()	Called before destroying the object.
void	FinishDestroy()	Called to finish destroying the object.
bool	Modify ( bool bAlwaysMarkDirty )	Mark this object as modified, also mark the slot as modified.
void	PostEditChangeProperty ( FPropertyChangedEvent& PropertyCha... )	Called when a property on this object has been modified externally
void	PreSave ( FObjectPreSaveContext SaveContext )	Presave function.

Overridden from INotifyFieldValueChanged

	Name	Description
FDelegateHan...	AddFieldValueChangedDelegate ( UE::FieldNotification::FFieldId InF..., FFieldValueChangedDelegate InNewDel... )	Add a delegate that will be notified when the FieldId is value changed.
const ::UE::...	GetFieldNotificationDescriptor()
int32	RemoveAllFieldValueChangedDelegates ( const void* InUserObject )	Remove all the delegate that are bound to the specified UserObject.
int32	RemoveAllFieldValueChangedDelegates ( UE::FieldNotification::FFieldId InF..., const void* InUserObject )	Remove all the delegate that are bound to the specified Field and UserObject.
bool	RemoveFieldValueChangedDelegate ( UE::FieldNotification::FFieldId InF..., FDelegateHandle InHandle )	Remove a delegate that was added.

Classes

	Name	Description
	FFieldNotificationClassDescriptor
	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	Description
ConstructMethodType

Constants

Name	Description
BinderClasses

Deprecated Variables

	Name	Description
uint8: 1	bIsEnabled	Direct access to bIsEnabled is deprecated. Please use the getter or setter.
EWidgetClipping	Clipping	Direct access to Clipping is deprecated. Please use the getter or setter.
TEnumAsByte< EM...	Cursor	Direct access to Cursor is deprecated. Please use the getter or setter.
EFlowDirectionP...	FlowDirectionPreference	Direct access to FlowDirectionPreference is deprecated. Please use the getter or setter.
float	RenderOpacity	Direct access to RenderOpacity is deprecated. Please use the getter or setter.
FWidgetTransfor...	RenderTransform	Direct access to RenderTransform is deprecated. Please use the getter or setter.
FVector2D	RenderTransformPivot	Direct access to RenderTransformPivot is deprecated. Please use the getter or setter.
FText	ToolTipText	Direct access to ToolTipText is deprecated. Please use the getter or setter.
TObjectPtr< UWi...	ToolTipWidget	Direct access to ToolTipWidget is deprecated. Please use the getter or setter.
ESlateVisibilit...	Visibility	Direct access to Visibility is deprecated. Please use the getter or setter.

Deprecated Functions

		Name	Description
	void	SetNavigationRule ( EUINavigation Direction, EUINavigationRule Rule, FName WidgetToFocus )	SetNavigationRule is deprecated. Please use either SetNavigationRuleBase or SetNavigationRuleExplicit or SetNavigationRuleCustom or SetNavigationRuleCustomBoundary.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Cancel