UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Types | Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | List of all members
GenericApplication Class Reference

#include <GenericApplication.h>

+ Inheritance diagram for GenericApplication:

Public Types

typedef FOnConsoleCommandAdded::FDelegate FOnConsoleCommandListener
 

Public Member Functions

 DECLARE_MULTICAST_DELEGATE_OneParam (FOnConsoleCommandAdded, const FString &)
 
APPLICATIONCORE_API GenericApplication (const TSharedPtr< ICursor > &InCursor)
 
virtual APPLICATIONCORE_API ~GenericApplication ()
 
virtual void SetMessageHandler (const TSharedRef< FGenericApplicationMessageHandler > &InMessageHandler)
 
TSharedRef< FGenericApplicationMessageHandler > GetMessageHandler ()
 
virtual void PollGameDeviceState (const float TimeDelta)
 
virtual void PumpMessages (const float TimeDelta)
 
virtual void ProcessDeferredEvents (const float TimeDelta)
 
virtual void Tick (const float TimeDelta)
 
virtual TSharedRef< FGenericWindow > MakeWindow ()
 
virtual void InitializeWindow (const TSharedRef< FGenericWindow > &Window, const TSharedRef< FGenericWindowDefinition > &InDefinition, const TSharedPtr< FGenericWindow > &InParent, const bool bShowImmediately)
 
virtual void SetCapture (const TSharedPtr< FGenericWindow > &InWindow)
 
virtual void * GetCapture (void) const
 
virtual FModifierKeysState GetModifierKeys () const
 
virtual bool IsCursorDirectlyOverSlateWindow () const
 
virtual TSharedPtr< FGenericWindow > GetWindowUnderCursor ()
 
virtual bool IsMinimized () const
 
virtual void SetHighPrecisionMouseMode (const bool Enable, const TSharedPtr< FGenericWindow > &InWindow)
 
virtual bool IsUsingHighPrecisionMouseMode () const
 
virtual bool IsUsingTrackpad () const
 
virtual bool IsMouseAttached () const
 
virtual bool IsGamepadAttached () const
 
virtual void RegisterConsoleCommandListener (const FOnConsoleCommandListener &InListener)
 
virtual void AddPendingConsoleCommand (const FString &InCommand)
 
virtual FPlatformRect GetWorkArea (const FPlatformRect &CurrentWindow) const
 
virtual bool TryCalculatePopupWindowPosition (const FPlatformRect &InAnchor, const FVector2D &InSize, const FVector2D &ProposedPlacement, const EPopUpOrientation::Type Orientation, FVector2D *const CalculatedPopUpPosition) const
 
 DECLARE_EVENT_OneParam (GenericApplication, FOnDisplayMetricsChanged, const FDisplayMetrics &)
 
FOnDisplayMetricsChanged & OnDisplayMetricsChanged ()
 
virtual void GetInitialDisplayMetrics (FDisplayMetrics &OutDisplayMetrics) const
 
 DECLARE_EVENT_OneParam (FSlateApplication, FVirtualKeyboardShownEvent, FPlatformRect)
 
FVirtualKeyboardShownEvent & OnVirtualKeyboardShown ()
 
 DECLARE_EVENT (FSlateApplication, FVirtualKeyboardHiddenEvent)
 
FVirtualKeyboardHiddenEvent & OnVirtualKeyboardHidden ()
 
 DECLARE_EVENT (FSlateApplication, FOnClipboardContentChanged)
 
FOnClipboardContentChanged & OnClipboardContentChanged ()
 
virtual EWindowTitleAlignment::Type GetWindowTitleAlignment () const
 
virtual EWindowTransparency GetWindowTransparencySupport () const
 
virtual void DestroyApplication ()
 
virtual IInputInterface * GetInputInterface ()
 
virtual ITextInputMethodSystem * GetTextInputMethodSystem ()
 
virtual void SendAnalytics (IAnalyticsProvider *Provider)
 
virtual bool SupportsSystemHelp () const
 
virtual void ShowSystemHelp ()
 
virtual bool ApplicationLicenseValid (FPlatformUserId PlatformUser=PLATFORMUSERID_NONE)
 
virtual bool IsAllowedToRender () const
 
virtual void FinishedInputThisFrame ()
 

Public Attributes

const TSharedPtr< ICursor > Cursor
 

Protected Member Functions

void BroadcastDisplayMetricsChanged (const FDisplayMetrics &InMetrics)
 

Protected Attributes

TSharedRef< class FGenericApplicationMessageHandler > MessageHandler
 
FOnDisplayMetricsChanged OnDisplayMetricsChangedEvent
 
FVirtualKeyboardShownEvent VirtualKeyboardShownEvent
 
FVirtualKeyboardHiddenEvent VirtualKeyboardHiddenEvent
 
FOnClipboardContentChanged OnClipboardContentChangedEvent
 

Detailed Description

Generic platform application interface

Member Typedef Documentation

◆ FOnConsoleCommandListener

typedef FOnConsoleCommandAdded::FDelegate GenericApplication::FOnConsoleCommandListener

Constructor & Destructor Documentation

◆ GenericApplication()

GenericApplication::GenericApplication ( const TSharedPtr< ICursor > &  InCursor)

◆ ~GenericApplication()

GenericApplication::~GenericApplication ( )
virtualdefault

Member Function Documentation

◆ AddPendingConsoleCommand()

virtual void GenericApplication::AddPendingConsoleCommand ( const FString &  InCommand)
inlinevirtual

◆ ApplicationLicenseValid()

virtual bool GenericApplication::ApplicationLicenseValid ( FPlatformUserId  PlatformUser = PLATFORMUSERID_NONE)
inlinevirtual

◆ BroadcastDisplayMetricsChanged()

void GenericApplication::BroadcastDisplayMetricsChanged ( const FDisplayMetrics &  InMetrics)
inlineprotected

Trigger the OnDisplayMetricsChanged event with the argument 'InMetrics'

◆ DECLARE_EVENT() [1/2]

GenericApplication::DECLARE_EVENT ( FSlateApplication  ,
FOnClipboardContentChanged   
)

◆ DECLARE_EVENT() [2/2]

GenericApplication::DECLARE_EVENT ( FSlateApplication  ,
FVirtualKeyboardHiddenEvent   
)

◆ DECLARE_EVENT_OneParam() [1/2]

GenericApplication::DECLARE_EVENT_OneParam ( FSlateApplication  ,
FVirtualKeyboardShownEvent  ,
FPlatformRect   
)

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

◆ DECLARE_EVENT_OneParam() [2/2]

GenericApplication::DECLARE_EVENT_OneParam ( GenericApplication  ,
FOnDisplayMetricsChanged  ,
const FDisplayMetrics &   
)

◆ DECLARE_MULTICAST_DELEGATE_OneParam()

GenericApplication::DECLARE_MULTICAST_DELEGATE_OneParam ( FOnConsoleCommandAdded  ,
const FString &   
)

◆ DestroyApplication()

virtual void GenericApplication::DestroyApplication ( )
inlinevirtual

Reimplemented in FLinuxApplication, FNullApplication, and FWindowsApplication.

◆ FinishedInputThisFrame()

virtual void GenericApplication::FinishedInputThisFrame ( )
inlinevirtual

Reimplemented in FWindowsApplication.

◆ GetCapture()

virtual void * GenericApplication::GetCapture ( void  ) const
inlinevirtual

Reimplemented in FLinuxApplication, FNullApplication, and FWindowsApplication.

◆ GetInitialDisplayMetrics()

virtual void GenericApplication::GetInitialDisplayMetrics ( FDisplayMetrics &  OutDisplayMetrics) const
inlinevirtual

Reimplemented in FWindowsApplication.

◆ GetInputInterface()

virtual IInputInterface * GenericApplication::GetInputInterface ( )
inlinevirtual

Reimplemented in FAndroidApplication, FIOSApplication, FLinuxApplication, FMacApplication, FNullApplication, and FWindowsApplication.

◆ GetMessageHandler()

TSharedRef< FGenericApplicationMessageHandler > GenericApplication::GetMessageHandler ( )
inline

◆ GetModifierKeys()

virtual FModifierKeysState GenericApplication::GetModifierKeys ( ) const
inlinevirtual

Reimplemented in FLinuxApplication, FMacApplication, FNullApplication, and FWindowsApplication.

◆ GetTextInputMethodSystem()

virtual ITextInputMethodSystem * GenericApplication::GetTextInputMethodSystem ( )
inlinevirtual

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

Reimplemented in FMacApplication, and FWindowsApplication.

◆ GetWindowTitleAlignment()

virtual EWindowTitleAlignment::Type GenericApplication::GetWindowTitleAlignment ( ) const
inlinevirtual

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

Reimplemented in FMacApplication, and FWindowsApplication.

◆ GetWindowTransparencySupport()

virtual EWindowTransparency GenericApplication::GetWindowTransparencySupport ( ) const
inlinevirtual

Reimplemented in FLinuxApplication, FMacApplication, FNullApplication, and FWindowsApplication.

◆ GetWindowUnderCursor()

virtual TSharedPtr< FGenericWindow > GenericApplication::GetWindowUnderCursor ( )
inlinevirtual
Returns
Native window under the mouse cursor.

Reimplemented in FLinuxApplication, FMacApplication, and FNullApplication.

◆ GetWorkArea()

virtual FPlatformRect GenericApplication::GetWorkArea ( const FPlatformRect &  CurrentWindow) const
inlinevirtual

Reimplemented in FAndroidApplication, FIOSApplication, FLinuxApplication, FMacApplication, FNullApplication, and FWindowsApplication.

◆ InitializeWindow()

virtual void GenericApplication::InitializeWindow ( const TSharedRef< FGenericWindow > &  Window,
const TSharedRef< FGenericWindowDefinition > &  InDefinition,
const TSharedPtr< FGenericWindow > &  InParent,
const bool  bShowImmediately 
)
inlinevirtual

Reimplemented in FAndroidApplication, FIOSApplication, FLinuxApplication, FMacApplication, FNullApplication, and FWindowsApplication.

◆ IsAllowedToRender()

virtual bool GenericApplication::IsAllowedToRender ( ) const
inlinevirtual

◆ IsCursorDirectlyOverSlateWindow()

virtual bool GenericApplication::IsCursorDirectlyOverSlateWindow ( ) const
inlinevirtual
Returns
true if the system cursor is currently directly over a slate window.

Reimplemented in FLinuxApplication, FMacApplication, FNullApplication, and FWindowsApplication.

◆ IsGamepadAttached()

virtual bool GenericApplication::IsGamepadAttached ( ) const
inlinevirtual

Reimplemented in FAndroidApplication, FIOSApplication, FLinuxApplication, FMacApplication, FNullApplication, and FWindowsApplication.

◆ IsMinimized()

virtual bool GenericApplication::IsMinimized ( ) const
inlinevirtual

Reimplemented in FWindowsApplication.

◆ IsMouseAttached()

virtual bool GenericApplication::IsMouseAttached ( ) const
inlinevirtual

Reimplemented in FLinuxApplication, FNullApplication, and FWindowsApplication.

◆ IsUsingHighPrecisionMouseMode()

virtual bool GenericApplication::IsUsingHighPrecisionMouseMode ( ) const
inlinevirtual

Reimplemented in FLinuxApplication, FMacApplication, FNullApplication, and FWindowsApplication.

◆ IsUsingTrackpad()

virtual bool GenericApplication::IsUsingTrackpad ( ) const
inlinevirtual

Reimplemented in FMacApplication.

◆ MakeWindow()

virtual TSharedRef< FGenericWindow > GenericApplication::MakeWindow ( )
inlinevirtual

Reimplemented in FAndroidApplication, FIOSApplication, FLinuxApplication, FMacApplication, FNullApplication, and FWindowsApplication.

◆ OnClipboardContentChanged()

FOnClipboardContentChanged & GenericApplication::OnClipboardContentChanged ( )
inline

◆ OnDisplayMetricsChanged()

FOnDisplayMetricsChanged & GenericApplication::OnDisplayMetricsChanged ( )
inline

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

◆ OnVirtualKeyboardHidden()

FVirtualKeyboardHiddenEvent & GenericApplication::OnVirtualKeyboardHidden ( )
inline

◆ OnVirtualKeyboardShown()

FVirtualKeyboardShownEvent & GenericApplication::OnVirtualKeyboardShown ( )
inline

◆ PollGameDeviceState()

virtual void GenericApplication::PollGameDeviceState ( const float  TimeDelta)
inlinevirtual

Reimplemented in FAndroidApplication, FIOSApplication, FLinuxApplication, FMacApplication, FNullApplication, and FWindowsApplication.

◆ ProcessDeferredEvents()

virtual void GenericApplication::ProcessDeferredEvents ( const float  TimeDelta)
inlinevirtual

Reimplemented in FLinuxApplication, FMacApplication, FNullApplication, and FWindowsApplication.

◆ PumpMessages()

virtual void GenericApplication::PumpMessages ( const float  TimeDelta)
inlinevirtual

Reimplemented in FLinuxApplication, FMacApplication, FNullApplication, and FWindowsApplication.

◆ RegisterConsoleCommandListener()

virtual void GenericApplication::RegisterConsoleCommandListener ( const FOnConsoleCommandListener &  InListener)
inlinevirtual

◆ SendAnalytics()

virtual void GenericApplication::SendAnalytics ( IAnalyticsProvider *  Provider)
inlinevirtual

Send any analytics captured by the application

◆ SetCapture()

virtual void GenericApplication::SetCapture ( const TSharedPtr< FGenericWindow > &  InWindow)
inlinevirtual

Reimplemented in FLinuxApplication, FNullApplication, and FWindowsApplication.

◆ SetHighPrecisionMouseMode()

virtual void GenericApplication::SetHighPrecisionMouseMode ( const bool  Enable,
const TSharedPtr< FGenericWindow > &  InWindow 
)
inlinevirtual

Reimplemented in FLinuxApplication, FMacApplication, FNullApplication, and FWindowsApplication.

◆ SetMessageHandler()

virtual void GenericApplication::SetMessageHandler ( const TSharedRef< FGenericApplicationMessageHandler > &  InMessageHandler)
inlinevirtual

Reimplemented in FLinuxApplication, FMacApplication, FNullApplication, FWindowsApplication, FAndroidApplication, and FIOSApplication.

◆ ShowSystemHelp()

virtual void GenericApplication::ShowSystemHelp ( )
inlinevirtual

◆ SupportsSystemHelp()

virtual bool GenericApplication::SupportsSystemHelp ( ) const
inlinevirtual

◆ Tick()

virtual void GenericApplication::Tick ( const float  TimeDelta)
inlinevirtual

Reimplemented in FAndroidApplication.

◆ TryCalculatePopupWindowPosition()

virtual bool GenericApplication::TryCalculatePopupWindowPosition ( const FPlatformRect &  InAnchor,
const FVector2D &  InSize,
const FVector2D &  ProposedPlacement,
const EPopUpOrientation::Type  Orientation,
FVector2D *const  CalculatedPopUpPosition 
) const
inlinevirtual

Member Data Documentation

◆ Cursor

const TSharedPtr< ICursor > GenericApplication::Cursor

◆ MessageHandler

TSharedRef< class FGenericApplicationMessageHandler > GenericApplication::MessageHandler
protected

◆ OnClipboardContentChangedEvent

FOnClipboardContentChanged GenericApplication::OnClipboardContentChangedEvent
protected

Delegate for clipboard contents change

◆ OnDisplayMetricsChangedEvent

FOnDisplayMetricsChanged GenericApplication::OnDisplayMetricsChangedEvent
protected

◆ VirtualKeyboardHiddenEvent

FVirtualKeyboardHiddenEvent GenericApplication::VirtualKeyboardHiddenEvent
protected

Delegate for virtual keyboard being shown

◆ VirtualKeyboardShownEvent

FVirtualKeyboardShownEvent GenericApplication::VirtualKeyboardShownEvent
protected

Delegate for virtual keyboard being shown

The documentation for this class was generated from the following files: