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 > Slate > Framework > Application > FSlateApplication

Light Theme

Dark Theme

FSlateApplication

Windows

MacOS

Linux

Inheritance Hierarchy

FSlateApplicationBase

FGenericApplicationMessageHandler

FSlateApplication

References

Module	Slate
Header	/Engine/Source/Runtime/Slate/Public/Framework/Application/SlateApplication.h
Include	#include "Framework/Application/SlateApplication.h"

Syntax

class FSlateApplication :
public FSlateApplicationBase,
public FGenericApplicationMessageHandler

Variables

		Name	Description
	FSlateApplicati...	OnApplicationActivationStateChanged
	FDragDropChecki...	OnDragDropCheckOverride

Constructors

No constructors are accessible with public or protected access.

Destructors

	Name	Description
	~FSlateApplication()	Virtual destructor.

Functions

	Name	Description
void	ActivateGameViewport()	Activates the Game Viewport if it is properly childed under a window
void	AddModalWindow ( TSharedRef< SWindow > InSlateWindow, const TSharedPtr< const SWidget > I..., bool bSlowTaskWindow )	Adds a modal window to the application.
TSharedRef< ...	AddWindowAsNativeChild ( TSharedRef< SWindow > InSlateWindow, TSharedRef< SWindow > InParentWindo..., const bool bShowImmediately )	Associates a top level Slate Window with a native window, and "natively" parents that window to the specified Slate window.
bool	AllowMoveCursor()
bool	AreMenuAnimationsEnabled()
FVector2D	CalculatePopupWindowPosition ( const FSlateRect& InAnchor, const FVector2D& InSize, bool bAutoAdjustForDPIScale, const FVector2D& InProposedPlaceme..., const EOrientation Orientation )	Calculates the popup window position from the passed in window position and size.
bool	CanAddModalWindow()	Returns true if this slate application is ready to open modal windows
void	CancelDragDrop()	Cancels any in flight drag and drops
bool	CanDisplayWindows()	Returns true if this slate application is ready to display windows.
void	ClearAllUserFocus ( EFocusCause ReasonFocusIsChanging )	Releases the focus for all users from whatever it currently is on.
void	ClearKeyboardFocus ( const EFocusCause ReasonFocusIsChan... )	Clears keyboard focus, if any widget is currently focused
void	ClearUserFocus ( uint32 UserIndex, EFocusCause ReasonFocusIsChanging )	Releases the users focus from whatever it currently is on.
void	CloseAllWindowsImmediately()	Closes all active windows immediately
void	CloseToolTip()	Closes the open tool-tip, if a tool-tip is open
TSharedRef< ...	Create ( const TSharedRef< class GenericAppl... )
void	Create()
void	DestroyRenderer()
void	DestroyWindowImmediately ( TSharedRef< SWindow > WindowToDestr... )	HACK: Don't use this unless shutting down a game viewport Game viewport windows need to be destroyed instantly or else the viewport could tick and access deleted data
void	DestroyWindowsImmediately()	Destroy the native and slate windows in the array provided.
void	DismissAllMenus()	Dismisses all open menus
void	DismissMenu ( const TSharedPtr< IMenu >& InFromM... )	Dismisses a menu and all its children
void	DismissMenuByWidget ( const TSharedRef< SWidget >& InWid... )	Dismisses a menu and all its children.
void	DrawPrepass ( TSharedPtr< SWindow > DrawOnlyThisW... )	Pre-pass step before drawing windows to compute geometry size and reshape autosized windows
void	DrawWindowAndChildren ( const TSharedRef< SWindow >& Windo..., FDrawWindowArgs& DrawWindowArgs )	Draws a window and its children
void	DrawWindows()	Draws Slate windows. Should only be called by the application's main loop or renderer.
void	EnableMenuAnimations ( const bool bEnableAnimations )	Sets whether transition effects for new menus and windows should be played.
void	EnterDebuggingMode()	Enters debugging mode which is a special state that causes the Slate application to tick in place which in the middle of a stack frame
void	ExternalModalStart()	Disable Slate components when an external, non-slate, modal window is brought up.
void	ExternalModalStop()	Re-enable disabled Slate components when a non-slate modal window is dismissed.
void	ExternalUIChange ( bool bIsOpening )	Sets the display state of external UI such as Steam.
TSharedPtr< ...	FindBestParentWindowForDialogs ( const TSharedPtr< SWidget >& InWid..., const ESlateParentWindowSearchMetho... )	Given an optional widget, try and get the most suitable parent window to use with dialogs (such as file and directory pickers).
const void &...	FindBestParentWindowHandleForDialogs ( const TSharedPtr< SWidget >& InWid..., const ESlateParentWindowSearchMetho... )	Given an optional widget, try and get the most suitable parent window handle to use with dialogs (such as file and directory pickers).
int32	FindInputPreProcessor ( TSharedPtr< class IInputProcessor >... )	Get the index of a registered pre-processor.
TSharedPtr< ...	FindMenuInWidgetPath ( const FWidgetPath& InWidgetPath )	Attempt to locate a menu that contains the specified widget
TSharedRef< ...	FindOrCreateVirtualUser ( int32 VirtualUserIndex )
void	FinishedInputThisFrame()	Occurs before Tick(), after all pointer and keyboard input has been processed.
void	FlushRenderState()	Flushes the render state of slate, releasing accesses and flushing all render commands.
void	ForceRedrawWindow ( const TSharedRef< SWindow >& InWin... )	Forces the window to redraw immediately.
void	ForEachUser ( TFunctionRef< void&)> I..., bool bIncludeVirtualUsers )	Allows you do some operations for every registered user.
void	GeneratePathToWidgetChecked ( TSharedRef< const SWidget > InWidge..., FWidgetPath& OutWidgetPath, EVisibility VisibilityFilter )	That this is a relatively slow operation! Asserts if the widget isn't found.
bool	GeneratePathToWidgetUnchecked ( TSharedRef< const SWidget > InWidge..., FWidgetPath& OutWidgetPath, EVisibility VisibilityFilter )	That this is a relatively slow operation! It can fail, in which case OutWidgetPath.IsValid() will be false.
FSlateApplic...	Get()	Returns the current instance of the application.
TSharedPtr< ...	GetActiveModalWindow()
bool	GetAllowTooltips()
void	GetAllVisibleChildWindows ( TArray< TSharedRef< SWindow > >& O..., TSharedRef< SWindow > CurrentWindow )	Gets all visible child windows of a window.
void	GetAllVisibleWindowsOrdered ( TArray< TSharedRef< SWindow > >& O... )	Gets all visible slate windows ordered from back to front based on child hierarchies
const float	GetAverageDeltaTime()	Returns the running average delta time (smoothed over several frames)
float	GetAverageDeltaTimeForResponsiveness()	Returns the running average delta time (smoothed over several frames) Unlike GetAverageDeltaTime() it excludes exceptional situations, such as when throttling mode is active.
float	GetCursorRadius()	Getter for the cursor radius
TSharedPtr< ...	GetCursorUser()
TSharedPtr< ...	GetCursorUser()	Get the standard 'default' user (there's always guaranteed to be at least one).
const float	GetDeltaTime()	Returns the real time delta since Slate last ticked widgets
TSharedPtr< ...	GetDragDroppingContent()	Get the current drag-dropping content
float	GetDragTriggerDistance()
float	GetDragTriggerDistanceSquared()
TSharedPtr< ...	GetGameViewport()	Returns the game viewport registered with the slate application
TSharedRef< ...	GetGlobalTabManager()
bool	GetHandleDeviceInputWhenApplicationNotActive()
void	GetInitialDisplayMetrics ( FDisplayMetrics& OutDisplayMetrics )
IInputInterf...	GetInputInterface()
TArray< TSha...	GetInteractiveTopLevelWindows()
double	GetLastUserInteractionTime()
FSlateLastUs...	GetLastUserInteractionTimeUpdateEvent()
FModifierKey...	GetModifierKeys()	Returns the current modifier keys state
void *	GetMouseCaptureWindow()	Returning platform-specific value designating window that captures mouse, or nullptr if mouse isn't captured
TSharedRef< ...	GetNavigationConfig()
const TAttri...	GetNormalExecutionAttribute()	Returns the attribute that can be used by widgets to check if the application is in normal execution mode Don't hold a reference to this anywhere that can exist when this application closes
FOnModalLoop...	GetOnModalLoopTickEvent()	Get the FOnModalLoopTickEvent for the Slate Application.
TSharedRef< ...	GetOrCreateUser ( const FInputEvent& InputEvent )
TSharedRef< ...	GetOrCreateUser ( int32 UserIndex )	Locates the SlateUser object corresponding to the index, creating a new one if it doesn't exist.
FPopupSuppor...	GetPopupSupport()
const TSet< ...	GetPressedMouseButtons()
TSharedRef< ...	GetRelevantNavConfig ( int32 UserIndex )
const FStyle...	GetRootStyle()
float	GetSoundDuration ( const FSlateSound& Sound )
ITextInputMe...	GetTextInputMethodSystem()
TSharedPtr< ...	GetUser ( int32 UserIndex )	Gets the user at the given index, null if the user does not exist.
TSharedPtr< ...	GetUser ( int32 UserIndex )
TSharedPtr< ...	GetUser ( const FInputEvent& InputEvent )
TSharedPtr< ...	GetUser ( const FInputEvent& InputEvent )
TSharedPtr< ...	GetUserFromControllerId ( int32 ControllerId )
TSharedPtr< ...	GetUserFromControllerId ( int32 ControllerId )	Gets the user at the given index, null if the user does not exist.
TOptional< i...	GetUserIndexForController ( int32 ControllerId, FKey InKey )
int32	GetUserIndexForController ( int32 ControllerId )
int32	GetUserIndexForKeyboard()
int32	GetUserIndexForMouse()
TSharedPtr< ...	GetVisibleMenuWindow()
FSlateRect	GetWorkArea ( const FSlateRect& InRect )	Get the work area that has the largest intersection with the specified rectangle
void	GotoLineInSource ( const FString& FileName, int32 LineNumber )	Opens the current platform's code editing IDE (if necessary) and focuses the specified line in the specified file.
bool	HasOpenSubMenus ( TSharedPtr< IMenu > InMenu )
bool	HasTraveledFarEnoughToTriggerDrag ( const FPointerEvent& PointerEvent, const FVector2D ScreenSpaceOrigin, EOrientation Orientation )
bool	HasTraveledFarEnoughToTriggerDrag ( const FPointerEvent& PointerEvent, const FVector2D ScreenSpaceOrigin )
void	InitHighDPI ( const bool bForceEnable )	Initializes high dpi support for the process
TSharedRef< ...	InitializeAsStandaloneApplication ( const TSharedRef< class FSlateRende... )
TSharedRef< ...	InitializeAsStandaloneApplication ( const TSharedRef< class FSlateRende..., const TSharedRef< class GenericAppl... )
bool	InitializeRenderer ( TSharedRef< FSlateRenderer > InRend..., bool bQuietMode )	Initializes the renderer responsible for drawing all elements in this application
void	InitializeSound ( const TSharedRef< ISlateSoundDevice... )	Set the slate sound provider that the slate app should use.
bool	InKismetDebuggingMode()
void	InvalidateAllViewports()	Removes references to FViewportRHI's.
bool	IsDragDropping()	Are we drag-dropping right now?
bool	IsDragDroppingAffected ( const FPointerEvent& InPointerEven... )	Are we drag-dropping and are we affected by this pointer event?
bool	IsFakingTouchEvents()
bool	IsGamepadAttached()
bool	IsInitialized()	Returns true if a Slate application instance is currently initialized and ready
bool	IsMouseAttached()
bool	IsNormalExecution()
bool	IsProcessingInput()	Returns true if the we're currently processing mouse, keyboard, touch or gamepad input.
bool	IsRenderingOffScreen()
bool	IsRunningAtTargetFrameRate()
bool	IsUsingHighPrecisionMouseMovment()
bool	IsUsingTrackpad()
bool	IsWindowInDestroyQueue ( TSharedRef< SWindow > Window )	Is the window in the app's destroy queue? If so it will be destroyed next tick.
void	LeaveDebuggingMode ( bool bLeavingDebugForSingleStep )	Leaves debugging mode
FWidgetPath	LocateWindowUnderMouse ( FVector2D ScreenspaceMouseCoordinat..., const TArray< TSharedRef< SWindow >..., bool bIgnoreEnabledStatus, int32 UserIndex )
void	NativeApp_ShowKeyboard ( bool bShow, FString InitialString, int32 SelectionStart, int32 SelectionEnd )	Shows or hides an onscreen keyboard
void	NavigateFromWidgetUnderCursor ( const uint32 InUserIndex, EUINavigation InNavigationType, TSharedRef< SWindow > InWindow )	Attempts to navigate directly to the widget currently under the given user's cursor
void	NavigateToWidget ( const uint32 UserIndex, const TSharedPtr< SWidget >& Navig..., ENavigationSource NavigationSource )	Attempts to navigate directly to the given widget
FSlateApplic...	OnApplicationActivationStateChanged()
FOnApplicati...	OnApplicationMousePreInputButtonDownListener()
FOnApplicati...	OnApplicationPreInputKeyDownListener()
EDropEffect:...	OnDragEnter ( const TSharedRef< SWindow >& Windo..., const TSharedRef< FExternalDragOper... )
FOnFocusChan...	OnFocusChanging()
FSlateTickEv...	OnPostTick()	Event after slate application ticks.
FSimpleMulti...	OnPreShutdown()	Event when the application is about to shutdown.
FSlateTickEv...	OnPreTick()
void	OnShutdown()	Called when the slate application is being shut down.
FOnWindowDPI...	OnSystemSignalsDPIChanged()	Event used to signal that a DPI change is about to happen
FUserRegiste...	OnUserRegistered()
FOnWindowBei...	OnWindowBeingDestroyed()
FOnWindowDPI...	OnWindowDPIScaleChanged()
void	OverridePlatformApplication ( TSharedPtr< class GenericApplicatio... )	Replace the current platform application with a custom version.
void	PlaySound ( const FSlateSound& SoundToPlay, int32 UserIndex )	Play SoundToPlay. Interrupt previous sound if one is playing.
void	PollGameDeviceState()	Polls game devices for input
void	PrivateDrawWindows ( TSharedPtr< SWindow > DrawOnlyThisW... )	Draws slate windows, optionally only drawing the passed in window
bool	ProcessAnalogInputEvent ( const FAnalogInputEvent& InAnalogI... )	Called when a analog input values change
void	ProcessApplicationActivationEvent ( bool InAppActivated )	Called when the application is activated (i.e. one of its windows becomes active) or deactivated.
void	ProcessCursorReply ( const FCursorReply& CursorReply )	Apply any requests from the CursorReply
bool	ProcessDragEnterEvent ( TSharedRef< SWindow > WindowEntered, const FDragDropEvent& DragDropEven... )	Called when a drag from an external (non-slate) source enters a window
void	ProcessExternalReply ( const FWidgetPath& CurrentEventPat..., const FReply TheReply, const int32 UserIndex, const int32 PointerIndex )	Apply any requests from the Reply to the application. E.g. Capture mouse
bool	ProcessKeyCharEvent ( const FCharacterEvent& InCharacter... )	Called when a character is entered
bool	ProcessKeyDownEvent ( const FKeyEvent& InKeyEvent )	Called when a key is pressed
bool	ProcessKeyUpEvent ( const FKeyEvent& InKeyEvent )	Called when a key is released
void	ProcessMotionDetectedEvent ( const FMotionEvent& InMotionEvent )	Called when motion is detected (controller or device) when polling game device state
bool	ProcessMouseButtonDoubleClickEvent ( const TSharedPtr< FGenericWindow > ..., const FPointerEvent& InMouseEvent )	Called by the native application in response to a mouse release. Routs the event to Slate Widgets.
bool	ProcessMouseButtonDownEvent ( const TSharedPtr< FGenericWindow > ..., const FPointerEvent& InMouseEvent )	Called by the native application in response to a mouse button press.
bool	ProcessMouseButtonUpEvent ( const FPointerEvent& MouseEvent )	Called by the native application in response to a mouse button release.
bool	ProcessMouseMoveEvent ( const FPointerEvent& MouseEvent, bool bIsSynthetic )	Called by the native application in response to a mouse move. Routs the event to Slate Widgets.
bool	ProcessMouseWheelOrGestureEvent ( const FPointerEvent& InWheelEvent, const FPointerEvent* InGesture... )	Called by the native application in response to a mouse wheel spin or a touch gesture.
void	ProcessReply ( const FWidgetPath& CurrentEventPat..., const FReply& TheReply, const FWidgetPath* WidgetsUnde..., const FPointerEvent* InMouseEv..., const uint32 UserIndex )	Apply any requests from the Reply to the application. E.g. Capture mouse
void	ProcessTouchEndedEvent ( const FPointerEvent& InTouchEvent )	Called when a touchpad touch is ended (finger lifted) when polling game device state
void	ProcessTouchMovedEvent ( const FPointerEvent& InTouchEvent )	Called when a touchpad touch is moved (finger moved) when polling game device state
void	ProcessTouchStartedEvent ( const TSharedPtr< FGenericWindow > ..., const FPointerEvent& InTouchEvent )	Called when a touchpad touch is started (finger down) when polling game device state
bool	ProcessWindowActivatedEvent ( const FWindowActivateEvent& Activa... )	Called by the native application in response to an activation or deactivation.
void	PumpMessages()	Pumps OS messages when a modal window or intra-frame debugging session exists
TSharedPtr< ...	PushHostedMenu ( const TSharedRef< SWidget >& InPar..., const FWidgetPath& InOwnerPath, const TSharedRef< IMenuHost >& InM..., const TSharedRef< SWidget >& InCon..., TSharedPtr< SWidget >& OutWrappedC..., const FPopupTransitionEffect& Tran..., EShouldThrottle ShouldThrottle, const bool bIsCollapsedByParent )	Creates a new hosted Menu and adds it to the menu stack.
TSharedPtr< ...	PushHostedMenu ( const TSharedPtr< IMenu >& InParen..., const TSharedRef< IMenuHost >& InM..., const TSharedRef< SWidget >& InCon..., TSharedPtr< SWidget >& OutWrappedC..., const FPopupTransitionEffect& Tran..., EShouldThrottle ShouldThrottle, const bool bIsCollapsedByParent )	Creates a new hosted child Menu and adds it to the menu stack under the specified parent menu.
TSharedPtr< ...	PushMenu ( const TSharedRef< SWidget >& InPar..., const FWidgetPath& InOwnerPath, const TSharedRef< SWidget >& InCon..., const FVector2D& SummonLocation, const FPopupTransitionEffect& Tran..., const bool bFocusImmediately, const FVector2D& SummonLocationSiz..., TOptional< EPopupMethod > Method, const bool bIsCollapsedByParent )	Creates a new Menu and adds it to the menu stack.
TSharedPtr< ...	PushMenu ( const TSharedPtr< IMenu >& InParen..., const TSharedRef< SWidget >& InCon..., const FVector2D& SummonLocation, const FPopupTransitionEffect& Tran..., const bool bFocusImmediately, const FVector2D& SummonLocationSiz..., const bool bIsCollapsedByParent )	Creates a new Menu and adds it to the menu stack under the specified parent menu.
void	QueryCursor()	Bubble a request for which cursor to display for widgets under the mouse or the widget that captured the mouse.
void	RegisterGameViewport ( TSharedRef< SViewport > InViewport )	Registers a game viewport with the Slate application so that specific messages can be routed directly to a viewport
bool	RegisterInputPreProcessor ( TSharedPtr< class IInputProcessor >..., const int32 Index )	Adds input pre-processor if unique.
TSharedRef< ...	RegisterNewUser ( int32 UserIndex, bool bIsVirtual )	Register a new user with Slate.
FDelegateHan...	RegisterOnWindowActionNotification ( const FOnWindowAction& Notificatio... )	Register for a notification when the window action occurs.
void	RegisterViewport ( TSharedRef< SViewport > InViewport )	Registers a viewport with the Slate application so that specific messages can be routed directly to a viewport This is for all viewports, there can be multiple of these as opposed to the singular "Game Viewport"
void	RegisterVirtualWindow ( TSharedRef< SWindow > InWindow )	Register another window that may be visible in a non-top level way that still needs to be able to maintain focus paths.
void	ReleaseAllPointerCapture()	Releases capture for every pointer on every user from whatever it currently is on.
void	ReleaseAllPointerCapture ( int32 UserIndex )	Releases capture for every pointer belonging to the given user index particular user.
void	ResetToDefaultInputSettings()	Restores all input settings to their original values
void	ResetToDefaultPointerInputSettings()	Restores all pointer input settings to their original values
FReply	RouteMouseWheelOrGestureEvent ( const FWidgetPath& WidgetsUnderPoi..., const FPointerEvent& InWheelEvent, const FPointerEvent* InGesture... )	Directly routes a pointer mouse wheel or gesture event to the widgets in the specified widget path.
FReply	RoutePointerDoubleClickEvent ( const FWidgetPath& WidgetsUnderPoi..., const FPointerEvent& PointerEvent )	Directly routes a pointer double click event to the widgets in the specified widget path
FReply	RoutePointerDownEvent ( const FWidgetPath& WidgetsUnderPoi..., const FPointerEvent& PointerEvent )	Directly routes a pointer down event to the widgets in the specified widget path
bool	RoutePointerMoveEvent ( const FWidgetPath& WidgetsUnderPoi..., const FPointerEvent& PointerEvent, bool bIsSynthetic )	Directly routes a pointer move event to the widgets in the specified widget path
FReply	RoutePointerUpEvent ( const FWidgetPath& WidgetsUnderPoi..., const FPointerEvent& PointerEvent )	Directly routes a pointer up event to the widgets in the specified widget path
void	SetAllowTooltips ( bool bCanShow )
void	SetAllUserFocus ( const TSharedPtr< SWidget >& Widge..., EFocusCause ReasonFocusIsChanging )	Sets focus for all users to the SWidget passed in.
void	SetAllUserFocusToGameViewport ( EFocusCause ReasonFocusIsChanging )	Sets all users focus to the SWidget representing the currently active game viewport
void	SetAppIcon ( const FSlateBrush*const InAppI... )	Set the global application icon
void	SetApplicationScale ( float InScale )
void	SetCursorRadius ( float NewRadius )	Sets the hit detection radius of the cursor
void	SetDragTriggerDistance ( float ScreenPixels )	Set the size of the deadzone for dragging in screen pixels
void	SetExitRequestedHandler ( const FSimpleDelegate& OnExitReque... )	Assign a delegate to be called when this application is requesting an exit (e.g. when the last window is closed).
void	SetGameIsFakingTouchEvents ( const bool bIsFaking, FVector2D* CursorLocation )	Sets whether the application is treating mouse events as imitating touch events.
void	SetHandleDeviceInputWhenApplicationNotActive ( bool bAllow )	Mouse capture
void	SetInputManager ( TSharedRef< ISlateInputManager > In... )	Establishes the input mapping object used to map input sources to SlateUser indices
bool	SetKeyboardFocus ( const TSharedPtr< SWidget >& Optio..., EFocusCause ReasonFocusIsChanging )	Sets the Keyboard focus to the specified SWidget
void	SetModalWindowStackEndedDelegate ( FModalWindowStackEnded StackEndedDe... )	Sets the delegate for when a modal window stack ends
void	SetModalWindowStackStartedDelegate ( FModalWindowStackStarted StackStart... )	Sets the delegate for when a modal window stack begins
void	SetNavigationConfig ( TSharedRef< FNavigationConfig > InN... )	Sets the navigation config.
void	SetPlatformApplication ( const TSharedRef< class GenericAppl... )
void	SetPlatformCursorVisibility ( bool bNewVisibility )	Changes the cursor type to Default (Visible) or None (Not Visible)
void	SetUnhandledKeyDownEventHandler ( const FOnKeyEvent& NewHandler )	Sets the handler for otherwise unhandled key down events.
void	SetUnhandledKeyUpEventHandler ( const FOnKeyEvent& NewHandler )	Sets the handler for otherwise unhandled key down events.
void	SetupPhysicalSensitivities()	Sets up any values that need to be based on the physical dimensions of the device.
bool	SetUserFocus ( uint32 UserIndex, const TSharedPtr< SWidget >& Widge..., EFocusCause ReasonFocusIsChanging )	Sets specified user focus to the SWidget passed in.
void	SetUserFocusToGameViewport ( uint32 UserIndex, EFocusCause ReasonFocusIsChanging )	Sets specified user focus to the SWidget representing the currently active game viewport
void	SetWidgetReflector ( const TSharedRef< IWidgetReflector ... )	Sets the widget reflector.
void	SetWidgetReflectorAssetAccessDelegate ( FAccessAsset AccessDelegate )
void	SetWidgetReflectorQuerySourceAccessDelegate ( FQueryAccessSourceCode QueryAccessD... )
void	SetWidgetReflectorSourceAccessDelegate ( FAccessSourceCode AccessDelegate )
void	ShowSystemHelp()
void	ShowVirtualKeyboard ( bool bShow, int32 UserIndex, TSharedPtr< IVirtualKeyboardEntry >... )	Shows or hides an onscreen keyboard
void	Shutdown ( bool bShutdownPlatform )
void	SpawnToolTip ( const TSharedRef< IToolTip >& InTo..., const FVector2D& InSpawnLocation )	Spawns a tool tip window. If an existing tool tip window is open, it will be dismissed first.
bool	SupportsSourceAccess()
bool	SupportsSystemHelp()
bool	TakeScreenshot ( const TSharedRef< SWidget >& Widge..., const FIntRect& InnerWidgetArea, TArray< FColor >& OutColorData, FIntVector& OutSize )	Takes a screenshot of the widget writing the results into the color buffer provided, this version allows you to provide an inner area to screenshot.
bool	TakeScreenshot ( const TSharedRef< SWidget >& Widge..., TArray< FColor >& OutColorData, FIntVector& OutSize )	Takes a screenshot of the widget writing the results into the color buffer provided.
void	ThrottleApplicationBasedOnMouseMovement()	Engages or disengages application throttling based on user behavior
void	Tick ( ESlateTickType TickType )	Ticks this application
void	TickAndDrawWidgets ( float DeltaTime )	Ticks and paints the actual Slate portion of the application.
void	TickPlatform ( float DeltaTime )	Pumps and ticks the platform.
void	TickTime()	Advances time for the application.
void	UnregisterGameViewport()	Unregisters the current game viewport from Slate.
void	UnregisterInputPreProcessor ( TSharedPtr< class IInputProcessor >... )	Removes an input pre-processor.
void	UnregisterOnWindowActionNotification ( FDelegateHandle Handle )	Unregister the notification because it is no longer desired.
void	UnregisterUser ( int32 UserIndex )
void	UnregisterVirtualWindow ( TSharedRef< SWindow > InWindow )	Unregister a virtual window.
void	UpdateToolTip ( bool bAllowSpawningOfNewToolTips )
void	UsePlatformCursorForCursorUser ( bool bUsePlatformCursor )	Updates the cursor user's cursor to either the platform cursor or fake cursor

Overridden from FSlateApplicationBase

	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	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... )	Finds the window that the provided widget resides in
TSharedPtr< ...	GetActiveTopLevelWindow()	Gets the active top-level window.
const FSlate...	GetAppIcon()	Gets the global application icon.
float	GetApplicationScale()	Gets the ratio SlateUnit / ScreenPixel.
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..
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...	GetNavigationActionFromKey ( const FKeyEvent& InKeyEvent )	Returns the navigation action corresponding to a key event.
EUINavigatio...	GetNavigationDirectionFromAnalog ( const FAnalogInputEvent& InAnalogE... )	Returns navigation direction matching an anlog event, this is determined in the FNavigationConfig
EUINavigatio...	GetNavigationDirectionFromKey ( const FKeyEvent& InKeyEvent )	Returns navigation direction matching a key event, this is determined in the FNavigationConfig
FSlateRect	GetPreferredWorkArea()	Gets the rectangle of the current preferred work area.
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.
bool	IsActive()	Whether the application is active.
bool	IsExternalUIOpened()	Checks whether an UI for external services such as Steam is open.
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.
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.
void	RequestDestroyWindow ( TSharedRef< SWindow > WindowToDestr... )	Destroying windows has implications on some OSs (e.g. destroying Win32 HWNDs can cause events to be lost).
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.
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.

Overridden from FGenericApplicationMessageHandler

	Name	Description
bool	BeginReshapingWindow ( const TSharedRef< FGenericWindow > ... )
void	FinishedReshapingWindow ( const TSharedRef< FGenericWindow > ... )
FWindowSizeL...	GetSizeLimitsForWindow ( const TSharedRef< FGenericWindow > ... )
EWindowZone:...	GetWindowZoneForPoint ( const TSharedRef< FGenericWindow > ..., const int32 X, const int32 Y )
void	HandleDPIScaleChanged ( const TSharedRef< FGenericWindow > ... )
bool	OnApplicationActivationChanged ( const bool IsActive )
bool	OnControllerAnalog ( FGamepadKeyNames::Type KeyName, int32 ControllerId, float AnalogValue )
bool	OnControllerButtonPressed ( FGamepadKeyNames::Type KeyName, int32 ControllerId, bool IsRepeat )
bool	OnControllerButtonReleased ( FGamepadKeyNames::Type KeyName, int32 ControllerId, bool IsRepeat )
bool	OnConvertibleLaptopModeChanged()
bool	OnCursorSet()
EDropEffect:...	OnDragDrop ( const TSharedPtr< FGenericWindow > ... )
EDropEffect:...	OnDragEnterExternal ( const TSharedRef< FGenericWindow > ..., const FString& Text, const TArray< FString >& Files )
EDropEffect:...	OnDragEnterFiles ( const TSharedRef< FGenericWindow > ..., const TArray< FString >& Files )
EDropEffect:...	OnDragEnterText ( const TSharedRef< FGenericWindow > ..., const FString& Text )
void	OnDragLeave ( const TSharedPtr< FGenericWindow > ... )
EDropEffect:...	OnDragOver ( const TSharedPtr< FGenericWindow > ... )
void	OnInputLanguageChanged()
bool	OnKeyChar ( const TCHAR Character, const bool IsRepeat )
bool	OnKeyDown ( const int32 KeyCode, const uint32 CharacterCode, const bool IsRepeat )
bool	OnKeyUp ( const int32 KeyCode, const uint32 CharacterCode, const bool IsRepeat )
bool	OnMotionDetected ( const FVector& Tilt, const FVector& RotationRate, const FVector& Gravity, const FVector& Acceleration, int32 ControllerId )
bool	OnMouseDoubleClick ( const TSharedPtr< FGenericWindow > ..., const EMouseButtons::Type Button, const FVector2D CursorPos )
bool	OnMouseDoubleClick ( const TSharedPtr< FGenericWindow > ..., const EMouseButtons::Type Button )
bool	OnMouseDown ( const TSharedPtr< FGenericWindow > ..., const EMouseButtons::Type Button, const FVector2D CursorPos )
bool	OnMouseDown ( const TSharedPtr< FGenericWindow > ..., const EMouseButtons::Type Button )
bool	OnMouseMove()
bool	OnMouseUp ( const EMouseButtons::Type Button )
bool	OnMouseUp ( const EMouseButtons::Type Button, const FVector2D CursorPos )
bool	OnMouseWheel ( const float Delta )
bool	OnMouseWheel ( const float Delta, const FVector2D CursorPos )
void	OnMovedWindow ( const TSharedRef< FGenericWindow > ..., const int32 X, const int32 Y )
void	OnOSPaint ( const TSharedRef< FGenericWindow > ... )
bool	OnRawMouseMove ( const int32 X, const int32 Y )
void	OnResizingWindow ( const TSharedRef< FGenericWindow > ... )
bool	OnSizeChanged ( const TSharedRef< FGenericWindow > ..., const int32 Width, const int32 Height, bool bWasMinimized )
bool	OnTouchEnded ( const FVector2D& Location, int32 TouchIndex, int32 ControllerId )
bool	OnTouchFirstMove ( const FVector2D& Location, float Force, int32 TouchIndex, int32 ControllerId )
bool	OnTouchForceChanged ( const FVector2D& Location, float Force, int32 TouchIndex, int32 ControllerId )
bool	OnTouchGesture ( EGestureEvent GestureType, const FVector2D& Delta, float WheelDelta, bool bIsDirectionInvertedFromDevice )
bool	OnTouchMoved ( const FVector2D& Location, float Force, int32 TouchIndex, int32 ControllerId )
bool	OnTouchStarted ( const TSharedPtr< FGenericWindow > ..., const FVector2D& Location, float Force, int32 TouchIndex, int32 ControllerId )
bool	OnWindowAction ( const TSharedRef< FGenericWindow > ..., const EWindowAction::Type InActionT... )
bool	OnWindowActivationChanged ( const TSharedRef< FGenericWindow > ..., const EWindowActivation ActivationT... )
void	OnWindowClose ( const TSharedRef< FGenericWindow > ... )
void	SetCursorPos ( const FVector2D& MouseCoordinate )	Sets the position of the cursor.
bool	ShouldProcessUserInputMessages ( const TSharedPtr< FGenericWindow > ... )
void	ShouldSimulateGesture ( EGestureEvent Gesture, bool bEnable )
void	SignalSystemDPIChanged ( const TSharedRef< FGenericWindow > ... )

Classes

	Name	Description
	FApplicationActivationStateChangedEvent
	FOnApplicationMousePreInputButtonDownListener	Gets a delegate that is invoked before the mouse input button down get process by slate widgets bubble system.
	FOnApplicationPreInputKeyDownListener	Gets a delegate that is invoked before the input key get process by slate widgets bubble system.
	FOnModalLoopTickEvent	Event type for when Slate is ticking during a modal dialog loop
	FOnWindowBeingDestroyed	Delegate called when a window is about to be destroyed
	FOnWindowDPIScaleChanged	Gets a delegate that is invoked in the editor when a windows dpi scale changes or when a widget window may have changed and DPI scale info needs to be checked
	FSlateLastUserInteractionTimeUpdateEvent
	FSlateTickEvent	Event before slate application ticks.
	FUserRegisteredEvent	Delegate for when a new user has been registered.

Typedefs

Name	Description
FOnFocusChanging	Delegate called just before possible focus change

Constants

Name	Description
CurrentApplication	Application singleton

Deprecated Functions

	Name	Description
TSharedPtr< ...	FindWidgetWindow ( TSharedRef< const SWidget > InWidge..., FWidgetPath& OutWidgetPath )	The FindWidgetWindow method that takes an FWidgetPath has been deprecated. If you dont need the widget path, use FindWidgetWindow(MyWidget) instead. If you need the path use GeneratePathToWidget
void	ForEachUser ( TFunctionRef< void*..., bool bIncludeVirtualUsers )	ForEachUser now provides an FSlateUser& parameter to the lambda instead of an FSlateUser*
EUINavigatio...	GetNavigationActionForKey ( const FKey& InKey )	GetNavigationActionForKey doesn't handle multiple users properly, use GetNavigationActionFromKey instead
void	ReleaseMouseCapture()	ReleaseMouseCapture has been renamed to ReleaseAllPointerCapture()
void	ReleaseMouseCaptureForUser ( int32 UserIndex )	ReleaseMouseCaptureForUser has been renamed to ReleaseAllPointerCapture(int32 UserIndex)
void	SetNavigationConfigFactory ( TFunction< TSharedRef< FNavigationC... )	Returning to a simpler method of registering navigation configs., is what you should use now.

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

Take our survey

Dismiss