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

Public Member Functions
Appearance
bool	IsInViewport () const
FieldNotify
void	RemoveFieldValueChangedDelegate (FFieldNotificationId FieldId, FFieldValueChangedDynamicDelegate Delegate=FFieldValueChangedDynamicDelegate())
void	BroadcastFieldValueChanged (FFieldNotificationId FieldId)
void	AddFieldValueChangedDelegate (FFieldNotificationId FieldId, FFieldValueChangedDynamicDelegate Delegate=FFieldValueChangedDynamicDelegate())
Functions
void	SetbOverride_Cursor (bool Value)
void	SetToolTipWidget (UWidget Widget)
	Tooltip widget to show when the user hovers over the widget with the mouse.
bool	GetbIsEnabled () const
	Sets whether this widget can be modified interactively by the user.
void	SetbIsEnabled (bool bInIsEnabled)
	Sets whether this widget can be modified interactively by the user.
const FWidgetTransform &	GetRenderTransform ()
const FText &	GetToolTipText () const
	Tooltip text to show when the user hovers over the widget with the mouse.
UWidget	GetToolTipWidget () const
	Tooltip widget to show when the user hovers over the widget with the mouse.
const FVector2D &	GetRenderTransformPivot () const
	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.
void	GetChildWidgets (TArray< UWidget > &OutChildWidgets) const
void	SetbOverrideAccessibleDefaults (bool Value)
	Override all of the default accessibility behavior and text for this widget.
void	SetbCanChildrenBeAccessible (bool Value)
	Whether or not children of this widget can appear as distinct accessible widgets.
void	SetAccessibleText (FText Value)
	When AccessibleBehavior is set to Custom, this is the text that will be used to describe the widget.
void	SetAccessibleSummaryText (FText Value)
	When AccessibleSummaryBehavior is set to Custom, this is the text that will be used to describe the widget.
bool	GetbIsVolatile () const
	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.
void	SetbIsVolatile (bool Value)
	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.
const EMouseCursor &	GetCursor () const
	The cursor to show when the mouse is over the widget.
Public Member Functions inherited from UObject
bool	MarkPackageDirty () const
void	RemoveFromRoot ()
bool	GetIsRooted () const
bool	IsTransient () const
bool	Modify (bool bAlwaysMarkDirty=true)
void	SetTransactional (bool bTransactional)
bool	IsSupportedForNetworking () const
UClass	GetClass () const
UObject	GetOuter () const
UObject	GetTypedOuter (TSubclassOf< UObject > Target) const
	Traverses the outer chain searching for the next object of a certain type.
UPackage	GetOutermost () const
UPackage	GetPackage () const
void	AddToRoot ()
UWorld	GetWorld () const
FName	GetName () const
FString	GetFullName (const UObject StopOuter=nullptr) const
FString	GetPathName (const UObject StopOuter=nullptr) const
bool	IsA (const UClass Class) const
	Returns true if this object is of the specified type, or a child of that type.
void	SaveConfig ()
void	LoadConfig ()
void	ReloadConfig ()
void	CopyScriptPropertiesFrom (const UObject OtherObject)
void	opCast (?&Address) const
FString	ToString () const

Static Public Member Functions
Static Functions
static UClass	StaticClass ()
Static Public Member Functions inherited from UVisual
static UClass	StaticClass ()
Static Public Member Functions inherited from UObject
static UClass	StaticClass ()

Public Attributes
Accessibility
FText	AccessibleSummaryText
	When AccessibleSummaryBehavior is set to Custom, this is the text that will be used to describe the widget.
FText	AccessibleText
	When AccessibleBehavior is set to Custom, this is the text that will be used to describe the widget.
ESlateAccessibleBehavior	AccessibleBehavior
	Whether or not the widget is accessible, and how to describe it. If set to custom, additional customization options will appear.
ESlateAccessibleBehavior	AccessibleSummaryBehavior
	How to describe this widget when it's being presented through a summary of a parent widget. If set to custom, additional customization options will appear.
Behavior
EMouseCursor	Cursor
	The cursor to show when the mouse is over the widget.
FText	ToolTipText
	Tooltip text to show when the user hovers over the widget with the mouse.
UWidget	ToolTipWidget
	Tooltip widget to show when the user hovers over the widget with the mouse.
bool	bIsEnabled
	Sets whether this widget can be modified interactively by the user.
ESlateVisibility	Visibility
	The visibility of the widget.
Layout
UPanelSlot	Slot
	The parent slot of the UWidget. Allows us to easily inline edit the layout controlling this widget.
Localization
EFlowDirectionPreference	FlowDirectionPreference
	Allows you to set a new flow direction.
Navigation
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. Those rules determine how navigation transitions can occur between widgets.
Performance
bool	bIsVolatile
	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.
Render Transform
FVector2D	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.
FWidgetTransform	RenderTransform
	The render transform of the widget allows for arbitrary 2D transforms to be applied to the widget.
Rendering
EWidgetPixelSnapping	PixelSnapping
	If the widget will draw snapped to the nearest pixel. Improves clarity but might cause visibile stepping in animation.
EWidgetClipping	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.
float32	RenderOpacity
	The opacity of the widget.
Public Attributes inherited from UObject
const UClass	Class
const UObject	Outer
const UPackage	Outermost
const UPackage	Package
const UWorld	World
const FName	Name
const bool	IsRooted

Widget
const FGeometry	CachedGeometry
	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.
const FGeometry	PaintSpaceGeometry
const UGameInstance	GameInstance
	Gets the game instance associated with this UI.
const UPanelWidget	Parent
	Gets the parent widget.
const FVector2D	DesiredSize
	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.
const FGeometry	TickSpaceGeometry
bool	IsEnabled
	Gets the current enabled status of the widget.
const ULocalPlayer	OwningLocalPlayer
	Gets the local player associated with this UI.
const APlayerController	OwningPlayer
	Gets the player controller associated with this UI.
const FGeometry &	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.
EWidgetClipping	GetClipping () const
	Gets the clipping state of this widget.
FVector2D	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.
FText	GetAccessibleText () const
	Gets the accessible text from the underlying Slate accessible widget.
FText	GetAccessibleSummaryText () const
	Gets the accessible summary text from the underlying Slate accessible widget.
UGameInstance	GetGameInstance () const
	Gets the game instance associated with this UI.
ULocalPlayer	GetOwningLocalPlayer () const
	Gets the local player associated with this UI.
APlayerController	GetOwningPlayer () const
	Gets the player controller associated with this UI.
const FGeometry &	GetPaintSpaceGeometry () const
UPanelWidget	GetParent () const
	Gets the parent widget.
float32	GetRenderOpacity () const
	Gets the current visibility of the widget.
bool	GetIsEnabled () const
	Gets the current enabled status of the widget.
void	ForceVolatile (bool bForce)
	Sets the forced volatility of the widget.
ESlateVisibility	GetVisibility () const
	Gets the current visibility of the widget.
bool	HasAnyUserFocus () const
	Returns true if this widget is focused by any user.
bool	HasFocusedDescendants () const
	Returns true if any descendant widget is focused by any user.
bool	HasKeyboardFocus () const
	Checks to see if this widget currently has the keyboard focus.
bool	HasMouseCapture () const
	Checks to see if this widget is the current mouse captor.
bool	HasMouseCaptureByUser (int UserIndex, int PointerIndex=- 1) const
	Checks to see if this widget is the current mouse captor.
bool	HasUserFocus (APlayerController PlayerController) const
	Returns true if this widget is focused by a specific user.
bool	HasUserFocusedDescendants (APlayerController PlayerController) const
	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. will force the owning widget to redraw and cache children on the next paint pass.
bool	IsHovered () const
	Returns true if the widget is currently being hovered by a pointer device.
void	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.
bool	IsRendered () const
	Returns true if the widget is Visible, HitTestInvisible or SelfHitTestInvisible and the Render Opacity is greater than 0.
bool	IsVisible () const
	Returns true if the widget is Visible, HitTestInvisible or SelfHitTestInvisible.
const FGeometry &	GetTickSpaceGeometry () const
void	SetClipping (EWidgetClipping InClipping)
	Sets the clipping state of this widget.
void	SetNavigationRuleCustom (EUINavigation Direction, FCustomWidgetNavigationDelegate InCustomDelegate=FCustomWidgetNavigationDelegate())
	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.
void	RemoveFromParent ()
	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.
void	ResetCursor ()
	Resets the cursor to use on the widget, removing any customization for it.
void	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.
void	SetVisibility (ESlateVisibility InVisibility)
	Sets the visibility of the widget.
void	SetCursor (EMouseCursor InCursor)
	Sets the cursor to show over 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	SetNavigationRule (EUINavigation Direction, EUINavigationRule Rule, FName WidgetToFocus)
void	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.
void	SetUserFocus (APlayerController PlayerController)
	Sets the focus to this widget for a specific user (if setting focus for the owning user, prefer SetFocus()).
void	SetNavigationRuleCustomBoundary (EUINavigation Direction, FCustomWidgetNavigationDelegate InCustomDelegate=FCustomWidgetNavigationDelegate())
	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.
void	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.
void	SetRenderOpacity (float32 InOpacity)
	Sets the visibility of the widget.
void	SetToolTip (UWidget Widget)
	Sets a custom widget as the tooltip of the widget.
void	SetToolTipText (FText InToolTipText)
	Sets the tooltip text for the widget.

Widget\|Transform
float32	RenderTransformAngle
void	SetRenderTransformAngle (float32 Angle)
void	SetRenderTransformPivot (FVector2D Pivot)
float32	GetRenderTransformAngle () const
void	SetRenderTransform (FWidgetTransform InTransform)
void	SetRenderShear (FVector2D Shear)
void	SetRenderScale (FVector2D Scale)
void	SetRenderTranslation (FVector2D Translation)

Detailed Description

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

Member Function Documentation

◆ AddFieldValueChangedDelegate()

void AddFieldValueChangedDelegate	(	FFieldNotificationId	FieldId,
		FFieldValueChangedDynamicDelegate	Delegate = FFieldValueChangedDynamicDelegate ( ) )

◆ BroadcastFieldValueChanged()

void BroadcastFieldValueChanged ( FFieldNotificationId FieldId )

◆ ForceLayoutPrepass()

void 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.

◆ ForceVolatile()

void ForceVolatile ( bool bForce )

Sets the forced volatility of the widget.

◆ GetAccessibleSummaryText()

FText 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.

◆ GetAccessibleText()

FText 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.

◆ GetbIsEnabled()

bool GetbIsEnabled ( ) const

Sets whether this widget can be modified interactively by the user.

◆ GetbIsVolatile()

bool GetbIsVolatile ( ) const

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.

◆ GetCachedGeometry()

const FGeometry & 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.

◆ GetChildWidgets()

void GetChildWidgets ( TArray< UWidget > & OutChildWidgets ) const

◆ GetClipping()

EWidgetClipping GetClipping ( ) const

Gets the clipping state of this widget.

◆ GetCursor()

const EMouseCursor & GetCursor ( ) const

The cursor to show when the mouse is over the widget.

◆ GetDesiredSize()

FVector2D 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

◆ GetGameInstance()

UGameInstance GetGameInstance ( ) const

Gets the game instance associated with this UI.

Returns: a pointer to the owning game instance

◆ GetIsEnabled()

bool GetIsEnabled ( ) const

Gets the current enabled status of the widget.

◆ GetOwningLocalPlayer()

ULocalPlayer GetOwningLocalPlayer ( ) const

Gets the local player associated with this UI.

Returns: The owning local player.

◆ GetOwningPlayer()

APlayerController GetOwningPlayer ( ) const

Gets the player controller associated with this UI.

Returns: The player controller that owns the UI.

◆ GetPaintSpaceGeometry()

const FGeometry & GetPaintSpaceGeometry ( ) const

◆ GetParent()

UPanelWidget GetParent ( ) const

Gets the parent widget.

◆ GetRenderOpacity()

float32 GetRenderOpacity ( ) const

Gets the current visibility of the widget.

◆ GetRenderTransform()

const FWidgetTransform & GetRenderTransform ( )

◆ GetRenderTransformAngle()

float32 GetRenderTransformAngle ( ) const

◆ GetRenderTransformPivot()

const FVector2D & GetRenderTransformPivot ( ) const

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.

◆ GetTickSpaceGeometry()

const FGeometry & GetTickSpaceGeometry ( ) const

◆ GetToolTipText()

const FText & GetToolTipText ( ) const

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

◆ GetToolTipWidget()

UWidget GetToolTipWidget ( ) const

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

◆ GetVisibility()

ESlateVisibility GetVisibility ( ) const

Gets the current visibility of the widget.

◆ HasAnyUserFocus()

bool HasAnyUserFocus ( ) const

Returns true if this widget is focused by any user.

◆ HasFocusedDescendants()

bool HasFocusedDescendants ( ) const

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

◆ HasKeyboardFocus()

bool HasKeyboardFocus ( ) const

Checks to see if this widget currently has the keyboard focus.

Returns: True if this widget has keyboard focus

◆ HasMouseCapture()

bool HasMouseCapture ( ) const

Checks to see if this widget is the current mouse captor.

Returns: True if this widget has captured the mouse

◆ HasMouseCaptureByUser()

bool HasMouseCaptureByUser	(	int	UserIndex,
		int	PointerIndex = - 1 ) const

Checks to see if this widget is the current mouse captor.

Returns: True if this widget has captured the mouse with given user and pointer

◆ HasUserFocus()

bool HasUserFocus ( APlayerController PlayerController ) const

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

◆ HasUserFocusedDescendants()

bool HasUserFocusedDescendants ( APlayerController PlayerController ) const

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

◆ InvalidateLayoutAndVolatility()

void 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.

◆ IsHovered()

bool IsHovered ( ) const

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

◆ IsInViewport()

bool IsInViewport ( ) const

Returns: true if the widget was added to the viewport using AddToViewport or AddToPlayerScreen.

◆ IsRendered()

bool IsRendered ( ) const

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

◆ IsVisible()

bool IsVisible ( ) const

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

◆ RemoveFieldValueChangedDelegate()

void RemoveFieldValueChangedDelegate	(	FFieldNotificationId	FieldId,
		FFieldValueChangedDynamicDelegate	Delegate = FFieldValueChangedDynamicDelegate ( ) )

◆ RemoveFromParent()

void RemoveFromParent ( )

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.

◆ ResetCursor()

void ResetCursor ( )

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

◆ SetAccessibleSummaryText()

void SetAccessibleSummaryText ( FText Value )

When AccessibleSummaryBehavior is set to Custom, this is the text that will be used to describe the widget.

◆ SetAccessibleText()

void SetAccessibleText ( FText Value )

When AccessibleBehavior is set to Custom, this is the text that will be used to describe the widget.

◆ SetAllNavigationRules()

void 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

Rule	The rule to use when navigation is taking place
WidgetToFocus	When using the Explicit rule, focus on this widget

◆ SetbCanChildrenBeAccessible()

void SetbCanChildrenBeAccessible ( bool Value )

Whether or not children of this widget can appear as distinct accessible widgets.

◆ SetbIsEnabled()

void SetbIsEnabled ( bool bInIsEnabled )

Sets whether this widget can be modified interactively by the user.

◆ SetbIsVolatile()

void SetbIsVolatile ( bool Value )

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.

◆ SetbOverride_Cursor()

void SetbOverride_Cursor ( bool Value )

◆ SetbOverrideAccessibleDefaults()

void SetbOverrideAccessibleDefaults ( bool Value )

Override all of the default accessibility behavior and text for this widget.

◆ SetClipping()

void SetClipping ( EWidgetClipping InClipping )

Sets the clipping state of this widget.

◆ SetCursor()

void SetCursor ( EMouseCursor InCursor )

Sets the cursor to show over the widget.

◆ SetFocus()

void SetFocus ( )

Sets the focus to this widget for the owning user.

◆ SetIsEnabled()

void SetIsEnabled ( bool bInIsEnabled )

Sets the current enabled status of the widget.

◆ SetKeyboardFocus()

void SetKeyboardFocus ( )

Sets the focus to this widget.

◆ SetNavigationRule()

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

◆ SetNavigationRuleBase()

void 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

Rule	The rule to use when navigation is taking place

◆ SetNavigationRuleCustom()

void SetNavigationRuleCustom	(	EUINavigation	Direction,
		FCustomWidgetNavigationDelegate	InCustomDelegate = FCustomWidgetNavigationDelegate ( ) )

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

InCustomDelegate Custom Delegate that will be called

◆ SetNavigationRuleCustomBoundary()

void SetNavigationRuleCustomBoundary	(	EUINavigation	Direction,
		FCustomWidgetNavigationDelegate	InCustomDelegate = FCustomWidgetNavigationDelegate ( ) )

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

InCustomDelegate Custom Delegate that will be called

◆ SetNavigationRuleExplicit()

void 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

InWidget Focus on this widget instance

◆ SetRenderOpacity()

void SetRenderOpacity ( float32 InOpacity )

Sets the visibility of the widget.

◆ SetRenderScale()

void SetRenderScale ( FVector2D Scale )

◆ SetRenderShear()

void SetRenderShear ( FVector2D Shear )

◆ SetRenderTransform()

void SetRenderTransform ( FWidgetTransform InTransform )

◆ SetRenderTransformAngle()

void SetRenderTransformAngle ( float32 Angle )

◆ SetRenderTransformPivot()

void SetRenderTransformPivot ( FVector2D Pivot )

◆ SetRenderTranslation()

void SetRenderTranslation ( FVector2D Translation )

◆ SetToolTip()

void SetToolTip ( UWidget Widget )

Sets a custom widget as the tooltip of the widget.

◆ SetToolTipText()

void SetToolTipText ( FText InToolTipText )

Sets the tooltip text for the widget.

◆ SetToolTipWidget()

void SetToolTipWidget ( UWidget Widget )

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

◆ SetUserFocus()

void SetUserFocus ( APlayerController PlayerController )

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

◆ SetVisibility()

void SetVisibility ( ESlateVisibility InVisibility )

Sets the visibility of the widget.

◆ StaticClass()

UClass StaticClass ( )

static

Member Data Documentation

◆ AccessibleBehavior

ESlateAccessibleBehavior AccessibleBehavior

Whether or not the widget is accessible, and how to describe it. If set to custom, additional customization options will appear.

◆ AccessibleSummaryBehavior

ESlateAccessibleBehavior AccessibleSummaryBehavior

How to describe this widget when it's being presented through a summary of a parent widget. If set to custom, additional customization options will appear.

◆ AccessibleSummaryText

FText AccessibleSummaryText

When AccessibleSummaryBehavior is set to Custom, this is the text that will be used to describe the widget.

◆ AccessibleText

FText AccessibleText

When AccessibleBehavior is set to Custom, this is the text that will be used to describe the widget.

◆ bIsEnabled

bool bIsEnabled

Sets whether this widget can be modified interactively by the user.

◆ bIsVolatile

bool bIsVolatile

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.

◆ CachedGeometry

const FGeometry CachedGeometry

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.

◆ Clipping

EWidgetClipping 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.

◆ Cursor

EMouseCursor Cursor

The cursor to show when the mouse is over the widget.

◆ DesiredSize

const FVector2D DesiredSize

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.

◆ FlowDirectionPreference

EFlowDirectionPreference FlowDirectionPreference

Allows you to set a new flow direction.

◆ GameInstance

const UGameInstance GameInstance

Gets the game instance associated with this UI.

◆ IsEnabled

bool IsEnabled

Gets the current enabled status of the widget.

◆ Navigation

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. Those rules determine how navigation transitions can occur between widgets.

◆ OwningLocalPlayer

const ULocalPlayer OwningLocalPlayer

Gets the local player associated with this UI.

◆ OwningPlayer

const APlayerController OwningPlayer

Gets the player controller associated with this UI.

◆ PaintSpaceGeometry

const FGeometry PaintSpaceGeometry

◆ Parent

const UPanelWidget Parent

Gets the parent widget.

◆ PixelSnapping

EWidgetPixelSnapping PixelSnapping

If the widget will draw snapped to the nearest pixel. Improves clarity but might cause visibile stepping in animation.

◆ RenderOpacity

float32 RenderOpacity

The opacity of the widget.

◆ RenderTransform

FWidgetTransform RenderTransform

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

◆ RenderTransformAngle

float32 RenderTransformAngle

◆ RenderTransformPivot

FVector2D 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.

◆ Slot

UPanelSlot Slot

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

◆ TickSpaceGeometry

const FGeometry TickSpaceGeometry

◆ ToolTipText

FText ToolTipText

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

◆ ToolTipWidget

UWidget ToolTipWidget

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

◆ Visibility

ESlateVisibility Visibility

The visibility of the widget.

Public Member Functions

Static Public Member Functions

Public Attributes

Widget

Widget|Transform

Detailed Description

Member Function Documentation

◆ AddFieldValueChangedDelegate()

◆ BroadcastFieldValueChanged()

◆ ForceLayoutPrepass()

◆ ForceVolatile()

◆ GetAccessibleSummaryText()

◆ GetAccessibleText()

◆ GetbIsEnabled()

◆ GetbIsVolatile()

◆ GetCachedGeometry()

◆ GetChildWidgets()

◆ GetClipping()

◆ GetCursor()

◆ GetDesiredSize()

◆ GetGameInstance()

◆ GetIsEnabled()

◆ GetOwningLocalPlayer()

◆ GetOwningPlayer()

◆ GetPaintSpaceGeometry()

◆ GetParent()

◆ GetRenderOpacity()

◆ GetRenderTransform()

◆ GetRenderTransformAngle()

◆ GetRenderTransformPivot()

◆ GetTickSpaceGeometry()

◆ GetToolTipText()

◆ GetToolTipWidget()

◆ GetVisibility()

◆ HasAnyUserFocus()

◆ HasFocusedDescendants()

◆ HasKeyboardFocus()

◆ HasMouseCapture()

◆ HasMouseCaptureByUser()

◆ HasUserFocus()

◆ HasUserFocusedDescendants()

◆ InvalidateLayoutAndVolatility()

◆ IsHovered()

◆ IsInViewport()

◆ IsRendered()

◆ IsVisible()

◆ RemoveFieldValueChangedDelegate()

◆ RemoveFromParent()

◆ ResetCursor()

◆ SetAccessibleSummaryText()

◆ SetAccessibleText()

◆ SetAllNavigationRules()

◆ SetbCanChildrenBeAccessible()

◆ SetbIsEnabled()

◆ SetbIsVolatile()

◆ SetbOverride_Cursor()

◆ SetbOverrideAccessibleDefaults()

◆ SetClipping()

◆ SetCursor()

◆ SetFocus()

◆ SetIsEnabled()

◆ SetKeyboardFocus()

◆ SetNavigationRule()

◆ SetNavigationRuleBase()

◆ SetNavigationRuleCustom()

◆ SetNavigationRuleCustomBoundary()

◆ SetNavigationRuleExplicit()

◆ SetRenderOpacity()

◆ SetRenderScale()

◆ SetRenderShear()

◆ SetRenderTransform()

◆ SetRenderTransformAngle()

◆ SetRenderTransformPivot()

◆ SetRenderTranslation()

◆ SetToolTip()

◆ SetToolTipText()

◆ SetToolTipWidget()

◆ SetUserFocus()

◆ SetVisibility()

◆ StaticClass()