Navigation
API > API/Runtime > API/Runtime/ApplicationCore
Generic platform application interface
| Name | GenericApplication |
| Type | class |
| Header File | /Engine/Source/Runtime/ApplicationCore/Public/GenericPlatform/GenericApplication.h |
| Include Path | #include "GenericPlatform/GenericApplication.h" |
Syntax
class GenericApplication
Derived Classes
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
GenericApplication
(
const TSharedPtr< ICursor >& InCursor |
GenericPlatform/GenericApplication.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~GenericApplication() |
GenericPlatform/GenericApplication.h |
Classes
| Name | Remarks |
|---|---|
| FOnClipboardContentChanged | |
| FOnDisplayMetricsChanged | |
| FVirtualKeyboardHiddenEvent | |
| FVirtualKeyboardShownEvent | Delegate for virtual keyboard being shown/hidden in case UI wants to slide out of the way |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FOnConsoleCommandAdded | TMulticastDelegate_OneParam< void, const FString & > | GenericPlatform/GenericApplication.h | |
| FOnConsoleCommandListener | FOnConsoleCommandAdded::FDelegate | GenericPlatform/GenericApplication.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| Cursor | const TSharedPtr< ICursor > | GenericPlatform/GenericApplication.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void AddPendingConsoleCommand
(
const FString& InCommand |
GenericPlatform/GenericApplication.h | ||
virtual bool ApplicationLicenseValid
(
FPlatformUserId PlatformUser |
GenericPlatform/GenericApplication.h | ||
virtual void DestroyApplication() |
GenericPlatform/GenericApplication.h | ||
virtual void FinishedInputThisFrame() |
GenericPlatform/GenericApplication.h | ||
TSharedRef< FGenericAccessibleMessageHandler > GetAccessibleMessageHandler() |
GenericPlatform/GenericApplication.h | ||
virtual void * GetCapture() |
GenericPlatform/GenericApplication.h | ||
virtual void GetInitialDisplayMetrics
(
FDisplayMetrics& OutDisplayMetrics |
GenericPlatform/GenericApplication.h | ||
virtual IInputInterface * GetInputInterface() |
GenericPlatform/GenericApplication.h | ||
TSharedRef< FGenericApplicationMessageHandler > GetMessageHandler() |
GenericPlatform/GenericApplication.h | ||
virtual FModifierKeysState GetModifierKeys() |
GenericPlatform/GenericApplication.h | ||
virtual ITextInputMethodSystem * GetTextInputMethodSystem() |
Function to return the current implementation of the Text Input Method System | GenericPlatform/GenericApplication.h | |
virtual EWindowTitleAlignment::Type GetWindowTitleAlignment() |
Gets the horizontal alignment of the window title bar's title text. | GenericPlatform/GenericApplication.h | |
virtual EWindowTransparency GetWindowTransparencySupport() |
GenericPlatform/GenericApplication.h | ||
virtual TSharedPtr< FGenericWindow > GetWindowUnderCursor() |
GenericPlatform/GenericApplication.h | ||
virtual FPlatformRect GetWorkArea
(
const FPlatformRect& CurrentWindow |
GenericPlatform/GenericApplication.h | ||
virtual void InitializeWindow
(
const TSharedRef< FGenericWindow >& Window, |
GenericPlatform/GenericApplication.h | ||
virtual bool IsAllowedToRender() |
GenericPlatform/GenericApplication.h | ||
virtual bool IsCursorDirectlyOverSlateWindow() |
GenericPlatform/GenericApplication.h | ||
virtual bool IsGamepadAttached() |
GenericPlatform/GenericApplication.h | ||
virtual bool IsMinimized() |
GenericPlatform/GenericApplication.h | ||
virtual bool IsMouseAttached() |
GenericPlatform/GenericApplication.h | ||
virtual bool IsUsingHighPrecisionMouseMode() |
GenericPlatform/GenericApplication.h | ||
virtual bool IsUsingTrackpad() |
GenericPlatform/GenericApplication.h | ||
virtual TSharedRef< FGenericWindow > MakeWindow() |
GenericPlatform/GenericApplication.h | ||
FOnClipboardContentChanged & OnClipboardContentChanged() |
GenericPlatform/GenericApplication.h | ||
FOnDisplayMetricsChanged & OnDisplayMetricsChanged() |
Notifies subscribers when any of the display metrics change: e.g. resolution changes or monitor sare re-arranged. | GenericPlatform/GenericApplication.h | |
FVirtualKeyboardHiddenEvent & OnVirtualKeyboardHidden() |
GenericPlatform/GenericApplication.h | ||
FVirtualKeyboardShownEvent & OnVirtualKeyboardShown() |
GenericPlatform/GenericApplication.h | ||
virtual void PollGameDeviceState
(
const float TimeDelta |
GenericPlatform/GenericApplication.h | ||
virtual void ProcessDeferredEvents
(
const float TimeDelta |
GenericPlatform/GenericApplication.h | ||
virtual void PumpMessages
(
const float TimeDelta |
GenericPlatform/GenericApplication.h | ||
virtual void RegisterConsoleCommandListener
(
const FOnConsoleCommandListener& InListener |
GenericPlatform/GenericApplication.h | ||
virtual void SendAnalytics
(
IAnalyticsProvider* Provider |
Send any analytics captured by the application | GenericPlatform/GenericApplication.h | |
virtual void SetAccessibleMessageHandler
(
const TSharedRef< FGenericAccessibleMessageHandler >& InAccessibleMessageHandler |
GenericPlatform/GenericApplication.h | ||
virtual void SetCapture
(
const TSharedPtr< FGenericWindow >& InWindow |
GenericPlatform/GenericApplication.h | ||
virtual void SetHighPrecisionMouseMode
(
const bool Enable, |
GenericPlatform/GenericApplication.h | ||
virtual void SetMessageHandler
(
const TSharedRef< FGenericApplicationMessageHandler >& InMessageHandler |
GenericPlatform/GenericApplication.h | ||
virtual void ShowSystemHelp() |
GenericPlatform/GenericApplication.h | ||
virtual bool SupportsSystemHelp() |
GenericPlatform/GenericApplication.h | ||
virtual void Tick
(
const float TimeDelta |
GenericPlatform/GenericApplication.h | ||
virtual bool TryCalculatePopupWindowPosition
(
const FPlatformRect& InAnchor, |
GenericPlatform/GenericApplication.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void BroadcastDisplayMetricsChanged
(
const FDisplayMetrics& InMetrics |
Trigger the OnDisplayMetricsChanged event with the argument 'InMetrics' | GenericPlatform/GenericApplication.h |