1. Epic GamesDeveloper
  3. FSlateApplicationBase

FSlateApplicationBase

Base class for Slate applications.

API > API/Runtime > API/Runtime/SlateCore > API/Runtime/SlateCore/Application

Inheritance Hierarchy

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

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

Constructors

  Type Name Description
Public function    

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function 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.
Protected function bool Used to determine if any active timer handles are ready to fire.
Public function Const bool  
Public function 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 Const UE::Slate::FDeprecateVector2DResult

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

 Calculates the tooltip window position.
Protected function Const bool

DoesWidgetHaveMouseCapture ( const TSharedPtr< const SWidget > Widget
)

 Gets whether or not a particular widget has mouse capture.
Protected function 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 bool

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

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

FindWidgetWindow ( TSharedRef< const SWidget > InWidget
)

 Returns the window the provided widget is contained in
Public function Static FSlateApplicationBase &

Get ()

 Returns the current instance of the application.
Public function Const TSharedRef< FSlateAccessibleMessageHandler > Accessor for the accessible message handler. One must always exist, even if it's never activated.
Public function Const TSharedPtr< SWindow > Gets the active regular top-level window.
Public function Const TSharedPtr< SWindow > Gets the active top-level window.
Public function Const const FSlateBrush * Gets the global application icon.
Public function Const const FSlateBrush *  
Public function Const float Gets the ratio SlateUnit / ScreenPixel.
Public function Const void

GetCachedDisplayMetrics ( FDisplayMetrics& OutDisplayMetrics
)

 Gets the application's cached display metrics.
Public function Const TSharedPtr< SWidget >  
Public function Const const double Gets Slate's current cached real time.
Public function Const UE::Slate::FDeprecateVector2DResult Gets the current position of the cursor.
Public function Const UE::Slate::FDeprecateVector2DResult Gets the size of the cursor..
Public function Const const FMargin &  
Public function void

GetDisplayMetrics ( FDisplayMetrics& OutDisplayMetrics
)

 Gets the application's display metrics.
Public function Const const FHitTesting &  
Public function Const TSharedPtr< SWidget > Gets the widget that currently has keyboard focus, if any.
Public function Const UE::Slate::FDeprecateVector2DResult Gets the last known position of the cursor.
Protected function Const TSharedPtr< SWidget > Implementation of GetMouseCaptor which can be overridden without warnings.
Public function Const EUINavigationAction

GetNavigationActionForKey ( const FKey& InKey
)

  
Public function Const EUINavigationAction

GetNavigationActionFromKey ( const FKeyEvent& InKeyEvent
)

  
Public function EUINavigation  
Public function Const EUINavigation  
Public function TSharedPtr< class GenericApplication >  
Public function Virtual Const const TSharedPtr< GenericApplication > Gets the platform application.
Public function TSharedPtr< ICursor >  
Public function Const FSlateRect Gets the rectangle of the current preferred work area.
Public function Const FSlateRenderer * Gets the renderer being used to draw this application.
Protected function void

GetSafeZoneRatio ( FMargin& SafeZoneRatio
)

  
Public function void  
Public function Const bool Whether the software cursor is enabled for this application.
Public function Const EVisibility Gets the desired visibility of the software cursor
Public function Const const TArray< TSharedRef< SWindow > > Get a list of all top-level windows in the application, excluding virtual windows.
Public function Const TSharedPtr< SWidget >

GetUserFocusedWidget ( uint32 UserIndex
)

  
Public function Const EWindowTransparency Get the highest level of window transparency support currently enabled by this application
Public function Const bool Gets whether or not a widget has captured the mouse.
Protected function 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 Const bool

HasFocusedDescendants ( const TSharedRef< const SWidget >& Widget
)

 Checks whether the specified widget has any descendants which are currently focused.
Protected function 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 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 Const bool

HasUserMouseCapture ( int32 UserIndex
)

 Gets whether or not a widget has captured the mouse for a particular user.
Public function Const void

InvalidateAllWidgets ( bool bClearResourcesImmediately
)

 Notifies all invalidation panels that they should invalidate their contents Note: this is a very expensive call and should only be done in non-performance critical situations
Public function Const bool Whether the application is active.
Public function Const bool  
Public function bool Checks whether an UI for external services such as Steam is open.
Public function Static bool Returns true if a Slate application instance is currently initialized and ready
Public function bool Is Slate currently sleeping or not.
Protected function Const bool

IsWidgetDirectlyHovered ( const TSharedPtr< const SWidget > Widget
)

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

IsWindowHousingInteractiveTooltip ( const TSharedRef< const SWindow >& WindowToTest
)

  
Protected function 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 FWidgetPath

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

 Given the screen-space coordinate of the mouse cursor, searches for a string of widgets that are under the mouse.
Public function Const TSharedRef< SImage >

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

 Creates an image widget.
Public function TSharedRef< IToolTip >

MakeToolTip ( const FText& ToolTipText
)

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

MakeToolTip ( const TAttribute< FText >& ToolTipText
)

 Creates a tool tip with the specified text.
Public function Const TSharedRef< SWidget > Creates a title bar for the specified window.
Public function FOnGlobalInvalidationToggled &  
Public function FOnInvalidateAllWidgets &  
Public function 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 void  
Public function 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 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 void

SetCustomSafeZone ( const FMargin& InSafeZone
)

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

ShowUserFocus ( const TSharedPtr< const SWidget > Widget
)

 Gets whether or not a particular widget should show user focus.
Protected function void  
Public function void

ToggleGlobalInvalidation ( bool bIsGlobalInvalidationEnabled
)

  
Protected function void

UpdateCustomSafeZone ( const FMargin& NewSafeZoneRatio,
bool bShouldRecacheMetrics
)

  

Classes

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

Enums

  Type Name Description
Protected enum ECustomSafeZoneState    

Constants

Name Description
CurrentBaseApplication Holds a pointer to the current application.
CursorPointerIndex  
CursorUserIndex  
PlatformApplication Holds a pointer to the platform application.
SlateAppPrimaryPlatformUser The primary platform user for this application.

Deprecated Functions

  Type Name Description
Public function Virtual Const TSharedRef< SWidget >

MakeWindowTitleBar ( const TSharedRef< SWindow >& Window,
const TSharedPtr< SWidget >& CenterContent,
EHorizontalAlignment CenterContentAlignment,
TSharedPtr< IWindowTitleBar >& OutTitleBar
)

 This version of MakeWindowTitleBar has been deprecated. Use the version that takes in an FWindowTitleBarArgs parameter instead.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page