FSlateApplicationBase

Base class for Slate applications.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

FSlateApplicationBase

FSlateApplication

References

Module	SlateCore
Header	/Engine/Source/Runtime/SlateCore/Public/Application/SlateApplicationBase.h
Include	#include "Application/SlateApplicationBase.h"

Syntax

class FSlateApplicationBase

Remarks

Base class for Slate applications.

This class currently serves a temporary workaround for solving SlateCore dependencies to FSlateApplication. It should probably be removed once FSlateApplication has been refactored into SlateCore.

Variables

	Name	Description
TSharedRef< FSl...	AccessibleMessageHandler	Manager for widgets and application to interact with accessibility API
FCriticalSectio...	ActiveTimerCS	Critical section for active timer registration as it can be called from the movie thread and the game thread
bool	bIsSlateAsleep	Gets set when Slate goes to sleep and cleared when active.
float	CachedDebugTitleSafeRatio	Caches the previous debug safe zone ratio.
FDisplayMetrics	CachedDisplayMetrics	Caches the application's display metrics.
FMargin	CustomSafeZoneRatio	Safe Zone ratio to override platform settings
ECustomSafeZone...	CustomSafeZoneState	If Safe Zone ratio has been manually set, unset, or set via debug
FHitTesting	HitTesting	Private interface for select entities that are allowed to perform hittesting.
FOnDebugSafeZon...	OnDebugSafeZoneChanged
FOnGlobalInvali...	OnGlobalInvalidationToggledEvent
FOnInvalidateAl...	OnInvalidateAllWidgetsEvent	Multicast delegate to broadcast when a global invalidate is requested
TSharedPtr< FSl...	Renderer	Holds the Slate renderer used to render this application.

Constructors

	Name	Description
	FSlateApplicationBase()

Destructors

	Name	Description
	~FSlateApplicationBase()

Functions

	Name	Description
TSharedRef< ...	AddWindow ( TSharedRef< SWindow > InSlateWindow, const bool bShowImmediately )	Associates a top level Slate Window with a native window and ensures that it is tracked properly by the application.
bool	AnyActiveTimersArePending()	Used to determine if any active timer handles are ready to fire.
bool	AnyMenusVisible()
void	ArrangeWindowToFrontVirtual ( TArray< TSharedRef< SWindow >>& Wi..., const TSharedRef< SWindow >& Windo... )	Reorders an array of windows so the specified window is "brought to the front"
FVector2D	CalculateTooltipWindowPosition ( const FSlateRect& InAnchorRect, const FVector2D& InSize, bool bAutoAdjustForDPIScale )	Calculates the tooltip window position.
bool	DoesWidgetHaveMouseCapture ( const TSharedPtr< const SWidget > W... )	Gets whether or not a particular widget has mouse capture.
bool	DoesWidgetHaveMouseCaptureByUser ( const TSharedPtr< const SWidget > W..., int32 UserIndex, TOptional< int32 > PointerIndex )	Gets whether or not a particular widget has mouse capture by a user.
bool	FindPathToWidget ( TSharedRef< const SWidget > InWidge..., FWidgetPath& OutWidgetPath, EVisibility VisibilityFilter )	Searches for the specified widget and generates a full path to it.
TSharedPtr< ...	FindWidgetWindow ( TSharedRef< const SWidget > InWidge... )	Returns the window the provided widget is contained in
FSlateApplic...	Get()	Returns the current instance of the application.
TSharedRef< ...	GetAccessibleMessageHandler()	Accessor for the accessible message handler. One must always exist, even if it's never activated.
TSharedPtr< ...	GetActiveTopLevelRegularWindow()	Gets the active regular top-level window.
TSharedPtr< ...	GetActiveTopLevelWindow()	Gets the active top-level window.
const FSlate...	GetAppIcon()	Gets the global application icon.
const FSlate...	GetAppIconSmall()
float	GetApplicationScale()	Gets the ratio SlateUnit / ScreenPixel.
void	GetCachedDisplayMetrics ( FDisplayMetrics& OutDisplayMetrics )	Gets the application's cached display metrics.
const double	GetCurrentTime()	Gets Slate's current cached real time.
FVector2D	GetCursorPos()	Gets the current position of the cursor.
FVector2D	GetCursorSize()	Gets the size of the cursor..
const FMargi...	GetCustomSafeZone()
void	GetDisplayMetrics ( FDisplayMetrics& OutDisplayMetrics )	Gets the application's display metrics.
const FHitTe...	GetHitTesting()
TSharedPtr< ...	GetKeyboardFocusedWidget()	Gets the widget that currently has keyboard focus, if any.
FVector2D	GetLastCursorPos()	Gets the last known position of the cursor.
TSharedPtr< ...	GetMouseCaptorImpl()	Implementation of GetMouseCaptor which can be overridden without warnings.
EUINavigatio...	GetNavigationActionForKey ( const FKey& InKey )
EUINavigatio...	GetNavigationActionFromKey ( const FKeyEvent& InKeyEvent )
EUINavigatio...	GetNavigationDirectionFromAnalog ( const FAnalogInputEvent& InAnalogE... )
EUINavigatio...	GetNavigationDirectionFromKey ( const FKeyEvent& InKeyEvent )
TSharedPtr< ...	GetPlatformApplication()
const TShare...	GetPlatformApplication()	Gets the platform application.
TSharedPtr< ...	GetPlatformCursor()
FSlateRect	GetPreferredWorkArea()	Gets the rectangle of the current preferred work area.
FSlateRender...	GetRenderer()	Gets the renderer being used to draw this application.
void	GetSafeZoneRatio ( FMargin& SafeZoneRatio )
void	GetSafeZoneSize ( FMargin& SafeZone, const FVector2D& OverrideSize )
bool	GetSoftwareCursorAvailable()	Whether the software cursor is enabled for this application.
EVisibility	GetSoftwareCursorVis()	Gets the desired visibility of the software cursor
const TArray...	GetTopLevelWindows()	Get a list of all top-level windows in the application, excluding virtual windows.
TSharedPtr< ...	GetUserFocusedWidget ( uint32 UserIndex )
EWindowTrans...	GetWindowTransparencySupport()	Get the highest level of window transparency support currently enabled by this application
bool	HasAnyMouseCaptor()	Gets whether or not a widget has captured the mouse.
TOptional< E...	HasAnyUserFocus ( const TSharedPtr< const SWidget > W... )	Gets whether or not a particular widget has any users focus, and if so the type of focus (first one found).
bool	HasFocusedDescendants ( const TSharedRef< const SWidget >&... )	Checks whether the specified widget has any descendants which are currently focused.
TOptional< E...	HasUserFocus ( const TSharedPtr< const SWidget > W..., int32 UserIndex )	Gets whether or not a particular widget has the specified users focus, and if so the type of focus.
bool	HasUserFocusedDescendants ( const TSharedRef< const SWidget >&..., int32 UserIndex )	Checks whether the specified widget has any descendants which are currently focused for the specified user user.
bool	HasUserMouseCapture ( int32 UserIndex )	Gets whether or not a widget has captured the mouse for a particular user.
void	InvalidateAllWidgets ( bool bClearResourcesImmediately )	Notifies all invalidation panels that they should invalidate their contents
bool	IsActive()	Whether the application is active.
bool	IsCustomSafeZoneSet()
bool	IsExternalUIOpened()	Checks whether an UI for external services such as Steam is open.
bool	IsInitialized()	Returns true if a Slate application instance is currently initialized and ready
bool	IsSlateAsleep()	Is Slate currently sleeping or not.
bool	IsWidgetDirectlyHovered ( const TSharedPtr< const SWidget > W... )	Gets whether or not a particular widget is directly hovered.
bool	IsWindowHousingInteractiveTooltip ( const TSharedRef< const SWindow >&... )
FWidgetPath	LocateWidgetInWindow ( FVector2D ScreenspaceMouseCoordinat..., const TSharedRef< SWindow >& Windo..., bool bIgnoreEnabledStatus, int32 UserIndex )	Given a window, locate a widget under the cursor in it; returns an invalid path if cursor is not over this window.
FWidgetPath	LocateWindowUnderMouse ( FVector2D ScreenspaceMouseCoordinat..., const TArray< TSharedRef< SWindow >..., bool bIgnoreEnabledStatus, int32 UserIndex )	Given the screen-space coordinate of the mouse cursor, searches for a string of widgets that are under the mouse.
TSharedRef< ...	MakeImage ( const TAttribute< const FSlateBrush..., const TAttribute< FSlateColor >& C..., const TAttribute< EVisibility >& V... )	Creates an image widget.
TSharedRef< ...	MakeToolTip ( const FText& ToolTipText )	Creates a tool tip with the specified text.
TSharedRef< ...	MakeToolTip ( const TAttribute< FText >& ToolTip... )	Creates a tool tip with the specified text.
TSharedRef< ...	MakeWindowTitleBar ( const FWindowTitleBarArgs& InArgs, TSharedPtr< IWindowTitleBar >& Out... )	Creates a title bar for the specified window.
FOnGlobalInv...	OnGlobalInvalidationToggled()
FOnInvalidat...	OnInvalidateAllWidgets()
void	RequestDestroyWindow ( TSharedRef< SWindow > WindowToDestr... )	Destroying windows has implications on some OSs (e.g. destroying Win32 HWNDs can cause events to be lost).
void	ResetCustomSafeZone()
void	SetAllUserFocus ( const FWidgetPath& InFocusPath, const EFocusCause InCause )	Sets the focus for all users to the specified widget. The widget must be allowed to receive focus.
void	SetAllUserFocusAllowingDescendantFocus ( const FWidgetPath& InFocusPath, const EFocusCause InCause )	Sets the focus for all users to the specified widget unless that user is focused on a descendant.
void	SetCustomSafeZone ( const FMargin& InSafeZone )
bool	SetKeyboardFocus ( const FWidgetPath& InFocusPath, const EFocusCause InCause )	Sets keyboard focus to the specified widget. The widget must be allowed to receive keyboard focus.
bool	SetUserFocus ( const uint32 InUserIndex, const FWidgetPath& InFocusPath, const EFocusCause InCause )	Sets user focus to the specified widget. The widget must be allowed to receive focus.
bool	ShowUserFocus ( const TSharedPtr< const SWidget > W... )	Gets whether or not a particular widget should show user focus.
void	SwapSafeZoneTypes()
void	ToggleGlobalInvalidation ( bool bIsGlobalInvalidationEnabled )
void	UpdateCustomSafeZone ( const FMargin& NewSafeZoneRatio, bool bShouldRecacheMetrics )

Classes

	Name	Description
	FOnGlobalInvalidationToggled
	FOnInvalidateAllWidgets	Gets a delegate that is invoked when a global invalidate of all widgets should occur

Enums

	Name	Description
	ECustomSafeZoneState

Constants

Name	Description
CurrentBaseApplication	Holds a pointer to the current application.
CursorPointerIndex
CursorUserIndex
PlatformApplication	Holds a pointer to the platform application.

Deprecated Functions

		Name	Description
	TSharedRef< ...	MakeWindowTitleBar ( const TSharedRef< SWindow >& Windo..., const TSharedPtr< SWidget >& Cente..., EHorizontalAlignment CenterContentA..., TSharedPtr< IWindowTitleBar >& Out... )	This version of MakeWindowTitleBar has been deprecated. Use the version that takes in an FWindowTitleBarArgs parameter instead.