Navigation
API > API/Runtime > API/Runtime/Slate
| Name | FSlateApplication |
| Type | class |
| Header File | /Engine/Source/Runtime/Slate/Public/Framework/Application/SlateApplication.h |
| Include Path | #include "Framework/Application/SlateApplication.h" |
Syntax
class FSlateApplication :
public FSlateApplicationBase ,
public FGenericApplicationMessageHandler
Inheritance Hierarchy
- FGenericApplicationMessageHandler → FSlateApplication
- FSlateApplicationBase → FSlateApplication
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FSlateApplication() |
Framework/Application/SlateApplication.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~FSlateApplication() |
Virtual destructor. | Framework/Application/SlateApplication.h |
Classes
| Name | Remarks |
|---|---|
| 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. |
Structs
| Name | Remarks |
|---|---|
| FScopedPreventDebuggingMode |
Interfaces
| Name | Remarks |
|---|---|
| InputPreProcessorsHelper | A helper class to wrap the list of input pre-processors. |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FOnFocusChanging | TMulticastDelegate_FiveParams< void, const FFocusEvent &, const FWeakWidgetPath &, const TSharedPtr< SWidget > &, const FWidgetPath &, const TSharedPtr< SWidget > & > | Delegate called just before possible focus change | Framework/Application/SlateApplication.h |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| CurrentApplication | TSharedPtr< FSlateApplication > | Application singleton | Framework/Application/SlateApplication.h |
| FixedDeltaTime | double | Constant delta time used on every Slate widget Tick if CVarSlateUseFixedDeltaTime is enabled. | Framework/Application/SlateApplication.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| OnApplicationActivationStateChanged | FSlateApplication::FOnModalLoopTickEvent & | Framework/Application/SlateApplication.h | ||
| OnDragDropCheckOverride | FDragDropCheckingOverride | Framework/Application/SlateApplication.h |
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| ActiveModalWindows | TArray< TSharedPtr< SWindow > > | List of active modal windows. The last item in the list is the top-most modal window | Framework/Application/SlateApplication.h | |
| ActiveTopLevelWindow | TWeakPtr< SWindow > | The currently active slate window that is a top-level window (full fledged window; not a menu or tooltip) | Framework/Application/SlateApplication.h | |
| AllGameViewports | TSet< TWeakPtr< SViewport > > | List of all registered game viewports since the last time UnregisterGameViewport was called. | Framework/Application/SlateApplication.h | |
| AppIcon | const FSlateBrush * | The icon to use on application windows | Framework/Application/SlateApplication.h | |
| ApplicationActivationStateChangedEvent | FApplicationActivationStateChangedEvent | Framework/Application/SlateApplication.h | ||
| AssetAccessDelegate | FAccessAsset | Delegate for accessing assets, to pass to any widget inspectors. | Framework/Application/SlateApplication.h | |
| AverageDeltaTime | float | Running average time in seconds between calls to Tick (used for monitoring responsiveness) | Framework/Application/SlateApplication.h | |
| AverageDeltaTimeForResponsiveness | float | Average delta time for application responsiveness tracking. | Framework/Application/SlateApplication.h | |
| bAllowFakingTouch | bool | Restricts or allows the faking of touches. | Framework/Application/SlateApplication.h | |
| bAppIsActive | bool | True when the slate app is active; i.e. the current foreground window is from our Slate app | Framework/Application/SlateApplication.h | |
| bDisableLastDragOnDragEnter | bool | Are we disabling the last drag on a new drag enter event to prevent double drag conflicts? | Framework/Application/SlateApplication.h | |
| bHandleDeviceInputWhenApplicationNotActive | bool | Force Mouse Pointer Capture to always occur even when the application is not active or widget is not a virtual window | Framework/Application/SlateApplication.h | |
| bIsExternalUIOpened | bool | Keeps track of whether or not the UI for services such as Steam is open. | Framework/Application/SlateApplication.h | |
| bIsFakingTouch | bool | For desktop platforms that want to test touch style input, pass -faketouches or -simmobile on the commandline to set this | Framework/Application/SlateApplication.h | |
| bIsFakingTouched | bool | For desktop platforms that the touch move event be called when this variable is true | Framework/Application/SlateApplication.h | |
| bIsGameFakingTouch | bool | For games that want to allow mouse to imitate touch | Framework/Application/SlateApplication.h | |
| bIsTicking | bool | Are we ticking the SlateApplication. | Framework/Application/SlateApplication.h | |
| bLeaveDebugForSingleStep | bool | Whether or not we need to leave debug mode for single stepping | Framework/Application/SlateApplication.h | |
| bMenuAnimationsEnabled | bool | Slate look and feel Globally enables or disables transition effects for pop-up menus (menu stacks) | Framework/Application/SlateApplication.h | |
| bRenderOffScreen | bool | True if rendering windows even when they are set to invisible | Framework/Application/SlateApplication.h | |
| bRequestLeaveDebugMode | bool | Whether or not we are requesting that we leave debugging mode after the tick is complete | Framework/Application/SlateApplication.h | |
| bSlateWindowActive | bool | True if any slate window is currently active (not just top level windows) | Framework/Application/SlateApplication.h | |
| bSoftwareCursorAvailable | bool | .ini controlled option to allow or disallow software cursor rendering | Framework/Application/SlateApplication.h | |
| bSynthesizedCursorMove | bool | Did we synthesize cursor input this frame? | Framework/Application/SlateApplication.h | |
| bTouchFallbackToMouse | bool | Controls whether unhandled touch events fall back to sending mouse events | Framework/Application/SlateApplication.h | |
| CurrentDebugContextWidget | TWeakPtr< SWidget > | The painting SWindow. | Framework/Application/SlateApplication.h | |
| CurrentDebuggingWindow | TWeakPtr< SWindow > | Framework/Application/SlateApplication.h | ||
| CurrentTime | double | The current cached absolute real time, right before we tick widgets | Framework/Application/SlateApplication.h | |
| CursorRadius | float | The hit-test radius of the cursor. Default value is 0. | Framework/Application/SlateApplication.h | |
| DebuggingModeNotificationMessage | TWeakPtr< SNotificationItem > | The message when the EnterDebugginMode failed. | Framework/Application/SlateApplication.h | |
| DragIsHandled | bool | When an drag and drop is happening, we keep track of whether slate knew what to do with the payload on last mouse move | Framework/Application/SlateApplication.h | |
| DragTriggerDistance | float | The dead zone distance in virtual desktop pixels (a.k.a screen pixels) that the user has to move their finder before it is considered a drag. | Framework/Application/SlateApplication.h | |
| DrawId | uint32 | The current DrawId. Value changes whenever we do a new pass | Framework/Application/SlateApplication.h | |
| EditorNavigationConfig | TSharedRef< FNavigationConfig > | When PIE runs, the game's navigation config will overwrite the editor's navigation config. | Framework/Application/SlateApplication.h | |
| FocusChangingDelegate | FOnFocusChanging | Delegate for when focus might be about to change | Framework/Application/SlateApplication.h | |
| GameViewportWidget | TWeakPtr< SViewport > | Pointer to the currently registered game viewport widget if any | Framework/Application/SlateApplication.h | |
| InputManager | TSharedRef< ISlateInputManager > | Allows applications finer control over how we map controllers to users. | Framework/Application/SlateApplication.h | |
| InputPreProcessors | InputPreProcessorsHelper | A list of input pre-processors, gets an opportunity to parse input before anything else. | Framework/Application/SlateApplication.h | |
| LastAllUsersFocusCause | EFocusCause | Framework/Application/SlateApplication.h | ||
| LastAllUsersFocusWidget | TWeakPtr< SWidget > | Last widget that was set for 'all users' focus and the cause. | Framework/Application/SlateApplication.h | |
| LastMouseMoveTime | double | Used when considering whether to put Slate to sleep | Framework/Application/SlateApplication.h | |
| LastPlatformCursorPosition | FVector2f | The location of the cursor the last time OnMouseMove was called | Framework/Application/SlateApplication.h | |
| LastTickTime | double | Last absolute real time that we ticked | Framework/Application/SlateApplication.h | |
| LastUserInteractionTime | double | The last real time that the user pressed a key or mouse button | Framework/Application/SlateApplication.h | |
| LastUserInteractionTimeForThrottling | double | Subset of LastUserInteractionTime that is used only when considering when to throttle | Framework/Application/SlateApplication.h | |
| LastUserInteractionTimeUpdateEvent | FSlateLastUserInteractionTimeUpdateEvent | Delegate that gets called for LastUserInteractionTime Update | Framework/Application/SlateApplication.h | |
| MenuBeingDestroyedEvent | FOnMenuDestroyed | Delegate for a when a menu has been dismissed | Framework/Application/SlateApplication.h | |
| MenuStack | FMenuStack | The stack of menus that are open | Framework/Application/SlateApplication.h | |
| ModalLoopTickEvent | FOnModalLoopTickEvent | Delegate for slate Tick during modal dialogs | Framework/Application/SlateApplication.h | |
| ModalWindowStackEndedDelegate | FModalWindowStackEnded | Framework/Application/SlateApplication.h | ||
| ModalWindowStackStartedDelegate | FModalWindowStackStarted | Modal Windows Delegates for when modal windows open or close | Framework/Application/SlateApplication.h | |
| MouseButtonDownResponsivnessThrottle | FThrottleRequest | Application throttling Holds a current request to ensure Slate is responsive in low FPS situations, based in mouse button pressed state | Framework/Application/SlateApplication.h | |
| NavigationConfig | TSharedRef< FNavigationConfig > | Framework/Application/SlateApplication.h | ||
| NormalExecutionGetter | TAttribute< bool > | Framework/Application/SlateApplication.h | ||
| NumExternalModalWindowsActive | int32 | Allows us to track the number of non-slate modal windows active. | Framework/Application/SlateApplication.h | |
| OnApplicationMousePreInputButtonDownListenerEvent | FOnApplicationMousePreInputButtonDownListener | Delegate that is invoked before the mouse input button get process by slate widgets bubble system. | Framework/Application/SlateApplication.h | |
| OnApplicationPreInputKeyDownListenerEvent | FOnApplicationPreInputKeyDownListener | Delegate that is invoked before the input key get process by slate widgets bubble system. | Framework/Application/SlateApplication.h | |
| OnExitRequested | FSimpleDelegate | Provides a platform-agnostic method for requesting that the application exit. | Framework/Application/SlateApplication.h | |
| OnSignalSystemDPIChangedEvent | FOnWindowDPIScaleChanged | Called before the dpi scale of a particular window is about to changed | Framework/Application/SlateApplication.h | |
| OnWindowActionNotifications | TArray< FOnWindowAction > | List of delegates that need to be called when the window action occurs. | Framework/Application/SlateApplication.h | |
| OnWindowDPIScaleChangedEvent | FOnWindowDPIScaleChanged | Called when an editor window dpi scale is changed | Framework/Application/SlateApplication.h | |
| PlatformMouseMovementEvents | uint64 | Platform mouse movement event count. | Framework/Application/SlateApplication.h | |
| PopupSupport | FPopupSupport | Support for auto-dismissing pop-ups | Framework/Application/SlateApplication.h | |
| PostTickEvent | FSlateTickEvent | Delegate for post slate Tick | Framework/Application/SlateApplication.h | |
| PreShutdownEvent | FSimpleMulticastDelegate | Delegate for pre shutdown | Framework/Application/SlateApplication.h | |
| PressedMouseButtons | TSet< FKey > | Framework/Application/SlateApplication.h | ||
| PreTickEvent | FSlateTickEvent | Delegate for pre slate tick | Framework/Application/SlateApplication.h | |
| PreventDebuggingModeStack | TArray< TPair< FText, int32 > > | List of reason why we can't enter in debugging mode. | Framework/Application/SlateApplication.h | |
| ProcessingInput | int32 | Are we currently processing input in slate? If so this value will be greater than 0. | Framework/Application/SlateApplication.h | |
| QuerySourceCodeAccessDelegate | FQueryAccessSourceCode | Delegate for querying if source code access is available | Framework/Application/SlateApplication.h | |
| RootStyleNode | const FStyleNode * | The top of the Style tree. | Framework/Application/SlateApplication.h | |
| Scale | float | Application-wide scale for supporting monitors of varying pixel density | Framework/Application/SlateApplication.h | |
| SimulateGestures | TBitArray< FDefaultBitArrayAllocator > | The simulated gestures Slate Application will be in charge of. | Framework/Application/SlateApplication.h | |
| SlateSoundDevice | TSharedPtr< ISlateSoundDevice > | Framework/Application/SlateApplication.h | ||
| SlateTextField | TUniquePtr< IPlatformTextField > | Virtual keyboard text field | Framework/Application/SlateApplication.h | |
| SlateTickCriticalSection | FCriticalSection | Critical section to avoid multiple threads calling Slate Tick when we're synchronizing between the Slate Loading Thread and the Game Thread. | Framework/Application/SlateApplication.h | |
| SlateVirtualWindows | TArray< TSharedRef< SWindow > > | All the virtual windows, which can be anywhere - likely inside the virtual world. | Framework/Application/SlateApplication.h | |
| SlateWindows | TArray< TSharedRef< SWindow > > | All the top-level windows owned by this application; they are tracked here in a platform-agnostic way. | Framework/Application/SlateApplication.h | |
| SourceCodeAccessDelegate | FAccessSourceCode | Delegate for accessing source code, to pass to any widget inspectors. | Framework/Application/SlateApplication.h | |
| ThrottleHandle | FThrottleRequest | Handle to a throttle request made to ensure the window is responsive in low FPS situations | Framework/Application/SlateApplication.h | |
| UnhandledKeyDownEventHandler | FOnKeyEvent | Delegate for when a key down event occurred but was not handled in any other way by ProcessKeyDownMessage | Framework/Application/SlateApplication.h | |
| UnhandledKeyUpEventHandler | FOnKeyEvent | Delegate for when a key down event occurred but was not handled in any other way by ProcessKeyDownMessage | Framework/Application/SlateApplication.h | |
| UserInteractionResponsivnessThrottle | FThrottleRequest | Separate throttle handle that engages automatically based on mouse movement and other user behavior | Framework/Application/SlateApplication.h | |
| UserRegisteredEvent | FUserRegisteredEvent | Delegate for when a new user has been registered. | Framework/Application/SlateApplication.h | |
| Users | TArray< TSharedPtr< FSlateUser > > | All users currently registered with Slate. | Framework/Application/SlateApplication.h | |
| VirtualDesktopRect | FSlateRect | Hittest 2.0 The rectangle that bounds all the physical monitors given their arrangement. | Framework/Application/SlateApplication.h | |
| VirtualUsers | TArray< TWeakPtr< FSlateVirtualUserHandle > > | Weak pointers to the allocated virtual users. | Framework/Application/SlateApplication.h | |
| WidgetReflectorPtr | TWeakPtr< IWidgetReflector > | A Widget that introspects the current UI hierarchy | Framework/Application/SlateApplication.h | |
| WindowBeingDestroyedEvent | FOnWindowBeingDestroyed | Delegate for when a window is in the process of being destroyed | Framework/Application/SlateApplication.h | |
| WindowDestroyQueue | TArray< TSharedRef< SWindow > > | These windows will be destroyed next tick. | Framework/Application/SlateApplication.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void ActivateGameViewport() |
Activates the Game Viewport if it is properly childed under a window | Framework/Application/SlateApplication.h | |
void AddModalWindow
(
TSharedRef< SWindow > InSlateWindow, |
Adds a modal window to the application. | Framework/Application/SlateApplication.h | |
TSharedRef< SWindow > AddWindowAsNativeChild
(
TSharedRef< SWindow > InSlateWindow, |
Associates a top level Slate Window with a native window, and "natively" parents that window to the specified Slate window. | Framework/Application/SlateApplication.h | |
bool AllowMoveCursor() |
Framework/Application/SlateApplication.h | ||
bool AreMenuAnimationsEnabled() |
Framework/Application/SlateApplication.h | ||
virtual UE::Slate::FDeprecateVector2DResult CalculatePopupWindowPosition
(
const FSlateRect& InAnchor, |
Calculates the popup window position from the passed in window position and size. | Framework/Application/SlateApplication.h | |
bool CanAddModalWindow() |
Returns true if this slate application is ready to open modal windows | Framework/Application/SlateApplication.h | |
void CancelDragDrop() |
Cancels any in flight drag and drops | Framework/Application/SlateApplication.h | |
bool CanDisplayWindows() |
Returns true if this slate application is ready to display windows. | Framework/Application/SlateApplication.h | |
void ClearAllUserFocus
(
EFocusCause ReasonFocusIsChanging |
Releases the focus for all users from whatever it currently is on. | Framework/Application/SlateApplication.h | |
void ClearKeyboardFocus
(
const EFocusCause ReasonFocusIsChanging |
Clears keyboard focus, if any widget is currently focused | Framework/Application/SlateApplication.h | |
void ClearUserFocus
(
uint32 UserIndex, |
Releases the users focus from whatever it currently is on. | Framework/Application/SlateApplication.h | |
void CloseAllWindowsImmediately() |
Closes all active windows immediately | Framework/Application/SlateApplication.h | |
void CloseToolTip() |
Closes the open tool-tip, if a tool-tip is open | Framework/Application/SlateApplication.h | |
void DestroyWindowImmediately
(
TSharedRef< SWindow > WindowToDestroy |
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 | Framework/Application/SlateApplication.h | |
void DestroyWindowsImmediately() |
Destroy the native and slate windows in the array provided. | Framework/Application/SlateApplication.h | |
void DismissAllMenus() |
Dismisses all open menus | Framework/Application/SlateApplication.h | |
void DismissMenu
(
const TSharedPtr< IMenu >& InFromMenu |
Dismisses a menu and all its children | Framework/Application/SlateApplication.h | |
void DismissMenuByWidget
(
const TSharedRef< SWidget >& InWidgetInMenu |
Dismisses a menu and all its children. | Framework/Application/SlateApplication.h | |
void EnableMenuAnimations
(
const bool bEnableAnimations |
Sets whether transition effects for new menus and windows should be played. | Framework/Application/SlateApplication.h | |
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 | Framework/Application/SlateApplication.h | |
void ExternalModalStart () |
Disable Slate components when an external, non-slate, modal window is brought up. | Framework/Application/SlateApplication.h | |
void ExternalModalStop () |
Re-enable disabled Slate components when a non-slate modal window is dismissed. | Framework/Application/SlateApplication.h | |
void ExternalUIChange
(
bool bIsOpening |
Sets the display state of external UI such as Steam. | Framework/Application/SlateApplication.h | |
TSharedPtr< SWindow > FindBestParentWindowForDialogs
(
const TSharedPtr< SWidget >& InWidget, |
Given an optional widget, try and get the most suitable parent window to use with dialogs (such as file and directory pickers). | Framework/Application/SlateApplication.h | |
const void * FindBestParentWindowHandleForDialogs
(
const TSharedPtr< SWidget >& InWidget, |
Given an optional widget, try and get the most suitable parent window handle to use with dialogs (such as file and directory pickers). | Framework/Application/SlateApplication.h | |
int32 FindInputPreProcessor
(
TSharedPtr< class IInputProcessor > InputProcessor, |
Get the index of a registered pre-processor. | Framework/Application/SlateApplication.h | |
int32 FindInputPreProcessor
(
TSharedPtr< class IInputProcessor > InputProcessor |
Get the index of a registered pre-processor. | Framework/Application/SlateApplication.h | |
TSharedPtr< IMenu > FindMenuInWidgetPath
(
const FWidgetPath& InWidgetPath |
Attempt to locate a menu that contains the specified widget | Framework/Application/SlateApplication.h | |
TSharedRef< FSlateVirtualUserHandle > FindOrCreateVirtualUser
(
int32 VirtualUserIndex |
Framework/Application/SlateApplication.h | ||
TSharedPtr< SWindow > FindWidgetWindow
(
TSharedRef< const SWidget > InWidget, |
Finds the window that the provided widget resides in | Framework/Application/SlateApplication.h | |
void FinishedInputThisFrame() |
Occurs before Tick(), after all pointer and keyboard input has been processed. | Framework/Application/SlateApplication.h | |
void FlushRenderState() |
Flushes the render state of slate, releasing accesses and flushing all render commands. | Framework/Application/SlateApplication.h | |
void ForceRedrawWindow
(
const TSharedRef< SWindow >& InWindowToDraw |
Forces the window to redraw immediately. | Framework/Application/SlateApplication.h | |
void ForEachUser
(
TFunctionRef< void(FSlateUser*)> InPredicate, |
Framework/Application/SlateApplication.h | ||
void ForEachUser
(
TFunctionRef< void(FSlateUser&)> InPredicate, |
Allows you do some operations for every registered user. | Framework/Application/SlateApplication.h | |
void GeneratePathToWidgetChecked
(
TSharedRef< const SWidget > InWidget, |
Framework/Application/SlateApplication.h | ||
bool GeneratePathToWidgetUnchecked
(
TSharedRef< const SWidget > InWidget, |
Framework/Application/SlateApplication.h | ||
TSharedPtr< SWindow > GetActiveModalWindow() |
Framework/Application/SlateApplication.h | ||
bool GetAllowTooltips() |
Framework/Application/SlateApplication.h | ||
void GetAllVisibleWindowsOrdered
(
TArray< TSharedRef< SWindow > >& OutWindows |
Gets all visible slate windows ordered from back to front based on child hierarchies | Framework/Application/SlateApplication.h | |
const float GetAverageDeltaTime() |
Returns the running average delta time (smoothed over several frames) | Framework/Application/SlateApplication.h | |
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. | Framework/Application/SlateApplication.h | |
uint32 GetCurrentDrawId() |
Framework/Application/SlateApplication.h | ||
float GetCursorRadius() |
Getter for the cursor radius | Framework/Application/SlateApplication.h | |
| Framework/Application/SlateApplication.h | |||
TSharedPtr< const FSlateUser > GetCursorUser () |
Get the standard 'default' user (there's always guaranteed to be at least one). | Framework/Application/SlateApplication.h | |
const float GetDeltaTime() |
Returns the real time delta since Slate last ticked widgets | Framework/Application/SlateApplication.h | |
TSharedPtr< class FDragDropOperation > GetDragDroppingContent() |
Get the current drag-dropping content | Framework/Application/SlateApplication.h | |
float GetDragTriggerDistance() |
Framework/Application/SlateApplication.h | ||
float GetDragTriggerDistanceSquared() |
Framework/Application/SlateApplication.h | ||
TSharedPtr< SViewport > GetGameViewport() |
Returns the game viewport registered with the slate application | Framework/Application/SlateApplication.h | |
bool GetHandleDeviceInputWhenApplicationNotActive() |
Framework/Application/SlateApplication.h | ||
virtual void GetInitialDisplayMetrics
(
FDisplayMetrics& OutDisplayMetrics |
Framework/Application/SlateApplication.h | ||
FInputDeviceId GetInputDeviceIdForKeyboard() |
Framework/Application/SlateApplication.h | ||
FInputDeviceId GetInputDeviceIdForMouse() |
Framework/Application/SlateApplication.h | ||
IInputInterface * GetInputInterface() |
Framework/Application/SlateApplication.h | ||
TArray< TSharedRef< SWindow > > GetInteractiveTopLevelWindows() |
Framework/Application/SlateApplication.h | ||
double GetLastUserInteractionTime() |
Framework/Application/SlateApplication.h | ||
FSlateLastUserInteractionTimeUpdateEvent & GetLastUserInteractionTimeUpdateEvent() |
Framework/Application/SlateApplication.h | ||
TSharedPtr< SWidget > GetMenuHostWidget() |
Framework/Application/SlateApplication.h | ||
FModifierKeysState GetModifierKeys() |
Returns the current modifier keys state | Framework/Application/SlateApplication.h | |
virtual void * GetMouseCaptureWindow() |
Returning platform-specific value designating window that captures mouse, or nullptr if mouse isn't captured | Framework/Application/SlateApplication.h | |
TSharedRef< FNavigationConfig > GetNavigationConfig() |
Framework/Application/SlateApplication.h | ||
const TAttribute< bool > & 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 | Framework/Application/SlateApplication.h | |
| Get the FOnModalLoopTickEvent for the Slate Application. | Framework/Application/SlateApplication.h | ||
FPopupSupport & GetPopupSupport() |
Framework/Application/SlateApplication.h | ||
const TSet< FKey > & GetPressedMouseButtons() |
Framework/Application/SlateApplication.h | ||
const FStyleNode * GetRootStyle() |
Framework/Application/SlateApplication.h | ||
float GetSoundDuration
(
const FSlateSound& Sound |
Framework/Application/SlateApplication.h | ||
ITextInputMethodSystem * GetTextInputMethodSystem() |
Framework/Application/SlateApplication.h | ||
bool GetTransformFullscreenMouseInput() |
True if transforming mouse input coordinates to account for fullscreen distortions | Framework/Application/SlateApplication.h | |
TSharedPtr< FSlateUser > GetUser
(
const FInputEvent& InputEvent |
Framework/Application/SlateApplication.h | ||
TSharedPtr< const FSlateUser > GetUser
(
const FInputEvent& InputEvent |
Framework/Application/SlateApplication.h | ||
TSharedPtr< FSlateUser > GetUser
(
FPlatformUserId PlatformUser |
Framework/Application/SlateApplication.h | ||
TSharedPtr< FSlateUser > GetUser
(
int32 UserIndex |
Framework/Application/SlateApplication.h | ||
TSharedPtr< const FSlateUser > GetUser
(
int32 UserIndex |
Gets the user at the given index, null if the user does not exist. | Framework/Application/SlateApplication.h | |
TSharedPtr< FSlateUser > GetUserFromControllerId
(
int32 ControllerId |
Framework/Application/SlateApplication.h | ||
TSharedPtr< const FSlateUser > GetUserFromControllerId
(
int32 ControllerId |
Framework/Application/SlateApplication.h | ||
TSharedPtr< FSlateUser > GetUserFromPlatformUser
(
FPlatformUserId PlatformUser |
Framework/Application/SlateApplication.h | ||
TSharedPtr< const FSlateUser > GetUserFromPlatformUser
(
FPlatformUserId PlatformUser |
Framework/Application/SlateApplication.h | ||
TOptional< int32 > GetUserIndexForController
(
int32 ControllerId, |
Framework/Application/SlateApplication.h | ||
int32 GetUserIndexForController
(
int32 ControllerId |
Framework/Application/SlateApplication.h | ||
TOptional< int32 > GetUserIndexForInputDevice
(
FInputDeviceId InputDeviceId |
Framework/Application/SlateApplication.h | ||
int32 GetUserIndexForKeyboard() |
Framework/Application/SlateApplication.h | ||
int32 GetUserIndexForMouse() |
Framework/Application/SlateApplication.h | ||
TOptional< int32 > GetUserIndexForPlatformUser
(
FPlatformUserId PlatformUser |
Framework/Application/SlateApplication.h | ||
TSharedPtr< SWindow > GetVisibleMenuWindow() |
Framework/Application/SlateApplication.h | ||
FSlateRect GetWorkArea
(
const FSlateRect& InRect |
Get the work area that has the largest intersection with the specified rectangle | Framework/Application/SlateApplication.h | |
void GotoLineInSource
(
const FString& FileName, |
Opens the current platform's code editing IDE (if necessary) and focuses the specified line in the specified file. | Framework/Application/SlateApplication.h | |
bool HasOpenSubMenus
(
TSharedPtr< IMenu > InMenu |
Framework/Application/SlateApplication.h | ||
bool HasTraveledFarEnoughToTriggerDrag
(
const FPointerEvent& PointerEvent, |
Framework/Application/SlateApplication.h | ||
bool HasTraveledFarEnoughToTriggerDrag
(
const FPointerEvent& PointerEvent, |
Framework/Application/SlateApplication.h | ||
virtual bool InitializeRenderer
(
TSharedRef< FSlateRenderer > InRenderer, |
Initializes the renderer responsible for drawing all elements in this application | Framework/Application/SlateApplication.h | |
virtual void InitializeSound
(
const TSharedRef< ISlateSoundDevice >& InSlateSoundDevice |
Set the slate sound provider that the slate app should use. | Framework/Application/SlateApplication.h | |
bool InKismetDebuggingMode() |
Framework/Application/SlateApplication.h | ||
void InvalidateAllViewports () |
Removes references to FViewportRHI's. | Framework/Application/SlateApplication.h | |
bool IsDragDropping() |
Are we drag-dropping right now? | Framework/Application/SlateApplication.h | |
bool IsDragDroppingAffected
(
const FPointerEvent& InPointerEvent |
Are we drag-dropping and are we affected by this pointer event? | Framework/Application/SlateApplication.h | |
bool IsFakingTouchEvents() |
Framework/Application/SlateApplication.h | ||
bool IsGamepadAttached() |
Framework/Application/SlateApplication.h | ||
bool IsLastDragOnDragEnterDisabled() |
Framework/Application/SlateApplication.h | ||
bool IsMouseAttached() |
Framework/Application/SlateApplication.h | ||
bool IsNormalExecution() |
Framework/Application/SlateApplication.h | ||
bool IsProcessingInput() |
Returns true if the we're currently processing mouse, keyboard, touch or gamepad input. | Framework/Application/SlateApplication.h | |
bool IsRenderingOffScreen() |
Framework/Application/SlateApplication.h | ||
bool IsRunningAtTargetFrameRate() |
Framework/Application/SlateApplication.h | ||
bool IsTicking() |
Returns true if we are currently ticking the SlateApplication. | Framework/Application/SlateApplication.h | |
bool IsUsingHighPrecisionMouseMovment() |
Framework/Application/SlateApplication.h | ||
bool IsUsingTrackpad() |
Framework/Application/SlateApplication.h | ||
bool IsWindowInDestroyQueue
(
TSharedRef< SWindow > Window |
Is the window in the app's destroy queue? If so it will be destroyed next tick. | Framework/Application/SlateApplication.h | |
void LeaveDebuggingMode
(
bool bLeavingDebugForSingleStep |
Leaves debugging mode | Framework/Application/SlateApplication.h | |
virtual void NativeApp_ShowKeyboard
(
bool bShow, |
Shows or hides an onscreen keyboard | Framework/Application/SlateApplication.h | |
EUINavigation NavigateFromWidget
(
const uint32 InUserIndex, |
Attempts to navigate to a neighboring widget by searching the given directions | Framework/Application/SlateApplication.h | |
void NavigateFromWidgetUnderCursor
(
const uint32 InUserIndex, |
Attempts to navigate directly to the widget currently under the given user's cursor | Framework/Application/SlateApplication.h | |
void NavigateToWidget
(
const uint32 UserIndex, |
Attempts to navigate directly to the given widget | Framework/Application/SlateApplication.h | |
FSlateApplication::FApplicationActivationStateChangedEvent TBaseMulticastDelegate_OneParam OnApplicationActivationStateChanged() |
Framework/Application/SlateApplication.h | ||
FOnApplicationMousePreInputButtonDownListener & OnApplicationMousePreInputButtonDownListener() |
Framework/Application/SlateApplication.h | ||
FOnApplicationPreInputKeyDownListener & OnApplicationPreInputKeyDownListener() |
Framework/Application/SlateApplication.h | ||
EDropEffect::Type OnDragEnter
(
const TSharedRef< SWindow >& Window, |
Framework/Application/SlateApplication.h | ||
FOnFocusChanging & OnFocusChanging() |
Framework/Application/SlateApplication.h | ||
FOnMenuDestroyed & OnMenuBeingDestroyed() |
Delegate called when a menu is about to be destroyed | Framework/Application/SlateApplication.h | |
FSlateTickEvent & OnPostTick() |
Event after slate application ticks. | Framework/Application/SlateApplication.h | |
FSimpleMulticastDelegate & OnPreShutdown() |
Event when the application is about to shutdown. | Framework/Application/SlateApplication.h | |
FSlateTickEvent & OnPreTick() |
Framework/Application/SlateApplication.h | ||
FOnWindowDPIScaleChanged & OnSystemSignalsDPIChanged() |
Event used to signal that a DPI change is about to happen | Framework/Application/SlateApplication.h | |
FUserRegisteredEvent & OnUserRegistered() |
Framework/Application/SlateApplication.h | ||
FOnWindowBeingDestroyed & OnWindowBeingDestroyed() |
Framework/Application/SlateApplication.h | ||
FOnWindowDPIScaleChanged & OnWindowDPIScaleChanged() |
Framework/Application/SlateApplication.h | ||
void OverridePlatformApplication
(
TSharedPtr< class GenericApplication > InPlatformApplication |
Replace the current platform application with a custom version. | Framework/Application/SlateApplication.h | |
void OverridePlatformTextField
(
TUniquePtr< IPlatformTextField > PlatformTextField |
Replace the IPlatformTextField implementation with a custom one. | Framework/Application/SlateApplication.h | |
void PlaySound
(
const FSlateSound& SoundToPlay, |
Play SoundToPlay. Interrupt previous sound if one is playing. | Framework/Application/SlateApplication.h | |
void PollGameDeviceState() |
Polls game devices for input | Framework/Application/SlateApplication.h | |
bool ProcessAnalogInputEvent
(
const FAnalogInputEvent& InAnalogInputEvent |
Called when a analog input values change | Framework/Application/SlateApplication.h | |
void ProcessApplicationActivationEvent
(
bool InAppActivated |
Called when the application is activated (i.e. one of its windows becomes active) or deactivated. | Framework/Application/SlateApplication.h | |
void ProcessCursorReply
(
const FCursorReply& CursorReply |
Apply any requests from the CursorReply | Framework/Application/SlateApplication.h | |
bool ProcessDragEnterEvent
(
TSharedRef< SWindow > WindowEntered, |
Called when a drag from an external (non-slate) source enters a window | Framework/Application/SlateApplication.h | |
void ProcessExternalReply
(
const FWidgetPath& CurrentEventPath, |
Apply any requests from the Reply to the application. E.g. Capture mouse | Framework/Application/SlateApplication.h | |
bool ProcessKeyCharEvent
(
const FCharacterEvent& InCharacterEvent |
Called when a character is entered | Framework/Application/SlateApplication.h | |
bool ProcessKeyDownEvent
(
const FKeyEvent& InKeyEvent |
Called when a key is pressed | Framework/Application/SlateApplication.h | |
bool ProcessKeyUpEvent
(
const FKeyEvent& InKeyEvent |
Called when a key is released | Framework/Application/SlateApplication.h | |
void ProcessMotionDetectedEvent
(
const FMotionEvent& InMotionEvent |
Called when motion is detected (controller or device) when polling game device state | Framework/Application/SlateApplication.h | |
bool ProcessMouseButtonDoubleClickEvent
(
const TSharedPtr< FGenericWindow >& PlatformWindow, |
Called by the native application in response to a mouse release. Routs the event to Slate Widgets. | Framework/Application/SlateApplication.h | |
bool ProcessMouseButtonDownEvent
(
const TSharedPtr< FGenericWindow >& PlatformWindow, |
Called by the native application in response to a mouse button press. | Framework/Application/SlateApplication.h | |
bool ProcessMouseButtonUpEvent
(
const FPointerEvent& MouseEvent |
Called by the native application in response to a mouse button release. | Framework/Application/SlateApplication.h | |
bool ProcessMouseMoveEvent
(
const FPointerEvent& MouseEvent, |
Called by the native application in response to a mouse move. Routs the event to Slate Widgets. | Framework/Application/SlateApplication.h | |
bool ProcessMouseWheelOrGestureEvent
(
const FPointerEvent& InWheelEvent, |
Called by the native application in response to a mouse wheel spin or a touch gesture. | Framework/Application/SlateApplication.h | |
void ProcessReply
(
const FWidgetPath& CurrentEventPath, |
Apply any requests from the Reply to the application. E.g. Capture mouse | Framework/Application/SlateApplication.h | |
void ProcessTouchEndedEvent
(
const FPointerEvent& InTouchEvent |
Called when a touchpad touch is ended (finger lifted) when polling game device state | Framework/Application/SlateApplication.h | |
void ProcessTouchMovedEvent
(
const FPointerEvent& InTouchEvent |
Called when a touchpad touch is moved (finger moved) when polling game device state | Framework/Application/SlateApplication.h | |
void ProcessTouchStartedEvent
(
const TSharedPtr< FGenericWindow >& PlatformWindow, |
Called when a touchpad touch is started (finger down) when polling game device state | Framework/Application/SlateApplication.h | |
bool ProcessWindowActivatedEvent
(
const FWindowActivateEvent& ActivateEvent |
Called by the native application in response to an activation or deactivation. | Framework/Application/SlateApplication.h | |
void PumpMessages() |
Pumps OS messages when a modal window or intra-frame debugging session exists | Framework/Application/SlateApplication.h | |
TSharedPtr< IMenu > PushHostedMenu
(
const TSharedRef< SWidget >& InParentWidget, |
Creates a new hosted Menu and adds it to the menu stack. | Framework/Application/SlateApplication.h | |
TSharedPtr< IMenu > PushHostedMenu
(
const TSharedPtr< IMenu >& InParentMenu, |
Creates a new hosted child Menu and adds it to the menu stack under the specified parent menu. | Framework/Application/SlateApplication.h | |
TSharedPtr< IMenu > PushMenu
(
const TSharedRef< SWidget >& InParentWidget, |
Creates a new Menu and adds it to the menu stack. | Framework/Application/SlateApplication.h | |
TSharedPtr< IMenu > PushMenu
(
const TSharedPtr< IMenu >& InParentMenu, |
Creates a new Menu and adds it to the menu stack under the specified parent menu. | Framework/Application/SlateApplication.h | |
void QueryCursor() |
Bubble a request for which cursor to display for widgets under the mouse or the widget that captured the mouse. | Framework/Application/SlateApplication.h | |
void RegisterGameViewport
(
TSharedRef< SViewport > InViewport |
Registers a game viewport with the Slate application so that specific messages can be routed directly to a viewport | Framework/Application/SlateApplication.h | |
bool RegisterInputPreProcessor
(
TSharedPtr< class IInputProcessor > InputProcessor, |
Adds input pre-processor if unique. | Framework/Application/SlateApplication.h | |
bool RegisterInputPreProcessor
(
TSharedPtr< class IInputProcessor > InputProcessor, |
Adds input pre-processor if unique. | Framework/Application/SlateApplication.h | |
bool RegisterInputPreProcessor
(
TSharedPtr< class IInputProcessor > InputProcessor, |
Adds input pre-processor if unique. | Framework/Application/SlateApplication.h | |
bool RegisterInputPreProcessor
(
TSharedPtr< class IInputProcessor > InputProcessor |
Adds input pre-processor if unique. | Framework/Application/SlateApplication.h | |
FDelegateHandle RegisterOnWindowActionNotification
(
const FOnWindowAction& Notification |
Register for a notification when the window action occurs. | Framework/Application/SlateApplication.h | |
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" | Framework/Application/SlateApplication.h | |
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. | Framework/Application/SlateApplication.h | |
void ReleaseAllPointerCapture () |
Releases capture for every pointer on every user from whatever it currently is on. | Framework/Application/SlateApplication.h | |
void ReleaseAllPointerCapture
(
int32 UserIndex |
Releases capture for every pointer belonging to the given user index particular user. | Framework/Application/SlateApplication.h | |
void ReleaseMouseCapture() |
Framework/Application/SlateApplication.h | ||
void ReleaseMouseCaptureForUser
(
int32 UserIndex |
Framework/Application/SlateApplication.h | ||
void ResetToDefaultInputSettings () |
Restores all input settings to their original values | Framework/Application/SlateApplication.h | |
| Restores all pointer input settings to their original values | Framework/Application/SlateApplication.h | ||
FReply RouteMouseWheelOrGestureEvent
(
const FWidgetPath& WidgetsUnderPointer, |
Directly routes a pointer mouse wheel or gesture event to the widgets in the specified widget path. | Framework/Application/SlateApplication.h | |
FReply RoutePointerDoubleClickEvent
(
const FWidgetPath& WidgetsUnderPointer, |
Directly routes a pointer double click event to the widgets in the specified widget path | Framework/Application/SlateApplication.h | |
FReply RoutePointerDownEvent
(
const FWidgetPath& WidgetsUnderPointer, |
Directly routes a pointer down event to the widgets in the specified widget path | Framework/Application/SlateApplication.h | |
bool RoutePointerMoveEvent
(
const FWidgetPath& WidgetsUnderPointer, |
Directly routes a pointer move event to the widgets in the specified widget path | Framework/Application/SlateApplication.h | |
FReply RoutePointerUpEvent
(
const FWidgetPath& WidgetsUnderPointer, |
Directly routes a pointer up event to the widgets in the specified widget path | Framework/Application/SlateApplication.h | |
void SetAllowTooltips
(
bool bCanShow |
Framework/Application/SlateApplication.h | ||
void SetAllUserFocus
(
const TSharedPtr< SWidget >& WidgetToFocus, |
Sets focus for all users to the SWidget passed in. | Framework/Application/SlateApplication.h | |
void SetAllUserFocusToGameViewport
(
EFocusCause ReasonFocusIsChanging |
Sets all users focus to the SWidget representing the currently active game viewport | Framework/Application/SlateApplication.h | |
void SetAppIcon
(
const FSlateBrush*const InAppIcon |
Set the global application icon | Framework/Application/SlateApplication.h | |
void SetApplicationScale
(
float InScale |
Framework/Application/SlateApplication.h | ||
void SetCursorRadius
(
float NewRadius |
Sets the hit detection radius of the cursor | Framework/Application/SlateApplication.h | |
void SetDragTriggerDistance
(
float ScreenPixels |
Set the size of the deadzone for dragging in screen pixels | Framework/Application/SlateApplication.h | |
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). | Framework/Application/SlateApplication.h | |
void SetGameAllowsFakingTouchEvents
(
const bool bAllowFaking |
Sets whether the application is allowed to fake touches or not | Framework/Application/SlateApplication.h | |
void SetGameIsFakingTouchEvents
(
const bool bIsFaking, |
Sets whether the application is treating mouse events as imitating touch events. | Framework/Application/SlateApplication.h | |
void SetHandleDeviceInputWhenApplicationNotActive
(
bool bAllow |
Mouse capture | Framework/Application/SlateApplication.h | |
void SetInputManager
(
TSharedRef< ISlateInputManager > InputManager |
Establishes the input mapping object used to map input sources to SlateUser indices | Framework/Application/SlateApplication.h | |
bool SetKeyboardFocus
(
const TSharedPtr< SWidget >& OptionalWidgetToFocus, |
Sets the Keyboard focus to the specified SWidget | Framework/Application/SlateApplication.h | |
void SetModalWindowStackEndedDelegate
(
FModalWindowStackEnded StackEndedDelegate |
Sets the delegate for when a modal window stack ends | Framework/Application/SlateApplication.h | |
void SetModalWindowStackStartedDelegate
(
FModalWindowStackStarted StackStartedDelegate |
Sets the delegate for when a modal window stack begins | Framework/Application/SlateApplication.h | |
void SetNavigationConfig
(
TSharedRef< FNavigationConfig > InNavigationConfig |
Sets the navigation config. | Framework/Application/SlateApplication.h | |
void SetNavigationConfigFactory
(
TFunction< TSharedRef< FNavigationConfig >()> InNavigationConfigFactory |
Sets the navigation config factory. | Framework/Application/SlateApplication.h | |
void SetPlatformApplication
(
const TSharedRef< class GenericApplication >& InPlatformApplication |
Framework/Application/SlateApplication.h | ||
void SetPlatformCursorVisibility
(
bool bNewVisibility |
Changes the cursor type to Default (Visible) or None (Not Visible) | Framework/Application/SlateApplication.h | |
void SetUnhandledKeyDownEventHandler
(
const FOnKeyEvent& NewHandler |
Sets the handler for otherwise unhandled key down events. | Framework/Application/SlateApplication.h | |
void SetUnhandledKeyUpEventHandler
(
const FOnKeyEvent& NewHandler |
Sets the handler for otherwise unhandled key down events. | Framework/Application/SlateApplication.h | |
bool SetUserFocus
(
uint32 UserIndex, |
Sets specified user focus to the SWidget passed in. | Framework/Application/SlateApplication.h | |
void SetUserFocusToGameViewport
(
uint32 UserIndex, |
Sets specified user focus to the SWidget representing the currently active game viewport | Framework/Application/SlateApplication.h | |
void SetWidgetReflector
(
const TSharedRef< IWidgetReflector >& WidgetReflector |
Sets the widget reflector. | Framework/Application/SlateApplication.h | |
void SetWidgetReflectorAssetAccessDelegate
(
FAccessAsset AccessDelegate |
Framework/Application/SlateApplication.h | ||
void SetWidgetReflectorQuerySourceAccessDelegate
(
FQueryAccessSourceCode QueryAccessDelegate |
Framework/Application/SlateApplication.h | ||
void SetWidgetReflectorSourceAccessDelegate
(
FAccessSourceCode AccessDelegate |
Framework/Application/SlateApplication.h | ||
void ShowSystemHelp() |
Framework/Application/SlateApplication.h | ||
void ShowVirtualKeyboard
(
bool bShow, |
Shows or hides an onscreen keyboard | Framework/Application/SlateApplication.h | |
void SpawnToolTip
(
const TSharedRef< IToolTip >& InToolTip, |
Spawns a tool tip window. If an existing tool tip window is open, it will be dismissed first. | Framework/Application/SlateApplication.h | |
bool SupportsSourceAccess() |
Framework/Application/SlateApplication.h | ||
bool SupportsSystemHelp() |
Framework/Application/SlateApplication.h | ||
bool TakeHDRScreenshot
(
const TSharedRef< SWidget >& Widget, |
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. | Framework/Application/SlateApplication.h | |
bool TakeHDRScreenshot
(
const TSharedRef< SWidget >& Widget, |
Takes a screenshot of the widget writing the results into the color buffer provided. | Framework/Application/SlateApplication.h | |
bool TakeScreenshot
(
const TSharedRef< SWidget >& Widget, |
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. | Framework/Application/SlateApplication.h | |
bool TakeScreenshot
(
const TSharedRef< SWidget >& Widget, |
Takes a screenshot of the widget writing the results into the color buffer provided. | Framework/Application/SlateApplication.h | |
void Tick
(
ESlateTickType TickType |
Ticks this application | Framework/Application/SlateApplication.h | |
void ToggleDisableLastDragOnDragEnter
(
bool bInDisableLastDragOnDragEnter |
Toggle disabling last drag on a new drag enter event to prevent double drag conflicts. | Framework/Application/SlateApplication.h | |
void TryDumpNavigationConfig
(
TSharedPtr< FNavigationConfig > InNavigationConfig |
Tries to dumps the current navigation config along with callstack used to set it. | Framework/Application/SlateApplication.h | |
void UnregisterGameViewport () |
Unregisters the current game viewport from Slate. | Framework/Application/SlateApplication.h | |
void UnregisterInputPreProcessor
(
TSharedPtr< class IInputProcessor > InputProcessor |
Removes an input pre-processor. | Framework/Application/SlateApplication.h | |
void UnregisterOnWindowActionNotification
(
FDelegateHandle Handle |
Unregister the notification because it is no longer desired. | Framework/Application/SlateApplication.h | |
void UnregisterUser
(
int32 UserIndex |
Framework/Application/SlateApplication.h | ||
void UnregisterVirtualWindow
(
TSharedRef< SWindow > InWindow |
Unregister a virtual window. | Framework/Application/SlateApplication.h | |
void UpdateToolTip
(
bool bAllowSpawningOfNewToolTips |
Framework/Application/SlateApplication.h | ||
void UsePlatformCursorForCursorUser
(
bool bUsePlatformCursor |
Updates the cursor user's cursor to either the platform cursor or fake cursor | Framework/Application/SlateApplication.h |
Overridden from FSlateApplicationBase
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual TSharedRef< SWindow > AddWindow
(
TSharedRef< SWindow > InSlateWindow, |
Framework/Application/SlateApplication.h | ||
virtual bool AnyMenusVisible() |
Framework/Application/SlateApplication.h | ||
virtual void ArrangeWindowToFrontVirtual
(
TArray< TSharedRef< SWindow > >& Windows, |
Framework/Application/SlateApplication.h | ||
virtual UE::Slate::FDeprecateVector2DResult CalculateTooltipWindowPosition
(
const FSlateRect& InAnchorRect, |
Calculates the tooltip window position. | Framework/Application/SlateApplication.h | |
virtual bool FindPathToWidget
(
TSharedRef< const SWidget > InWidget, |
Framework/Application/SlateApplication.h | ||
virtual TSharedPtr< SWindow > FindWidgetWindow
(
TSharedRef< const SWidget > InWidget |
Finds the window that the provided widget resides in | Framework/Application/SlateApplication.h | |
virtual TSharedPtr< SWindow > GetActiveTopLevelRegularWindow() |
Framework/Application/SlateApplication.h | ||
virtual TSharedPtr< SWindow > GetActiveTopLevelWindow() |
Framework/Application/SlateApplication.h | ||
virtual const FSlateBrush * GetAppIcon() |
Framework/Application/SlateApplication.h | ||
virtual const FSlateBrush * GetAppIconSmall() |
Framework/Application/SlateApplication.h | ||
virtual float GetApplicationScale() |
Framework/Application/SlateApplication.h | ||
virtual TSharedPtr< SWidget > GetCurrentDebugContextWidget() |
Framework/Application/SlateApplication.h | ||
virtual const double GetCurrentTime() |
Framework/Application/SlateApplication.h | ||
virtual UE::Slate::FDeprecateVector2DResult GetCursorPos() |
Framework/Application/SlateApplication.h | ||
virtual UE::Slate::FDeprecateVector2DResult GetCursorSize() |
Framework/Application/SlateApplication.h | ||
virtual TSharedPtr< SWidget > GetKeyboardFocusedWidget() |
Framework/Application/SlateApplication.h | ||
virtual UE::Slate::FDeprecateVector2DResult GetLastCursorPos() |
Framework/Application/SlateApplication.h | ||
virtual EUINavigationAction GetNavigationActionForKey
(
const FKey& InKey |
Framework/Application/SlateApplication.h | ||
virtual EUINavigationAction GetNavigationActionFromKey
(
const FKeyEvent& InKeyEvent |
Returns the navigation action corresponding to a key event. | Framework/Application/SlateApplication.h | |
virtual EUINavigation GetNavigationDirectionFromAnalog
(
const FAnalogInputEvent& InAnalogEvent |
Returns navigation direction matching an anlog event, this is determined in the FNavigationConfig | Framework/Application/SlateApplication.h | |
virtual EUINavigation GetNavigationDirectionFromKey
(
const FKeyEvent& InKeyEvent |
Returns navigation direction matching a key event, this is determined in the FNavigationConfig | Framework/Application/SlateApplication.h | |
virtual FSlateRect GetPreferredWorkArea() |
Framework/Application/SlateApplication.h | ||
virtual bool GetSoftwareCursorAvailable() |
Framework/Application/SlateApplication.h | ||
virtual EVisibility GetSoftwareCursorVis() |
Framework/Application/SlateApplication.h | ||
virtual const TArray< TSharedRef< SWindow > > GetTopLevelWindows() |
Framework/Application/SlateApplication.h | ||
virtual TSharedPtr< SWidget > GetUserFocusedWidget
(
uint32 UserIndex |
Framework/Application/SlateApplication.h | ||
virtual EWindowTransparency GetWindowTransparencySupport() |
Framework/Application/SlateApplication.h | ||
virtual bool HasAnyMouseCaptor() |
Framework/Application/SlateApplication.h | ||
virtual bool HasFocusedDescendants
(
const TSharedRef< const SWidget >& Widget |
Framework/Application/SlateApplication.h | ||
virtual bool HasUserFocusedDescendants
(
const TSharedRef< const SWidget >& Widget, |
Framework/Application/SlateApplication.h | ||
virtual bool HasUserMouseCapture
(
int32 UserIndex |
Framework/Application/SlateApplication.h | ||
virtual bool IsActive() |
Framework/Application/SlateApplication.h | ||
virtual bool IsExternalUIOpened() |
Framework/Application/SlateApplication.h | ||
virtual bool IsWindowHousingInteractiveTooltip
(
const TSharedRef< const SWindow >& WindowToTest |
Framework/Application/SlateApplication.h | ||
virtual FWidgetPath LocateWindowUnderMouse
(
UE::Slate::FDeprecateVector2DParameter ScreenspaceMouseCoordinate, |
Framework/Application/SlateApplication.h | ||
virtual TSharedRef< SImage > MakeImage
(
const TAttribute< const FSlateBrush* >& Image, |
Framework/Application/SlateApplication.h | ||
virtual TSharedRef< IToolTip > MakeToolTip
(
const FText& ToolTipText |
Framework/Application/SlateApplication.h | ||
virtual TSharedRef< IToolTip > MakeToolTip
(
const TAttribute< FText >& ToolTipText |
Framework/Application/SlateApplication.h | ||
virtual TSharedRef< SWidget > MakeWindowTitleBar
(
const FWindowTitleBarArgs& InArgs, |
Framework/Application/SlateApplication.h | ||
virtual void RequestDestroyWindow
(
TSharedRef< SWindow > WindowToDestroy |
Framework/Application/SlateApplication.h | ||
virtual void SetAllUserFocus
(
const FWidgetPath& InFocusPath, |
Framework/Application/SlateApplication.h | ||
virtual void SetAllUserFocusAllowingDescendantFocus
(
const FWidgetPath& InFocusPath, |
Framework/Application/SlateApplication.h | ||
virtual bool SetKeyboardFocus
(
const FWidgetPath& InFocusPath, |
Framework/Application/SlateApplication.h | ||
virtual bool SetUserFocus
(
const uint32 InUserIndex, |
Framework/Application/SlateApplication.h | ||
virtual bool SetUserFocusAllowingDescendantFocus
(
const uint32 InUserIndex, |
Framework/Application/SlateApplication.h |
Overridden from FGenericApplicationMessageHandler
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool BeginReshapingWindow
(
const TSharedRef< FGenericWindow >& PlatformWindow |
Framework/Application/SlateApplication.h | ||
virtual void FinishedReshapingWindow
(
const TSharedRef< FGenericWindow >& PlatformWindow |
Framework/Application/SlateApplication.h | ||
virtual FWindowSizeLimits GetSizeLimitsForWindow
(
const TSharedRef< FGenericWindow >& Window |
Framework/Application/SlateApplication.h | ||
virtual EWindowZone::Type GetWindowZoneForPoint
(
const TSharedRef< FGenericWindow >& PlatformWindow, |
Framework/Application/SlateApplication.h | ||
virtual void HandleDPIScaleChanged
(
const TSharedRef< FGenericWindow >& Window |
Framework/Application/SlateApplication.h | ||
virtual bool OnApplicationActivationChanged
(
const bool IsActive |
Framework/Application/SlateApplication.h | ||
virtual bool OnControllerAnalog
(
FGamepadKeyNames::Type KeyName, |
Framework/Application/SlateApplication.h | ||
virtual bool OnControllerButtonPressed
(
FGamepadKeyNames::Type KeyName, |
Framework/Application/SlateApplication.h | ||
virtual bool OnControllerButtonReleased
(
FGamepadKeyNames::Type KeyName, |
Framework/Application/SlateApplication.h | ||
virtual bool OnConvertibleLaptopModeChanged() |
Framework/Application/SlateApplication.h | ||
virtual bool OnCursorSet() |
Framework/Application/SlateApplication.h | ||
virtual EDropEffect::Type OnDragDrop
(
const TSharedPtr< FGenericWindow >& Window |
Framework/Application/SlateApplication.h | ||
virtual EDropEffect::Type OnDragEnterExternal
(
const TSharedRef< FGenericWindow >& Window, |
Framework/Application/SlateApplication.h | ||
virtual EDropEffect::Type OnDragEnterFiles
(
const TSharedRef< FGenericWindow >& Window, |
Framework/Application/SlateApplication.h | ||
virtual EDropEffect::Type OnDragEnterText
(
const TSharedRef< FGenericWindow >& Window, |
Framework/Application/SlateApplication.h | ||
virtual void OnDragLeave
(
const TSharedPtr< FGenericWindow >& Window |
Framework/Application/SlateApplication.h | ||
virtual EDropEffect::Type OnDragOver
(
const TSharedPtr< FGenericWindow >& Window |
Framework/Application/SlateApplication.h | ||
virtual void OnInputLanguageChanged() |
Framework/Application/SlateApplication.h | ||
virtual bool OnKeyChar
(
const TCHAR Character, |
Framework/Application/SlateApplication.h | ||
virtual bool OnKeyDown
(
const int32 KeyCode, |
Framework/Application/SlateApplication.h | ||
virtual bool OnKeyUp
(
const int32 KeyCode, |
Framework/Application/SlateApplication.h | ||
virtual bool OnMotionDetected
(
const FVector& Tilt, |
Framework/Application/SlateApplication.h | ||
virtual bool OnMouseDoubleClick
(
const TSharedPtr< FGenericWindow >& PlatformWindow, |
Framework/Application/SlateApplication.h | ||
virtual bool OnMouseDoubleClick
(
const TSharedPtr< FGenericWindow >& PlatformWindow, |
Framework/Application/SlateApplication.h | ||
virtual bool OnMouseDown
(
const TSharedPtr< FGenericWindow >& PlatformWindow, |
Framework/Application/SlateApplication.h | ||
virtual bool OnMouseDown
(
const TSharedPtr< FGenericWindow >& PlatformWindow, |
Framework/Application/SlateApplication.h | ||
virtual bool OnMouseMove() |
Framework/Application/SlateApplication.h | ||
virtual bool OnMouseUp
(
const EMouseButtons::Type Button |
Framework/Application/SlateApplication.h | ||
virtual bool OnMouseUp
(
const EMouseButtons::Type Button, |
Framework/Application/SlateApplication.h | ||
virtual bool OnMouseWheel
(
const float Delta |
Framework/Application/SlateApplication.h | ||
virtual bool OnMouseWheel
(
const float Delta, |
Framework/Application/SlateApplication.h | ||
virtual void OnMovedWindow
(
const TSharedRef< FGenericWindow >& PlatformWindow, |
Framework/Application/SlateApplication.h | ||
virtual void OnOSPaint
(
const TSharedRef< FGenericWindow >& PlatformWindow |
Framework/Application/SlateApplication.h | ||
virtual bool OnRawMouseMove
(
const int32 X, |
Framework/Application/SlateApplication.h | ||
virtual void OnResizingWindow
(
const TSharedRef< FGenericWindow >& PlatformWindow |
Framework/Application/SlateApplication.h | ||
virtual bool OnSizeChanged
(
const TSharedRef< FGenericWindow >& PlatformWindow, |
Framework/Application/SlateApplication.h | ||
virtual bool OnTouchEnded
(
const FVector2D& Location, |
Framework/Application/SlateApplication.h | ||
virtual bool OnTouchFirstMove
(
const FVector2D& Location, |
Framework/Application/SlateApplication.h | ||
virtual bool OnTouchForceChanged
(
const FVector2D& Location, |
Framework/Application/SlateApplication.h | ||
virtual bool OnTouchGesture
(
EGestureEvent GestureType, |
Framework/Application/SlateApplication.h | ||
virtual bool OnTouchMoved
(
const FVector2D& Location, |
Framework/Application/SlateApplication.h | ||
virtual bool OnTouchStarted
(
const TSharedPtr< FGenericWindow >& Window, |
Framework/Application/SlateApplication.h | ||
virtual bool OnWindowAction
(
const TSharedRef< FGenericWindow >& PlatformWindow, |
Framework/Application/SlateApplication.h | ||
virtual bool OnWindowActivationChanged
(
const TSharedRef< FGenericWindow >& PlatformWindow, |
Framework/Application/SlateApplication.h | ||
virtual void OnWindowClose
(
const TSharedRef< FGenericWindow >& PlatformWindow |
Framework/Application/SlateApplication.h | ||
virtual void SetCursorPos
(
const FVector2D& MouseCoordinate |
Sets the position of the cursor. | Framework/Application/SlateApplication.h | |
virtual bool ShouldProcessUserInputMessages
(
const TSharedPtr< FGenericWindow >& PlatformWindow |
Framework/Application/SlateApplication.h | ||
virtual void ShouldSimulateGesture
(
EGestureEvent Gesture, |
Framework/Application/SlateApplication.h | ||
virtual void SignalSystemDPIChanged
(
const TSharedRef< FGenericWindow >& Window |
Framework/Application/SlateApplication.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void DestroyRenderer() |
Framework/Application/SlateApplication.h | ||
void DrawPrepass
(
TSharedPtr< SWindow > DrawOnlyThisWindow |
Pre-pass step before drawing windows to compute geometry size and reshape autosized windows | Framework/Application/SlateApplication.h | |
void DrawWindowAndChildren
(
const TSharedRef< SWindow >& WindowToDraw, |
Draws a window and its children | Framework/Application/SlateApplication.h | |
void DrawWindows() |
Draws Slate windows. Should only be called by the application's main loop or renderer. | Framework/Application/SlateApplication.h | |
void GetAllVisibleChildWindows
(
TArray< TSharedRef< SWindow > >& OutWindows, |
Gets all visible child windows of a window. | Framework/Application/SlateApplication.h | |
TSharedRef< FSlateUser > GetOrCreateUser
(
FInputDeviceId DeviceId |
Locates the SlateUser object corresponding to the input device id, creating a new one if it doesn't exist. | Framework/Application/SlateApplication.h | |
TSharedRef< FSlateUser > GetOrCreateUser
(
FPlatformUserId PlatformUserId |
Locates the SlateUser object corresponding to the index, creating a new one if it doesn't exist. | Framework/Application/SlateApplication.h | |
TSharedRef< FSlateUser > GetOrCreateUser
(
int32 UserIndex |
Locates the SlateUser object corresponding to the index, creating a new one if it doesn't exist. | Framework/Application/SlateApplication.h | |
TSharedRef< FSlateUser > GetOrCreateUser
(
const FInputEvent& InputEvent |
Framework/Application/SlateApplication.h | ||
TSharedRef< FNavigationConfig > GetRelevantNavConfig
(
int32 UserIndex |
Framework/Application/SlateApplication.h | ||
void OnShutdown() |
Called when the slate application is being shut down. | Framework/Application/SlateApplication.h | |
void PrivateDrawWindows
(
TSharedPtr< SWindow > DrawOnlyThisWindow |
Draws slate windows, optionally only drawing the passed in window | Framework/Application/SlateApplication.h | |
TSharedRef< FSlateUser > RegisterNewUser
(
FPlatformUserId PlatformUserId, |
Register a new user with Slate. | Framework/Application/SlateApplication.h | |
TSharedRef< FSlateUser > RegisterNewUser
(
int32 UserIndex, |
Register a new user with Slate. | Framework/Application/SlateApplication.h | |
void SetupPhysicalSensitivities () |
Sets up any values that need to be based on the physical dimensions of the device. | Framework/Application/SlateApplication.h | |
void ThrottleApplicationBasedOnMouseMovement() |
Engages or disengages application throttling based on user behavior | Framework/Application/SlateApplication.h | |
void TickAndDrawWidgets
(
float DeltaTime |
Ticks and paints the actual Slate portion of the application. | Framework/Application/SlateApplication.h | |
void TickPlatform
(
float DeltaTime |
Pumps and ticks the platform. | Framework/Application/SlateApplication.h | |
void TickTime() |
Advances time for the application. | Framework/Application/SlateApplication.h | |
FPointerEvent TransformPointerEvent
(
const FPointerEvent& PointerEvent, |
Transforms a pointer event to account for non-standard viewport resolutions | Framework/Application/SlateApplication.h |
Overridden from FSlateApplicationBase
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool DoesWidgetHaveMouseCapture
(
const TSharedPtr< const SWidget > Widget |
Framework/Application/SlateApplication.h | ||
virtual bool DoesWidgetHaveMouseCaptureByUser
(
const TSharedPtr< const SWidget > Widget, |
Framework/Application/SlateApplication.h | ||
virtual TSharedPtr< SWidget > GetMouseCaptorImpl() |
Framework/Application/SlateApplication.h | ||
virtual TOptional< EFocusCause > HasAnyUserFocus
(
const TSharedPtr< const SWidget > Widget |
Framework/Application/SlateApplication.h | ||
virtual TOptional< EFocusCause > HasUserFocus
(
const TSharedPtr< const SWidget > Widget, |
Framework/Application/SlateApplication.h | ||
virtual bool IsWidgetDirectlyHovered
(
const TSharedPtr< const SWidget > Widget |
Framework/Application/SlateApplication.h | ||
virtual FWidgetPath LocateWidgetInWindow
(
UE::Slate::FDeprecateVector2DParameter ScreenspaceMouseCoordinate, |
Framework/Application/SlateApplication.h | ||
virtual bool ShowUserFocus
(
const TSharedPtr< const SWidget > Widget |
Framework/Application/SlateApplication.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static TSharedRef< FSlateApplication > Create
(
const TSharedRef< class GenericApplication >& InPlatformApplication |
Framework/Application/SlateApplication.h | ||
static void Create () |
Framework/Application/SlateApplication.h | ||
static FSlateApplication & Get () |
Returns the current instance of the application. | Framework/Application/SlateApplication.h | |
static double GetFixedDeltaTime() |
Gets time step in seconds if a fixed delta time is wanted. | Framework/Application/SlateApplication.h | |
static TSharedRef< class FGlobalTabmanager > GetGlobalTabManager() |
Framework/Application/SlateApplication.h | ||
static void InitHighDPI
(
const bool bForceEnable |
Initializes high dpi support for the process | Framework/Application/SlateApplication.h | |
static TSharedRef< FSlateApplication > InitializeAsStandaloneApplication
(
const TSharedRef< class FSlateRenderer >& PlatformRenderer, |
Framework/Application/SlateApplication.h | ||
static TSharedRef< FSlateApplication > InitializeAsStandaloneApplication
(
const TSharedRef< class FSlateRenderer >& PlatformRenderer |
Framework/Application/SlateApplication.h | ||
static void InitializeCoreStyle() |
Framework/Application/SlateApplication.h | ||
static bool IsInitialized() |
Returns true if a Slate application instance is currently initialized and ready | Framework/Application/SlateApplication.h | |
static void SetFixedDeltaTime
(
double InSeconds |
Sets time step in seconds if a fixed delta time is wanted. | Framework/Application/SlateApplication.h | |
static void Shutdown
(
bool bShutdownPlatform |
Framework/Application/SlateApplication.h |