GenericApplication

Generic platform application interface

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

GenericApplication

FHoloLensApplication

References

Module

ApplicationCore

Header

/Engine/Source/Runtime/ApplicationCore/Public/GenericPlatform/GenericApplication.h

Include

#include "GenericPlatform/GenericApplication.h"

Syntax

class GenericApplication

Remarks

Generic platform application interface

Variables

Name Description

Protected variable

TSharedRef< FGe...

 

AccessibleMessageHandler

Public variable

const TSharedPt...

 

Cursor

Protected variable

TSharedRef< cla...

 

MessageHandler

Protected variable

FOnDisplayMetri...

 

OnDisplayMetricsChangedEvent

Notifies subscribers when any of the display metrics change: e.g. resolution changes or monitor sare re-arranged.

Protected variable

FVirtualKeyboar...

 

VirtualKeyboardHiddenEvent

Delegate for virtual keyboard being shown

Protected variable

FVirtualKeyboar...

 

VirtualKeyboardShownEvent

Delegate for virtual keyboard being shown

Constructors

Name Description

Public function

GenericApplication

(
    const TSharedPtr< ICursor >& InCur...
)

Destructors

Name Description

Public function Virtual

~GenericApplication()

Functions

Name Description

Public function Virtual

void

 

AddPendingConsoleCommand

(
    const FString& InCommand
)

Public function Virtual

bool

 

ApplicationLicenseValid

(
    FPlatformUserId PlatformUser
)

Protected function

void

 

BroadcastDisplayMetricsChanged

(
    const FDisplayMetrics& InMetrics
)

Trigger the OnDisplayMetricsChanged event with the argument 'InMetrics'

Public function Virtual

void

 

DestroyApplication()

Public function Virtual

void

 

FinishedInputThisFrame()

Public function Const

TSharedRef< ...

 

GetAccessibleMessageHandler()

Public function Virtual Const

void *

 

GetCapture()

Public function Virtual Const

void

 

GetInitialDisplayMetrics

(
    FDisplayMetrics& OutDisplayMetrics
)

Public function Virtual

IInputInterf...

 

GetInputInterface()

Public function

TSharedRef< ...

 

GetMessageHandler()

Public function Virtual Const

FModifierKey...

 

GetModifierKeys()

Public function Virtual

ITextInputMe...

 

GetTextInputMethodSystem()

Function to return the current implementation of the Text Input Method System

Public function Virtual Const

EWindowTitle...

 

GetWindowTitleAlignment()

Gets the horizontal alignment of the window title bar's title text.

Public function Virtual Const

EWindowTrans...

 

GetWindowTransparencySupport()

Public function Virtual

TSharedPtr< ...

 

GetWindowUnderCursor()

Public function Virtual Const

FPlatformRec...

 

GetWorkArea

(
    const FPlatformRect& CurrentWindow
)

Public function Virtual

void

 

InitializeWindow

(
    const TSharedRef< FGenericWindow > ...,
    const TSharedRef< FGenericWindowDef...,
    const TSharedPtr< FGenericWindow > ...,
    const bool bShowImmediately
)

Public function Virtual Const

bool

 

IsAllowedToRender()

Public function Virtual Const

bool

 

IsCursorDirectlyOverSlateWindow()

Public function Virtual Const

bool

 

IsGamepadAttached()

Public function Virtual Const

bool

 

IsMinimized()

Public function Virtual Const

bool

 

IsMouseAttached()

Public function Virtual Const

bool

 

IsUsingHighPrecisionMouseMode()

Public function Virtual Const

bool

 

IsUsingTrackpad()

Public function Virtual

TSharedRef< ...

 

MakeWindow()

Public function

FOnDisplayMe...

 

OnDisplayMetricsChanged()

Notifies subscribers when any of the display metrics change: e.g. resolution changes or monitor sare re-arranged.

Public function

FVirtualKeyb...

 

OnVirtualKeyboardHidden()

Public function

FVirtualKeyb...

 

OnVirtualKeyboardShown()

Public function Virtual

void

 

PollGameDeviceState

(
    const float TimeDelta
)

Public function Virtual

void

 

ProcessDeferredEvents

(
    const float TimeDelta
)

Public function Virtual

void

 

PumpMessages

(
    const float TimeDelta
)

Public function Virtual

void

 

RegisterConsoleCommandListener

(
    const FOnConsoleCommandListener& I...
)

Public function Virtual

void

 

SendAnalytics

(
    IAnalyticsProvider* Provider
)

Send any analytics captured by the application

Public function Virtual

void

 

SetAccessibleMessageHandler

(
    const TSharedRef< FGenericAccessibl...
)

Public function Virtual

void

 

SetCapture

(
    const TSharedPtr< FGenericWindow > ...
)

Public function Virtual

void

 

SetHighPrecisionMouseMode

(
    const bool Enable,
    const TSharedPtr< FGenericWindow > ...
)

Public function Virtual

void

 

SetMessageHandler

(
    const TSharedRef< FGenericApplicati...
)

Public function Virtual

void

 

ShowSystemHelp()

Public function Virtual Const

bool

 

SupportsSystemHelp()

Public function Virtual

void

 

Tick

(
    const float TimeDelta
)

Public function Virtual Const

bool

 

TryCalculatePopupWindowPosition

(
    const FPlatformRect& InAnchor,
    const FVector2D& InSize,
    const FVector2D& ProposedPlacement,
    const EPopUpOrientation::Type Orien...,
    FVector2D*const CalculatedPopU...
)

Classes

Name

Description

Public class

FOnDisplayMetricsChanged

Public class

FVirtualKeyboardHiddenEvent

Public class

FVirtualKeyboardShownEvent

Delegate for virtual keyboard being shown/hidden in case UI wants to slide out of the way

Typedefs