FGenericApplicationMessageHandler

Interface that defines how to handle interaction with a user via hardware input and output

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

ApplicationCore

Header

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

Include

#include "GenericPlatform/GenericApplicationMessageHandler.h"

Syntax

class FGenericApplicationMessageHandler

Remarks

Interface that defines how to handle interaction with a user via hardware input and output

Destructors

Functions

Name Description

Public function Virtual

bool

 

BeginReshapingWindow

(
    const TSharedRef< FGenericWindow > ...
)

Public function Virtual

void

 

FinishedReshapingWindow

(
    const TSharedRef< FGenericWindow > ...
)

Public function Virtual Const

FWindowSizeL...

 

GetSizeLimitsForWindow

(
    const TSharedRef< FGenericWindow > ...
)

Public function Virtual

EWindowZone:...

 

GetWindowZoneForPoint

(
    const TSharedRef< FGenericWindow > ...,
    const int32 X,
    const int32 Y
)

Public function Virtual

void

 

HandleDPIScaleChanged

(
    const TSharedRef< FGenericWindow > ...
)

Public function Virtual

bool

 

OnApplicationActivationChanged

(
    const bool IsActive
)

Public function Virtual

void

 

OnBeginGesture()

Public function Virtual

bool

 

OnControllerAnalog

(
    FGamepadKeyNames::Type KeyName,
    int32 ControllerId,
    float AnalogValue
)

Deprecate these when engine code has been converted to handle platform user id.

Public function Virtual

bool

 

OnControllerAnalog

(
    FGamepadKeyNames::Type KeyName,
    FPlatformUserId PlatformUserId,
    float AnalogValue
)

Public function Virtual

bool

 

OnControllerButtonPressed

(
    FGamepadKeyNames::Type KeyName,
    FPlatformUserId PlatformUserId,
    bool IsRepeat
)

Public function Virtual

bool

 

OnControllerButtonPressed

(
    FGamepadKeyNames::Type KeyName,
    int32 ControllerId,
    bool IsRepeat
)

Public function Virtual

bool

 

OnControllerButtonReleased

(
    FGamepadKeyNames::Type KeyName,
    FPlatformUserId PlatformUserId,
    bool IsRepeat
)

Public function Virtual

bool

 

OnControllerButtonReleased

(
    FGamepadKeyNames::Type KeyName,
    int32 ControllerId,
    bool IsRepeat
)

Public function Virtual

bool

 

OnConvertibleLaptopModeChanged()

Public function Virtual

bool

 

OnCursorSet()

Public function Virtual

EDropEffect:...

 

OnDragDrop

(
    const TSharedPtr< FGenericWindow > ...
)

Public function Virtual

EDropEffect:...

 

OnDragEnterExternal

(
    const TSharedRef< FGenericWindow > ...,
    const FString& Text,
    const TArray< FString >& Files
)

Public function Virtual

EDropEffect:...

 

OnDragEnterFiles

(
    const TSharedRef< FGenericWindow > ...,
    const TArray< FString >& Files
)

Public function Virtual

EDropEffect:...

 

OnDragEnterText

(
    const TSharedRef< FGenericWindow > ...,
    const FString& Text
)

Public function Virtual

void

 

OnDragLeave

(
    const TSharedPtr< FGenericWindow > ...
)

Public function Virtual

EDropEffect:...

 

OnDragOver

(
    const TSharedPtr< FGenericWindow > ...
)

Public function Virtual

void

 

OnEndGesture()

Public function Virtual

void

 

OnInputLanguageChanged()

Public function Virtual

bool

 

OnKeyChar

(
    const TCHAR Character,
    const bool IsRepeat
)

Public function Virtual

bool

 

OnKeyDown

(
    const int32 KeyCode,
    const uint32 CharacterCode,
    const bool IsRepeat
)

Public function Virtual

bool

 

OnKeyUp

(
    const int32 KeyCode,
    const uint32 CharacterCode,
    const bool IsRepeat
)

Public function Virtual

bool

 

OnMotionDetected

(
    const FVector& Tilt,
    const FVector& RotationRate,
    const FVector& Gravity,
    const FVector& Acceleration,
    int32 ControllerId
)

Public function Virtual

bool

 

OnMotionDetected

(
    const FVector& Tilt,
    const FVector& RotationRate,
    const FVector& Gravity,
    const FVector& Acceleration,
    FPlatformUserId PlatformUserId
)

Public function Virtual

bool

 

OnMouseDoubleClick

(
    const TSharedPtr< FGenericWindow > ...,
    const EMouseButtons::Type Button,
    const FVector2D CursorPos
)

Public function Virtual

bool

 

OnMouseDoubleClick

(
    const TSharedPtr< FGenericWindow > ...,
    const EMouseButtons::Type Button
)

Public function Virtual

bool

 

OnMouseDown

(
    const TSharedPtr< FGenericWindow > ...,
    const EMouseButtons::Type Button,
    const FVector2D CursorPos
)

Public function Virtual

bool

 

OnMouseDown

(
    const TSharedPtr< FGenericWindow > ...,
    const EMouseButtons::Type Button
)

Public function Virtual

bool

 

OnMouseMove()

Public function Virtual

bool

 

OnMouseUp

(
    const EMouseButtons::Type Button
)

Public function Virtual

bool

 

OnMouseUp

(
    const EMouseButtons::Type Button,
    const FVector2D CursorPos
)

Public function Virtual

bool

 

OnMouseWheel

(
    const float Delta,
    const FVector2D CursorPos
)

Public function Virtual

bool

 

OnMouseWheel

(
    const float Delta
)

Public function Virtual

void

 

OnMovedWindow

(
    const TSharedRef< FGenericWindow > ...,
    const int32 X,
    const int32 Y
)

Public function Virtual

void

 

OnOSPaint

(
    const TSharedRef< FGenericWindow > ...
)

Public function Virtual

bool

 

OnRawMouseMove

(
    const int32 X,
    const int32 Y
)

Public function Virtual

void

 

OnResizingWindow

(
    const TSharedRef< FGenericWindow > ...
)

Public function Virtual

bool

 

OnSizeChanged

(
    const TSharedRef< FGenericWindow > ...,
    const int32 Width,
    const int32 Height,
    bool bWasMinimized
)

Public function Virtual

bool

 

OnTouchEnded

(
    const FVector2D& Location,
    int32 TouchIndex,
    int32 ControllerId
)

Public function Virtual

bool

 

OnTouchEnded

(
    const FVector2D& Location,
    int32 TouchIndex,
    FPlatformUserId PlatformUserId
)

Public function Virtual

bool

 

OnTouchFirstMove

(
    const FVector2D& Location,
    float Force,
    int32 TouchIndex,
    FPlatformUserId PlatformUserId
)

Public function Virtual

bool

 

OnTouchFirstMove

(
    const FVector2D& Location,
    float Force,
    int32 TouchIndex,
    int32 ControllerId
)

Public function Virtual

bool

 

OnTouchForceChanged

(
    const FVector2D& Location,
    float Force,
    int32 TouchIndex,
    FPlatformUserId PlatformUserId
)

Public function Virtual

bool

 

OnTouchForceChanged

(
    const FVector2D& Location,
    float Force,
    int32 TouchIndex,
    int32 ControllerId
)

Public function Virtual

bool

 

OnTouchGesture

(
    EGestureEvent GestureType,
    const FVector2D& Delta,
    float WheelDelta,
    bool bIsDirectionInvertedFromDevice
)

Public function Virtual

bool

 

OnTouchMoved

(
    const FVector2D& Location,
    float Force,
    int32 TouchIndex,
    FPlatformUserId PlatformUserId
)

Public function Virtual

bool

 

OnTouchMoved

(
    const FVector2D& Location,
    float Force,
    int32 TouchIndex,
    int32 ControllerId
)

Public function Virtual

bool

 

OnTouchStarted

(
    const TSharedPtr< FGenericWindow > ...,
    const FVector2D& Location,
    float Force,
    int32 TouchIndex,
    int32 ControllerId
)

Public function Virtual

bool

 

OnTouchStarted

(
    const TSharedPtr< FGenericWindow > ...,
    const FVector2D& Location,
    float Force,
    int32 TouchIndex,
    FPlatformUserId PlatformUserId
)

Public function Virtual

bool

 

OnWindowAction

(
    const TSharedRef< FGenericWindow > ...,
    const EWindowAction::Type InActionT...
)

Public function Virtual

bool

 

OnWindowActivationChanged

(
    const TSharedRef< FGenericWindow > ...,
    const EWindowActivation ActivationT...
)

Public function Virtual

void

 

OnWindowClose

(
    const TSharedRef< FGenericWindow > ...
)

Public function Virtual

void

 

SetCursorPos

(
    const FVector2D& MouseCoordinate
)

Public function Virtual Const

bool

 

ShouldProcessUserInputMessages

(
    const TSharedPtr< FGenericWindow > ...
)

Public function Virtual

void

 

ShouldSimulateGesture

(
    EGestureEvent Gesture,
    bool bEnable
)

Public function Virtual Const

bool

 

ShouldUsePlatformUserId()

Return true if this message handler expects FPlatformUserIds.

Public function Virtual

void

 

SignalSystemDPIChanged

(
    const TSharedRef< FGenericWindow > ...
)