1. Epic GamesDeveloper
  3. FSlateApplication

FSlateApplication

API > API/Runtime > API/Runtime/Slate > API/Runtime/Slate/Framework > API/Runtime/Slate/Framework/Application

Inheritance Hierarchy

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

  Type Name Description
Public variable FSlateApplication::FOnModalLoopTickEvent & OnApplicationActivationStateChanged  
Public variable FDragDropCheckingOverride OnDragDropCheckOverride  

Constructors

No constructors are accessible with public or protected access.

Destructors

  Type Name Description
Public function Virtual   Virtual destructor.

Functions

  Type Name Description
Public function void Activates the Game Viewport if it is properly childed under a window
Public function void

AddModalWindow ( TSharedRef< SWindow > InSlateWindow,
const TSharedPtr< const SWidget > InParentWidget,
bool bSlowTaskWindow
)

 Adds a modal window to the application.
Public function TSharedRef< SWindow >

AddWindowAsNativeChild ( TSharedRef< SWindow > InSlateWindow,
TSharedRef< SWindow > InParentWindow,
const bool bShowImmediately
)

 Associates a top level Slate Window with a native window, and "natively" parents that window to the specified Slate window.
Public function bool  
Public function Const bool  
Public function Virtual Const UE::Slate::FDeprecateVector2DResult

CalculatePopupWindowPosition ( const FSlateRect& InAnchor,
const UE::Slate::FDeprecateVector2DParameter& InSize,
bool bAutoAdjustForDPIScale,
const UE::Slate::FDeprecateVector2DParameter& InProposedPlacement,
const EOrientation Orientation
)

 Calculates the popup window position from the passed in window position and size.
Public function Const bool Returns true if this slate application is ready to open modal windows
Public function void Cancels any in flight drag and drops
Public function Const bool Returns true if this slate application is ready to display windows.
Public function void

ClearAllUserFocus ( EFocusCause ReasonFocusIsChanging
)

 Releases the focus for all users from whatever it currently is on.
Public function void

ClearKeyboardFocus ( const EFocusCause ReasonFocusIsChanging
)

 Clears keyboard focus, if any widget is currently focused
Public function void

ClearUserFocus ( uint32 UserIndex,
EFocusCause ReasonFocusIsChanging
)

 Releases the users focus from whatever it currently is on.
Public function void Closes all active windows immediately
Public function void Closes the open tool-tip, if a tool-tip is open
Public function Static TSharedRef< FSlateApplication >

Create ( const TSharedRef< class GenericApplication >& InPlatformApplication
)

  
Public function Static void

Create ()

  
Protected function void  
Public function void 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
Public function void Destroy the native and slate windows in the array provided.
Public function void Dismisses all open menus
Public function void

DismissMenu ( const TSharedPtr< IMenu >& InFromMenu
)

 Dismisses a menu and all its children
Public function void

DismissMenuByWidget ( const TSharedRef< SWidget >& InWidgetInMenu
)

 Dismisses a menu and all its children.
Protected function void

DrawPrepass ( TSharedPtr< SWindow > DrawOnlyThisWindow
)

 Pre-pass step before drawing windows to compute geometry size and reshape autosized windows
Protected function void

DrawWindowAndChildren ( const TSharedRef< SWindow >& WindowToDraw,
FDrawWindowArgs& DrawWindowArgs
)

 Draws a window and its children
Protected function void Draws Slate windows. Should only be called by the application's main loop or renderer.
Public function void 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
Public function void Disable Slate components when an external, non-slate, modal window is brought up.
Public function void Re-enable disabled Slate components when a non-slate modal window is dismissed.
Public function void

ExternalUIChange ( bool bIsOpening
)

 Sets the display state of external UI such as Steam.
Public function TSharedPtr< SWindow >

FindBestParentWindowForDialogs ( const TSharedPtr< SWidget >& InWidget,
const ESlateParentWindowSearchMethod InParentWindowSearchMethod
)

 Given an optional widget, try and get the most suitable parent window to use with dialogs (such as file and directory pickers).
Public function const void *

FindBestParentWindowHandleForDialogs ( const TSharedPtr< SWidget >& InWidget,
const ESlateParentWindowSearchMethod InParentWindowSearchMethod
)

 Given an optional widget, try and get the most suitable parent window handle to use with dialogs (such as file and directory pickers).
Public function Const int32

FindInputPreProcessor ( TSharedPtr< class IInputProcessor > InputProcessor
)

 Get the index of a registered pre-processor.
Public function Const TSharedPtr< IMenu >

FindMenuInWidgetPath ( const FWidgetPath& InWidgetPath
)

 Attempt to locate a menu that contains the specified widget
Public function TSharedRef< FSlateVirtualUserHandle >

FindOrCreateVirtualUser ( int32 VirtualUserIndex
)

  
Public function void Occurs before Tick(), after all pointer and keyboard input has been processed.
Public function void Flushes the render state of slate, releasing accesses and flushing all render commands.
Public function void

ForceRedrawWindow ( const TSharedRef< SWindow >& InWindowToDraw
)

 Forces the window to redraw immediately.
Public function void

ForEachUser ( TFunctionRef< void(FSlateUser&)> InPredicate,
bool bIncludeVirtualUsers
)

 Allows you do some operations for every registered user.
Public function Const void

GeneratePathToWidgetChecked ( TSharedRef< const SWidget > InWidget,
FWidgetPath& OutWidgetPath,
EVisibility VisibilityFilter
)

  
Public function Const bool

GeneratePathToWidgetUnchecked ( TSharedRef< const SWidget > InWidget,
FWidgetPath& OutWidgetPath,
EVisibility VisibilityFilter
)

  
Public function Static FSlateApplication &

Get ()

 Returns the current instance of the application.
Public function Const TSharedPtr< SWindow >  
Public function Const bool  
Protected function void

GetAllVisibleChildWindows ( TArray< TSharedRef< SWindow > >& OutWindows,
TSharedRef< SWindow > CurrentWindow
)

 Gets all visible child windows of a window.
Public function void Gets all visible slate windows ordered from back to front based on child hierarchies
Public function Const const float Returns the running average delta time (smoothed over several frames)
Public function Const float Returns the running average delta time (smoothed over several frames) Unlike GetAverageDeltaTime() it excludes exceptional situations, such as when throttling mode is active.
Public function Const float Getter for the cursor radius
Public function TSharedPtr< FSlateUser >  
Public function Const TSharedPtr< const FSlateUser > Get the standard 'default' user (there's always guaranteed to be at least one).
Public function Const const float Returns the real time delta since Slate last ticked widgets
Public function Const TSharedPtr< class FDragDropOperation > Get the current drag-dropping content
Public function Const float  
Public function Const float  
Public function Static double Gets time step in seconds if a fixed delta time is wanted.
Public function Const TSharedPtr< SViewport > Returns the game viewport registered with the slate application
Public function Static TSharedRef< class FGlobalTabmanager >  
Public function Const bool  
Public function Virtual Const void

GetInitialDisplayMetrics ( FDisplayMetrics& OutDisplayMetrics
)

  
Public function Const FInputDeviceId  
Public function Const FInputDeviceId  
Public function Const IInputInterface *  
Public function TArray< TSharedRef< SWindow > >  
Public function Const double  
Public function FSlateLastUserInteractionTimeUpdateEvent &  
Public function Const TSharedPtr< SWidget >  
Public function Const FModifierKeysState Returns the current modifier keys state
Public function Virtual Const void * Returning platform-specific value designating window that captures mouse, or nullptr if mouse isn't captured
Public function Const TSharedRef< FNavigationConfig >  
Public function Const const TAttribute< bool > & 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
Public function FOnModalLoopTickEvent & Get the FOnModalLoopTickEvent for the Slate Application.
Protected function TSharedRef< FSlateUser >

GetOrCreateUser ( FPlatformUserId PlatformUserId
)

 Locates the SlateUser object corresponding to the index, creating a new one if it doesn't exist.
Protected function TSharedRef< FSlateUser >

GetOrCreateUser ( int32 UserIndex
)

 Locates the SlateUser object corresponding to the index, creating a new one if it doesn't exist.
Protected function TSharedRef< FSlateUser >

GetOrCreateUser ( const FInputEvent& InputEvent
)

  
Protected function TSharedRef< FSlateUser > Locates the SlateUser object corresponding to the input device id, creating a new one if it doesn't exist.
Public function FPopupSupport &  
Public function Const const TSet< FKey > &  
Protected function Const TSharedRef< FNavigationConfig >

GetRelevantNavConfig ( int32 UserIndex
)

  
Public function Const const FStyleNode *  
Public function Const float

GetSoundDuration ( const FSlateSound& Sound
)

  
Public function Const ITextInputMethodSystem *  
Public function Const bool True if transforming mouse input coordinates to account for fullscreen distortions
Public function Const TSharedPtr< const FSlateUser >

GetUser ( int32 UserIndex
)

 Gets the user at the given index, null if the user does not exist.
Public function TSharedPtr< FSlateUser >

GetUser ( const FInputEvent& InputEvent
)

  
Public function Const TSharedPtr< const FSlateUser >

GetUser ( const FInputEvent& InputEvent
)

  
Public function TSharedPtr< FSlateUser >

GetUser ( int32 UserIndex
)

  
Public function TSharedPtr< FSlateUser >

GetUser ( FPlatformUserId PlatformUser
)

  
Public function Const TSharedPtr< const FSlateUser >

GetUserFromControllerId ( int32 ControllerId
)

 Gets the user at the given index, null if the user does not exist.
Public function TSharedPtr< FSlateUser >

GetUserFromControllerId ( int32 ControllerId
)

  
Public function TSharedPtr< FSlateUser >  
Public function Const TSharedPtr< const FSlateUser >  
Public function Const int32

GetUserIndexForController ( int32 ControllerId
)

  
Public function Const TOptional< int32 >

GetUserIndexForController ( int32 ControllerId,
FKey InKey
)

  
Public function Const TOptional< int32 >  
Public function Const int32  
Public function Const int32  
Public function Const TOptional< int32 >  
Public function Const TSharedPtr< SWindow >  
Public function Const FSlateRect

GetWorkArea ( const FSlateRect& InRect
)

 Get the work area that has the largest intersection with the specified rectangle
Public function Const 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.
Public function Const bool  
Public function Const bool

HasTraveledFarEnoughToTriggerDrag ( const FPointerEvent& PointerEvent,
const UE::Slate::FDeprecateVector2DParameter ScreenSpaceOrigin,
EOrientation Orientation
)

  
Public function Const bool  
Public function Static void

InitHighDPI ( const bool bForceEnable
)

 Initializes high dpi support for the process
Public function Static TSharedRef< FSlateApplication >

InitializeAsStandaloneApplication ( const TSharedRef< class FSlateRenderer >& PlatformRenderer,
const TSharedRef< class GenericApplication >& InPlatformApplication
)

  
Public function Static TSharedRef< FSlateApplication >

InitializeAsStandaloneApplication ( const TSharedRef< class FSlateRenderer >& PlatformRenderer
)

  
Public function Static void  
Public function Virtual bool

InitializeRenderer ( TSharedRef< FSlateRenderer > InRenderer,
bool bQuietMode
)

 Initializes the renderer responsible for drawing all elements in this application
Public function Virtual void

InitializeSound ( const TSharedRef< ISlateSoundDevice >& InSlateSoundDevice
)

 Set the slate sound provider that the slate app should use.
Public function Const bool  
Public function void Removes references to FViewportRHI's.
Public function Const bool Are we drag-dropping right now?
Public function Const bool

IsDragDroppingAffected ( const FPointerEvent& InPointerEvent
)

 Are we drag-dropping and are we affected by this pointer event?
Public function Const bool  
Public function Const bool  
Public function Static bool Returns true if a Slate application instance is currently initialized and ready
Public function Const bool  
Public function Const bool  
Public function Const bool Returns true if the we're currently processing mouse, keyboard, touch or gamepad input.
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool Is the window in the app's destroy queue? If so it will be destroyed next tick.
Public function void

LeaveDebuggingMode ( bool bLeavingDebugForSingleStep
)

 Leaves debugging mode
Public function Virtual FWidgetPath

LocateWindowUnderMouse ( UE::Slate::FDeprecateVector2DParameter ScreenspaceMouseCoordinate,
const TArray< TSharedRef< SWindow >>& Windows,
bool bIgnoreEnabledStatus,
int32 UserIndex
)

  
Public function Virtual void

NativeApp_ShowKeyboard ( bool bShow,
FString InitialString,
int32 SelectionStart,
int32 SelectionEnd
)

 Shows or hides an onscreen keyboard
Public function void

NavigateFromWidgetUnderCursor ( const uint32 InUserIndex,
EUINavigation InNavigationType,
TSharedRef< SWindow > InWindow
)

 Attempts to navigate directly to the widget currently under the given user's cursor
Public function void

NavigateToWidget ( const uint32 UserIndex,
const TSharedPtr< SWidget >& NavigationDestination,
ENavigationSource NavigationSource
)

 Attempts to navigate directly to the given widget
Public function FSlateApplication::FApplicationActivationStateChangedEvent TBaseMulticastDelegate_OneParam  
Public function FOnApplicationMousePreInputButtonDownListener &  
Public function FOnApplicationPreInputKeyDownListener &  
Public function EDropEffect::Type

OnDragEnter ( const TSharedRef< SWindow >& Window,
const TSharedRef< FExternalDragOperation >& DragDropOperation
)

  
Public function FOnFocusChanging &  
Public function FSlateTickEvent & Event after slate application ticks.
Public function FSimpleMulticastDelegate & Event when the application is about to shutdown.
Public function FSlateTickEvent &  
Protected function void Called when the slate application is being shut down.
Public function FOnWindowDPIScaleChanged & Event used to signal that a DPI change is about to happen
Public function FUserRegisteredEvent &  
Public function FOnWindowBeingDestroyed &  
Public function FOnWindowDPIScaleChanged &  
Public function void

OverridePlatformApplication ( TSharedPtr< class GenericApplication > InPlatformApplication
)

 Replace the current platform application with a custom version.
Public function void Replace the IPlatformTextField implementation with a custom one.
Public function Const void

PlaySound ( const FSlateSound& SoundToPlay,
int32 UserIndex
)

 Play SoundToPlay. Interrupt previous sound if one is playing.
Public function void Polls game devices for input
Protected function void

PrivateDrawWindows ( TSharedPtr< SWindow > DrawOnlyThisWindow
)

 Draws slate windows, optionally only drawing the passed in window
Public function bool

ProcessAnalogInputEvent ( const FAnalogInputEvent& InAnalogInputEvent
)

 Called when a analog input values change
Public function void

ProcessApplicationActivationEvent ( bool InAppActivated
)

 Called when the application is activated (i.e. one of its windows becomes active) or deactivated.
Public function void

ProcessCursorReply ( const FCursorReply& CursorReply
)

 Apply any requests from the CursorReply
Public function bool

ProcessDragEnterEvent ( TSharedRef< SWindow > WindowEntered,
const FDragDropEvent& DragDropEvent
)

 Called when a drag from an external (non-slate) source enters a window
Public function void

ProcessExternalReply ( const FWidgetPath& CurrentEventPath,
const FReply TheReply,
const int32 UserIndex,
const int32 PointerIndex
)

 Apply any requests from the Reply to the application. E.g. Capture mouse
Public function bool

ProcessKeyCharEvent ( const FCharacterEvent& InCharacterEvent
)

 Called when a character is entered
Public function bool

ProcessKeyDownEvent ( const FKeyEvent& InKeyEvent
)

 Called when a key is pressed
Public function bool

ProcessKeyUpEvent ( const FKeyEvent& InKeyEvent
)

 Called when a key is released
Public function void

ProcessMotionDetectedEvent ( const FMotionEvent& InMotionEvent
)

 Called when motion is detected (controller or device) when polling game device state
Public function bool

ProcessMouseButtonDoubleClickEvent ( const TSharedPtr< FGenericWindow >& PlatformWindow,
const FPointerEvent& InMouseEvent
)

 Called by the native application in response to a mouse release. Routs the event to Slate Widgets.
Public function bool

ProcessMouseButtonDownEvent ( const TSharedPtr< FGenericWindow >& PlatformWindow,
const FPointerEvent& InMouseEvent
)

 Called by the native application in response to a mouse button press.
Public function bool Called by the native application in response to a mouse button release.
Public function bool

ProcessMouseMoveEvent ( const FPointerEvent& MouseEvent,
bool bIsSynthetic
)

 Called by the native application in response to a mouse move. Routs the event to Slate Widgets.
Public function bool

ProcessMouseWheelOrGestureEvent ( const FPointerEvent& InWheelEvent,
const FPointerEvent* InGestureEvent
)

 Called by the native application in response to a mouse wheel spin or a touch gesture.
Public function void

ProcessReply ( const FWidgetPath& CurrentEventPath,
const FReply& TheReply,
const FWidgetPath* WidgetsUnderMouse,
const FPointerEvent* InMouseEvent,
const uint32 UserIndex
)

 Apply any requests from the Reply to the application. E.g. Capture mouse
Public function void

ProcessTouchEndedEvent ( const FPointerEvent& InTouchEvent
)

 Called when a touchpad touch is ended (finger lifted) when polling game device state
Public function void

ProcessTouchMovedEvent ( const FPointerEvent& InTouchEvent
)

 Called when a touchpad touch is moved (finger moved) when polling game device state
Public function void

ProcessTouchStartedEvent ( const TSharedPtr< FGenericWindow >& PlatformWindow,
const FPointerEvent& InTouchEvent
)

 Called when a touchpad touch is started (finger down) when polling game device state
Public function bool Called by the native application in response to an activation or deactivation.
Public function void Pumps OS messages when a modal window or intra-frame debugging session exists
Public function TSharedPtr< IMenu >

PushHostedMenu ( const TSharedPtr< IMenu >& InParentMenu,
const TSharedRef< IMenuHost >& InMenuHost,
const TSharedRef< SWidget >& InContent,
TSharedPtr< SWidget >& OutWrappedContent,
const FPopupTransitionEffect& TransitionEffect,
EShouldThrottle ShouldThrottle,
const bool bIsCollapsedByParent
)

 Creates a new hosted child Menu and adds it to the menu stack under the specified parent menu.
Public function TSharedPtr< IMenu >

PushHostedMenu ( const TSharedRef< SWidget >& InParentWidget,
const FWidgetPath& InOwnerPath,
const TSharedRef< IMenuHost >& InMenuHost,
const TSharedRef< SWidget >& InContent,
TSharedPtr< SWidget >& OutWrappedContent,
const FPopupTransitionEffect& TransitionEffect,
EShouldThrottle ShouldThrottle,
const bool bIsCollapsedByParent
)

 Creates a new hosted Menu and adds it to the menu stack.
Public function TSharedPtr< IMenu >

PushMenu ( const TSharedPtr< IMenu >& InParentMenu,
const TSharedRef< SWidget >& InContent,
const UE::Slate::FDeprecateVector2DParameter& SummonLocation,
const FPopupTransitionEffect& TransitionEffect,
const bool bFocusImmediately,
const UE::Slate::FDeprecateVector2DParameter& SummonLocationSize,
const bool bIsCollapsedByParent
)

 Creates a new Menu and adds it to the menu stack under the specified parent menu.
Public function TSharedPtr< IMenu >

PushMenu ( const TSharedRef< SWidget >& InParentWidget,
const FWidgetPath& InOwnerPath,
const TSharedRef< SWidget >& InContent,
const UE::Slate::FDeprecateVector2DParameter& SummonLocation,
const FPopupTransitionEffect& TransitionEffect,
const bool bFocusImmediately,
const UE::Slate::FDeprecateVector2DParameter& SummonLocationSize,
TOptional< EPopupMethod > Method,
const bool bIsCollapsedByParent
)

 Creates a new Menu and adds it to the menu stack.
Public function void Bubble a request for which cursor to display for widgets under the mouse or the widget that captured the mouse.
Public function void Registers a game viewport with the Slate application so that specific messages can be routed directly to a viewport
Public function bool

RegisterInputPreProcessor ( TSharedPtr< class IInputProcessor > InputProcessor,
const int32 Index
)

 Adds input pre-processor if unique.
Protected function TSharedRef< FSlateUser >

RegisterNewUser ( int32 UserIndex,
bool bIsVirtual
)

 Register a new user with Slate.
Protected function TSharedRef< FSlateUser >

RegisterNewUser ( FPlatformUserId PlatformUserId,
bool bIsVirtual
)

 Register a new user with Slate.
Public function FDelegateHandle

RegisterOnWindowActionNotification ( const FOnWindowAction& Notification
)

 Register for a notification when the window action occurs.
Public function void 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"
Public function void Register another window that may be visible in a non-top level way that still needs to be able to maintain focus paths.
Public function void

ReleaseAllPointerCapture ( int32 UserIndex
)

 Releases capture for every pointer belonging to the given user index particular user.
Public function void Releases capture for every pointer on every user from whatever it currently is on.
Public function void Restores all input settings to their original values
Public function void Restores all pointer input settings to their original values
Public function FReply

RouteMouseWheelOrGestureEvent ( const FWidgetPath& WidgetsUnderPointer,
const FPointerEvent& InWheelEvent,
const FPointerEvent* InGestureEvent
)

 Directly routes a pointer mouse wheel or gesture event to the widgets in the specified widget path.
Public function FReply

RoutePointerDoubleClickEvent ( const FWidgetPath& WidgetsUnderPointer,
const FPointerEvent& PointerEvent
)

 Directly routes a pointer double click event to the widgets in the specified widget path
Public function FReply

RoutePointerDownEvent ( const FWidgetPath& WidgetsUnderPointer,
const FPointerEvent& PointerEvent
)

 Directly routes a pointer down event to the widgets in the specified widget path
Public function bool

RoutePointerMoveEvent ( const FWidgetPath& WidgetsUnderPointer,
const FPointerEvent& PointerEvent,
bool bIsSynthetic
)

 Directly routes a pointer move event to the widgets in the specified widget path
Public function FReply

RoutePointerUpEvent ( const FWidgetPath& WidgetsUnderPointer,
const FPointerEvent& PointerEvent
)

 Directly routes a pointer up event to the widgets in the specified widget path
Public function void

SetAllowTooltips ( bool bCanShow
)

  
Public function void

SetAllUserFocus ( const TSharedPtr< SWidget >& WidgetToFocus,
EFocusCause ReasonFocusIsChanging
)

 Sets focus for all users to the SWidget passed in.
Public function void

SetAllUserFocusToGameViewport ( EFocusCause ReasonFocusIsChanging
)

 Sets all users focus to the SWidget representing the currently active game viewport
Public function void

SetApplicationScale ( float InScale
)

  
Public function void

SetCursorRadius ( float NewRadius
)

 Sets the hit detection radius of the cursor
Public function void

SetDragTriggerDistance ( float ScreenPixels
)

 Set the size of the deadzone for dragging in screen pixels
Public function void

SetExitRequestedHandler ( const FSimpleDelegate& OnExitRequestedHandler
)

 Assign a delegate to be called when this application is requesting an exit (e.g. when the last window is closed).
Public function Static void

SetFixedDeltaTime ( double InSeconds
)

 Sets time step in seconds if a fixed delta time is wanted.
Public function void

SetGameIsFakingTouchEvents ( const bool bIsFaking,
FVector2D* CursorLocation
)

 Sets whether the application is treating mouse events as imitating touch events.
Public function void Mouse capture
Public function void Establishes the input mapping object used to map input sources to SlateUser indices
Public function bool

SetKeyboardFocus ( const TSharedPtr< SWidget >& OptionalWidgetToFocus,
EFocusCause ReasonFocusIsChanging
)

 Sets the Keyboard focus to the specified SWidget
Public function void

SetModalWindowStackEndedDelegate ( FModalWindowStackEnded StackEndedDelegate
)

 Sets the delegate for when a modal window stack ends
Public function void

SetModalWindowStackStartedDelegate ( FModalWindowStackStarted StackStartedDelegate
)

 Sets the delegate for when a modal window stack begins
Public function void Sets the navigation config.
Public function void

SetPlatformApplication ( const TSharedRef< class GenericApplication >& InPlatformApplication
)

  
Public function void

SetPlatformCursorVisibility ( bool bNewVisibility
)

 Changes the cursor type to Default (Visible) or None (Not Visible)
Public function void

SetUnhandledKeyDownEventHandler ( const FOnKeyEvent& NewHandler
)

 Sets the handler for otherwise unhandled key down events.
Public function void

SetUnhandledKeyUpEventHandler ( const FOnKeyEvent& NewHandler
)

 Sets the handler for otherwise unhandled key down events.
Protected function void Sets up any values that need to be based on the physical dimensions of the device.
Public function bool

SetUserFocus ( uint32 UserIndex,
const TSharedPtr< SWidget >& WidgetToFocus,
EFocusCause ReasonFocusIsChanging
)

 Sets specified user focus to the SWidget passed in.
Public function void

SetUserFocusToGameViewport ( uint32 UserIndex,
EFocusCause ReasonFocusIsChanging
)

 Sets specified user focus to the SWidget representing the currently active game viewport
Public function void

SetWidgetReflector ( const TSharedRef< IWidgetReflector >& WidgetReflector
)

 Sets the widget reflector.
Public function void

SetWidgetReflectorAssetAccessDelegate ( FAccessAsset AccessDelegate
)

  
Public function void

SetWidgetReflectorQuerySourceAccessDelegate ( FQueryAccessSourceCode QueryAccessDelegate
)

  
Public function void

SetWidgetReflectorSourceAccessDelegate ( FAccessSourceCode AccessDelegate
)

  
Public function void  
Public function void

ShowVirtualKeyboard ( bool bShow,
int32 UserIndex,
TSharedPtr< IVirtualKeyboardEntry > TextEntryWidget
)

 Shows or hides an onscreen keyboard
Public function Static void

Shutdown ( bool bShutdownPlatform
)

  
Public function void

SpawnToolTip ( const TSharedRef< IToolTip >& InToolTip,
const UE::Slate::FDeprecateVector2DParameter& InSpawnLocation
)

 Spawns a tool tip window. If an existing tool tip window is open, it will be dismissed first.
Public function Const bool  
Public function Const bool  
Public function bool

TakeHDRScreenshot ( const TSharedRef< SWidget >& Widget,
const FIntRect& InnerWidgetArea,
TArray< FLinearColor >& 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.
Public function bool

TakeHDRScreenshot ( const TSharedRef< SWidget >& Widget,
TArray< FLinearColor >& OutColorData,
FIntVector& OutSize
)

 Takes a screenshot of the widget writing the results into the color buffer provided.
Public function bool

TakeScreenshot ( const TSharedRef< SWidget >& Widget,
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.
Public function bool

TakeScreenshot ( const TSharedRef< SWidget >& Widget,
TArray< FColor >& OutColorData,
FIntVector& OutSize
)

 Takes a screenshot of the widget writing the results into the color buffer provided.
Protected function void Engages or disengages application throttling based on user behavior
Public function void

Tick ( ESlateTickType TickType
)

 Ticks this application
Protected function void

TickAndDrawWidgets ( float DeltaTime
)

 Ticks and paints the actual Slate portion of the application.
Protected function void

TickPlatform ( float DeltaTime
)

 Pumps and ticks the platform.
Protected function void Advances time for the application.
Protected function Const FPointerEvent

TransformPointerEvent ( const FPointerEvent& PointerEvent,
const TSharedPtr< SWindow >& Window
)

 Transforms a pointer event to account for non-standard viewport resolutions
Public function Const void Tries to dumps the current navigation config along with callstack used to set it.
Public function void Unregisters the current game viewport from Slate.
Public function void Removes an input pre-processor.
Public function void Unregister the notification because it is no longer desired.
Public function void

UnregisterUser ( int32 UserIndex
)

  
Public function void Unregister a virtual window.
Public function void

UpdateToolTip ( bool bAllowSpawningOfNewToolTips
)

  
Public function void

UsePlatformCursorForCursorUser ( bool bUsePlatformCursor
)

 Updates the cursor user's cursor to either the platform cursor or fake cursor

Overridden from FSlateApplicationBase

  Type Name Description
Public function Virtual TSharedRef< SWindow >

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.
Public function Virtual Const bool  
Public function Virtual void

ArrangeWindowToFrontVirtual ( TArray< TSharedRef< SWindow >>& Windows,
const TSharedRef< SWindow >& WindowToBringToFront
)

 Reorders an array of windows so the specified window is "brought to the front"
Public function Virtual Const UE::Slate::FDeprecateVector2DResult

CalculateTooltipWindowPosition ( const FSlateRect& InAnchorRect,
const UE::Slate::FDeprecateVector2DParameter& InSize,
bool bAutoAdjustForDPIScale
)

 Calculates the tooltip window position.
Protected function Virtual Const bool

DoesWidgetHaveMouseCapture ( const TSharedPtr< const SWidget > Widget
)

 Gets whether or not a particular widget has mouse capture.
Protected function Virtual Const bool

DoesWidgetHaveMouseCaptureByUser ( const TSharedPtr< const SWidget > Widget,
int32 UserIndex,
TOptional< int32 > PointerIndex
)

 Gets whether or not a particular widget has mouse capture by a user.
Public function Virtual bool

FindPathToWidget ( TSharedRef< const SWidget > InWidget,
FWidgetPath& OutWidgetPath,
EVisibility VisibilityFilter
)

 Searches for the specified widget and generates a full path to it.
Public function Virtual Const TSharedPtr< SWindow >

FindWidgetWindow ( TSharedRef< const SWidget > InWidget
)

 Finds the window that the provided widget resides in
Public function Virtual Const TSharedPtr< SWindow > Gets the active regular top-level window.
Public function Virtual Const TSharedPtr< SWindow > Gets the active top-level window.
Public function Virtual Const const FSlateBrush * Gets the global application icon.
Public function Virtual Const const FSlateBrush *  
Public function Virtual Const float Gets the ratio SlateUnit / ScreenPixel.
Public function Virtual Const TSharedPtr< SWidget >  
Public function Virtual Const const double Gets Slate's current cached real time.
Public function Virtual Const UE::Slate::FDeprecateVector2DResult Gets the current position of the cursor.
Public function Virtual Const UE::Slate::FDeprecateVector2DResult Gets the size of the cursor..
Public function Virtual Const TSharedPtr< SWidget > Gets the widget that currently has keyboard focus, if any.
Public function Virtual Const UE::Slate::FDeprecateVector2DResult Gets the last known position of the cursor.
Protected function Virtual Const TSharedPtr< SWidget > Implementation of GetMouseCaptor which can be overridden without warnings.
Public function Virtual Const EUINavigationAction

GetNavigationActionFromKey ( const FKeyEvent& InKeyEvent
)

 Returns the navigation action corresponding to a key event.
Public function Virtual EUINavigation Returns navigation direction matching an anlog event, this is determined in the FNavigationConfig
Public function Virtual Const EUINavigation Returns navigation direction matching a key event, this is determined in the FNavigationConfig
Public function Virtual Const FSlateRect Gets the rectangle of the current preferred work area.
Public function Virtual Const bool Whether the software cursor is enabled for this application.
Public function Virtual Const EVisibility Gets the desired visibility of the software cursor
Public function Virtual Const const TArray< TSharedRef< SWindow > > Get a list of all top-level windows in the application, excluding virtual windows.
Public function Virtual Const TSharedPtr< SWidget >

GetUserFocusedWidget ( uint32 UserIndex
)

  
Public function Virtual Const EWindowTransparency Get the highest level of window transparency support currently enabled by this application
Public function Virtual Const bool Gets whether or not a widget has captured the mouse.
Protected function Virtual Const TOptional< EFocusCause >

HasAnyUserFocus ( const TSharedPtr< const SWidget > Widget
)

 Gets whether or not a particular widget has any users focus, and if so the type of focus (first one found).
Public function Virtual Const bool

HasFocusedDescendants ( const TSharedRef< const SWidget >& Widget
)

 Checks whether the specified widget has any descendants which are currently focused.
Protected function Virtual Const TOptional< EFocusCause >

HasUserFocus ( const TSharedPtr< const SWidget > Widget,
int32 UserIndex
)

 Gets whether or not a particular widget has the specified users focus, and if so the type of focus.
Public function Virtual Const bool

HasUserFocusedDescendants ( const TSharedRef< const SWidget >& Widget,
int32 UserIndex
)

 Checks whether the specified widget has any descendants which are currently focused for the specified user user.
Public function Virtual Const bool

HasUserMouseCapture ( int32 UserIndex
)

 Gets whether or not a widget has captured the mouse for a particular user.
Public function Virtual Const bool Whether the application is active.
Public function Virtual bool Checks whether an UI for external services such as Steam is open.
Protected function Virtual Const bool

IsWidgetDirectlyHovered ( const TSharedPtr< const SWidget > Widget
)

 Gets whether or not a particular widget is directly hovered.
Public function Virtual Const bool

IsWindowHousingInteractiveTooltip ( const TSharedRef< const SWindow >& WindowToTest
)

  
Protected function Virtual Const FWidgetPath

LocateWidgetInWindow ( UE::Slate::FDeprecateVector2DParameter ScreenspaceMouseCoordinate,
const TSharedRef< SWindow >& Window,
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.
Public function Virtual Const TSharedRef< SImage >

MakeImage ( const TAttribute< const FSlateBrush* >& Image,
const TAttribute< FSlateColor >& Color,
const TAttribute< EVisibility >& Visibility
)

 Creates an image widget.
Public function Virtual TSharedRef< IToolTip >

MakeToolTip ( const FText& ToolTipText
)

 Creates a tool tip with the specified text.
Public function Virtual TSharedRef< IToolTip >

MakeToolTip ( const TAttribute< FText >& ToolTipText
)

 Creates a tool tip with the specified text.
Public function Virtual Const TSharedRef< SWidget > Creates a title bar for the specified window.
Public function Virtual void

RequestDestroyWindow ( TSharedRef< SWindow > WindowToDestroy
)

 Destroying windows has implications on some OSs (e.g. destroying Win32 HWNDs can cause events to be lost).
Public function Virtual 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.
Public function Virtual 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.
Public function Virtual bool

SetKeyboardFocus ( const FWidgetPath& InFocusPath,
const EFocusCause InCause
)

 Sets keyboard focus to the specified widget. The widget must be allowed to receive keyboard focus.
Public function Virtual 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.
Protected function Virtual Const bool

ShowUserFocus ( const TSharedPtr< const SWidget > Widget
)

 Gets whether or not a particular widget should show user focus.

Overridden from FGenericApplicationMessageHandler

  Type Name Description
Public function Virtual bool

BeginReshapingWindow ( const TSharedRef< FGenericWindow >& PlatformWindow
)

  
Public function Virtual void

FinishedReshapingWindow ( const TSharedRef< FGenericWindow >& PlatformWindow
)

  
Public function Virtual Const FWindowSizeLimits  
Public function Virtual EWindowZone::Type

GetWindowZoneForPoint ( const TSharedRef< FGenericWindow >& PlatformWindow,
const int32 X,
const int32 Y
)

  
Public function Virtual void  
Public function Virtual bool

OnApplicationActivationChanged ( const bool IsActive
)

  
Public function Virtual bool

OnControllerAnalog ( FGamepadKeyNames::Type KeyName,
FPlatformUserId PlatformUserId,
FInputDeviceId InputDeviceId,
float AnalogValue
)

  
Public function Virtual bool

OnControllerButtonPressed ( FGamepadKeyNames::Type KeyName,
FPlatformUserId PlatformUserId,
FInputDeviceId InputDeviceId,
bool IsRepeat
)

  
Public function Virtual bool

OnControllerButtonReleased ( FGamepadKeyNames::Type KeyName,
FPlatformUserId PlatformUserId,
FInputDeviceId InputDeviceId,
bool IsRepeat
)

  
Public function Virtual bool  
Public function Virtual bool  
Public function Virtual EDropEffect::Type

OnDragDrop ( const TSharedPtr< FGenericWindow >& Window
)

  
Public function Virtual EDropEffect::Type

OnDragEnterExternal ( const TSharedRef< FGenericWindow >& Window,
const FString& Text,
const TArray< FString >& Files
)

  
Public function Virtual EDropEffect::Type

OnDragEnterFiles ( const TSharedRef< FGenericWindow >& Window,
const TArray< FString >& Files
)

  
Public function Virtual EDropEffect::Type

OnDragEnterText ( const TSharedRef< FGenericWindow >& Window,
const FString& Text
)

  
Public function Virtual void

OnDragLeave ( const TSharedPtr< FGenericWindow >& Window
)

  
Public function Virtual EDropEffect::Type

OnDragOver ( const TSharedPtr< FGenericWindow >& Window
)

  
Public function Virtual void  
Public function Virtual bool

OnKeyChar ( const TCHAR Character,
const bool IsRepeat
)

  
Public function Virtual bool

OnKeyDown ( const int32 KeyCode,
const uint32 CharacterCode,
const bool IsRepeat
)

  
Public function Virtual bool

OnKeyUp ( const int32 KeyCode,
const uint32 CharacterCode,
const bool IsRepeat
)

  
Public function Virtual bool

OnMotionDetected ( const FVector& Tilt,
const FVector& RotationRate,
const FVector& Gravity,
const FVector& Acceleration,
FPlatformUserId PlatformUserId,
FInputDeviceId InputDeviceId
)

  
Public function Virtual bool

OnMouseDoubleClick ( const TSharedPtr< FGenericWindow >& PlatformWindow,
const EMouseButtons::Type Button,
const FVector2D CursorPos
)

  
Public function Virtual bool

OnMouseDoubleClick ( const TSharedPtr< FGenericWindow >& PlatformWindow,
const EMouseButtons::Type Button
)

  
Public function Virtual bool

OnMouseDown ( const TSharedPtr< FGenericWindow >& PlatformWindow,
const EMouseButtons::Type Button,
const FVector2D CursorPos
)

  
Public function Virtual bool

OnMouseDown ( const TSharedPtr< FGenericWindow >& PlatformWindow,
const EMouseButtons::Type Button
)

  
Public function Virtual bool  
Public function Virtual bool

OnMouseUp ( const EMouseButtons::Type Button,
const FVector2D CursorPos
)

  
Public function Virtual bool

OnMouseUp ( const EMouseButtons::Type Button
)

  
Public function Virtual bool

OnMouseWheel ( const float Delta,
const FVector2D CursorPos
)

  
Public function Virtual bool

OnMouseWheel ( const float Delta
)

  
Public function Virtual void

OnMovedWindow ( const TSharedRef< FGenericWindow >& PlatformWindow,
const int32 X,
const int32 Y
)

  
Public function Virtual void

OnOSPaint ( const TSharedRef< FGenericWindow >& PlatformWindow
)

  
Public function Virtual bool

OnRawMouseMove ( const int32 X,
const int32 Y
)

  
Public function Virtual void

OnResizingWindow ( const TSharedRef< FGenericWindow >& PlatformWindow
)

  
Public function Virtual bool

OnSizeChanged ( const TSharedRef< FGenericWindow >& PlatformWindow,
const int32 Width,
const int32 Height,
bool bWasMinimized
)

  
Public function Virtual bool

OnTouchEnded ( const FVector2D& Location,
int32 TouchIndex,
FPlatformUserId PlatformUserId,
FInputDeviceId DeviceID
)

  
Public function Virtual bool

OnTouchFirstMove ( const FVector2D& Location,
float Force,
int32 TouchIndex,
FPlatformUserId PlatformUserId,
FInputDeviceId DeviceID
)

  
Public function Virtual bool

OnTouchForceChanged ( const FVector2D& Location,
float Force,
int32 TouchIndex,
FPlatformUserId PlatformUserId,
FInputDeviceId DeviceID
)

  
Public function Virtual bool

OnTouchGesture ( EGestureEvent GestureType,
const FVector2D& Delta,
float WheelDelta,
bool bIsDirectionInvertedFromDevice
)

  
Public function Virtual bool

OnTouchMoved ( const FVector2D& Location,
float Force,
int32 TouchIndex,
FPlatformUserId PlatformUserId,
FInputDeviceId DeviceID
)

  
Public function Virtual bool

OnTouchStarted ( const TSharedPtr< FGenericWindow >& Window,
const FVector2D& Location,
float Force,
int32 TouchIndex,
FPlatformUserId PlatformUserId,
FInputDeviceId DeviceId
)

  
Public function Virtual bool

OnWindowAction ( const TSharedRef< FGenericWindow >& PlatformWindow,
const EWindowAction::Type InActionType
)

  
Public function Virtual bool

OnWindowActivationChanged ( const TSharedRef< FGenericWindow >& PlatformWindow,
const EWindowActivation ActivationType
)

  
Public function Virtual void

OnWindowClose ( const TSharedRef< FGenericWindow >& PlatformWindow
)

  
Public function Virtual void

SetCursorPos ( const FVector2D& MouseCoordinate
)

 Sets the position of the cursor.
Public function Virtual Const bool  
Public function Virtual void

ShouldSimulateGesture ( EGestureEvent Gesture,
bool bEnable
)

  
Public function Virtual void  

Classes

  Type Name Description
Public class FApplicationActivationStateChangedEvent    
Public class FOnApplicationMousePreInputButtonDownListener Gets a delegate that is invoked before the mouse input button down get process by slate widgets bubble system.  
Public class FOnApplicationPreInputKeyDownListener Gets a delegate that is invoked before the input key get process by slate widgets bubble system.  
Public class FOnModalLoopTickEvent Event type for when Slate is ticking during a modal dialog loop  
Public class FOnWindowBeingDestroyed Delegate called when a window is about to be destroyed  
Public class 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  
Public class FSlateLastUserInteractionTimeUpdateEvent    
Public class FSlateTickEvent Event before slate application ticks.  
Public class 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
FixedDeltaTime Constant delta time used on every Slate widget Tick if CVarSlateUseFixedDeltaTime is enabled.

Deprecated Functions

  Type Name Description
Public function void

EnableMenuAnimations ( const bool bEnableAnimations
)

 Enable Window Animations is no longer used and is a no-op so calling this function is no longer necessary.
Public function Const TSharedPtr< SWindow >

FindWidgetWindow ( TSharedRef< const SWidget > InWidget,
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
Public function void

ForEachUser ( TFunctionRef< void(FSlateUser*)> InPredicate,
bool bIncludeVirtualUsers
)

 ForEachUser now provides an FSlateUser& parameter to the lambda instead of an FSlateUser*
Public function Virtual Const EUINavigationAction

GetNavigationActionForKey ( const FKey& InKey
)

 GetNavigationActionForKey doesn't handle multiple users properly, use GetNavigationActionFromKey instead
Public function void ReleaseMouseCapture has been renamed to ReleaseAllPointerCapture()
Public function void

ReleaseMouseCaptureForUser ( int32 UserIndex
)

 ReleaseMouseCaptureForUser has been renamed to ReleaseAllPointerCapture(int32 UserIndex)
Public function void

SetAppIcon ( const FSlateBrush*const InAppIcon
)

 SetAppIcon has been deprecated. Set "AppIcon" in your applications style to override the icon
Public function void

SetNavigationConfigFactory ( TFunction< TSharedRef< FNavigationConfig >()> InNavigationConfigFactory
)

 Returning to a simpler method of registering navigation configs., is what you should use now. Note: You'll need to store per user state information yourself if you have any, like we do for repeats with the analog stick in FNavigationConfig::UserNavigationState, than Slate creating a new Navigation Config per user.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page