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

#include <GenericApplicationMessageHandler.h>

+ Inheritance diagram for FGenericApplicationMessageHandler:

Public Member Functions

virtual ~FGenericApplicationMessageHandler ()
 
virtual bool ShouldProcessUserInputMessages (const TSharedPtr< FGenericWindow > &PlatformWindow) const
 
virtual bool OnKeyChar (const TCHAR Character, const bool IsRepeat)
 
virtual bool OnKeyDown (const int32 KeyCode, const uint32 CharacterCode, const bool IsRepeat)
 
virtual bool OnKeyUp (const int32 KeyCode, const uint32 CharacterCode, const bool IsRepeat)
 
virtual void OnInputLanguageChanged ()
 
virtual bool OnMouseDown (const TSharedPtr< FGenericWindow > &Window, const EMouseButtons::Type Button)
 
virtual bool OnMouseDown (const TSharedPtr< FGenericWindow > &Window, const EMouseButtons::Type Button, const FVector2D CursorPos)
 
virtual bool OnMouseUp (const EMouseButtons::Type Button)
 
virtual bool OnMouseUp (const EMouseButtons::Type Button, const FVector2D CursorPos)
 
virtual bool OnMouseDoubleClick (const TSharedPtr< FGenericWindow > &Window, const EMouseButtons::Type Button)
 
virtual bool OnMouseDoubleClick (const TSharedPtr< FGenericWindow > &Window, const EMouseButtons::Type Button, const FVector2D CursorPos)
 
virtual bool OnMouseWheel (const float Delta)
 
virtual bool OnMouseWheel (const float Delta, const FVector2D CursorPos)
 
virtual bool OnMouseMove ()
 
virtual bool OnRawMouseMove (const int32 X, const int32 Y)
 
virtual bool OnCursorSet ()
 
virtual bool ShouldUsePlatformUserId () const
 
virtual bool OnControllerAnalog (FGamepadKeyNames::Type KeyName, FPlatformUserId PlatformUserId, FInputDeviceId InputDeviceId, float AnalogValue)
 
virtual bool OnControllerButtonPressed (FGamepadKeyNames::Type KeyName, FPlatformUserId PlatformUserId, FInputDeviceId InputDeviceId, bool IsRepeat)
 
virtual bool OnControllerButtonReleased (FGamepadKeyNames::Type KeyName, FPlatformUserId PlatformUserId, FInputDeviceId InputDeviceId, bool IsRepeat)
 
virtual void OnBeginGesture ()
 
virtual bool OnTouchGesture (EGestureEvent GestureType, const FVector2D &Delta, float WheelDelta, bool bIsDirectionInvertedFromDevice)
 
virtual void OnEndGesture ()
 
virtual bool OnTouchStarted (const TSharedPtr< FGenericWindow > &Window, const FVector2D &Location, float Force, int32 TouchIndex, FPlatformUserId PlatformUserId, FInputDeviceId DeviceId)
 
virtual bool OnTouchMoved (const FVector2D &Location, float Force, int32 TouchIndex, FPlatformUserId PlatformUserId, FInputDeviceId DeviceID)
 
virtual bool OnTouchEnded (const FVector2D &Location, int32 TouchIndex, FPlatformUserId PlatformUserId, FInputDeviceId DeviceID)
 
virtual bool OnTouchForceChanged (const FVector2D &Location, float Force, int32 TouchIndex, FPlatformUserId PlatformUserId, FInputDeviceId DeviceID)
 
virtual bool OnTouchFirstMove (const FVector2D &Location, float Force, int32 TouchIndex, FPlatformUserId PlatformUserId, FInputDeviceId DeviceID)
 
virtual void ShouldSimulateGesture (EGestureEvent Gesture, bool bEnable)
 
virtual bool OnMotionDetected (const FVector &Tilt, const FVector &RotationRate, const FVector &Gravity, const FVector &Acceleration, FPlatformUserId PlatformUserId, FInputDeviceId InputDeviceId)
 
virtual bool OnSizeChanged (const TSharedRef< FGenericWindow > &Window, const int32 Width, const int32 Height, bool bWasMinimized=false)
 
virtual void OnOSPaint (const TSharedRef< FGenericWindow > &Window)
 
virtual FWindowSizeLimits GetSizeLimitsForWindow (const TSharedRef< FGenericWindow > &Window) const
 
virtual void OnResizingWindow (const TSharedRef< FGenericWindow > &Window)
 
virtual bool BeginReshapingWindow (const TSharedRef< FGenericWindow > &Window)
 
virtual void FinishedReshapingWindow (const TSharedRef< FGenericWindow > &Window)
 
virtual void HandleDPIScaleChanged (const TSharedRef< FGenericWindow > &Window)
 
virtual void SignalSystemDPIChanged (const TSharedRef< FGenericWindow > &Window)
 
virtual void OnMovedWindow (const TSharedRef< FGenericWindow > &Window, const int32 X, const int32 Y)
 
virtual bool OnWindowActivationChanged (const TSharedRef< FGenericWindow > &Window, const EWindowActivation ActivationType)
 
virtual bool OnApplicationActivationChanged (const bool IsActive)
 
virtual bool OnConvertibleLaptopModeChanged ()
 
virtual EWindowZone::Type GetWindowZoneForPoint (const TSharedRef< FGenericWindow > &Window, const int32 X, const int32 Y)
 
virtual void OnWindowClose (const TSharedRef< FGenericWindow > &Window)
 
virtual EDropEffect::Type OnDragEnterText (const TSharedRef< FGenericWindow > &Window, const FString &Text)
 
virtual EDropEffect::Type OnDragEnterFiles (const TSharedRef< FGenericWindow > &Window, const TArray< FString > &Files)
 
virtual EDropEffect::Type OnDragEnterExternal (const TSharedRef< FGenericWindow > &Window, const FString &Text, const TArray< FString > &Files)
 
virtual EDropEffect::Type OnDragOver (const TSharedPtr< FGenericWindow > &Window)
 
virtual void OnDragLeave (const TSharedPtr< FGenericWindow > &Window)
 
virtual EDropEffect::Type OnDragDrop (const TSharedPtr< FGenericWindow > &Window)
 
virtual bool OnWindowAction (const TSharedRef< FGenericWindow > &Window, const EWindowAction::Type InActionType)
 
virtual void SetCursorPos (const FVector2D &MouseCoordinate)
 
virtual bool OnTouchStarted (const TSharedPtr< FGenericWindow > &Window, const FVector2D &Location, float Force, int32 TouchIndex, int32 ControllerId)
 
virtual bool OnTouchMoved (const FVector2D &Location, float Force, int32 TouchIndex, int32 ControllerId)
 
virtual bool OnTouchEnded (const FVector2D &Location, int32 TouchIndex, int32 ControllerId)
 
virtual bool OnTouchForceChanged (const FVector2D &Location, float Force, int32 TouchIndex, int32 ControllerId)
 
virtual bool OnTouchFirstMove (const FVector2D &Location, float Force, int32 TouchIndex, int32 ControllerId)
 
virtual bool OnMotionDetected (const FVector &Tilt, const FVector &RotationRate, const FVector &Gravity, const FVector &Acceleration, int32 ControllerId)
 

Detailed Description

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

Constructor & Destructor Documentation

◆ ~FGenericApplicationMessageHandler()

virtual FGenericApplicationMessageHandler::~FGenericApplicationMessageHandler ( )
inlinevirtual

Member Function Documentation

◆ BeginReshapingWindow()

virtual bool FGenericApplicationMessageHandler::BeginReshapingWindow ( const TSharedRef< FGenericWindow > &  Window)
inlinevirtual

Reimplemented in FSlateApplication.

◆ FinishedReshapingWindow()

virtual void FGenericApplicationMessageHandler::FinishedReshapingWindow ( const TSharedRef< FGenericWindow > &  Window)
inlinevirtual

Reimplemented in FSlateApplication.

◆ GetSizeLimitsForWindow()

virtual FWindowSizeLimits FGenericApplicationMessageHandler::GetSizeLimitsForWindow ( const TSharedRef< FGenericWindow > &  Window) const
inlinevirtual

Reimplemented in FSlateApplication.

◆ GetWindowZoneForPoint()

virtual EWindowZone::Type FGenericApplicationMessageHandler::GetWindowZoneForPoint ( const TSharedRef< FGenericWindow > &  Window,
const int32  X,
const int32  Y 
)
inlinevirtual

Reimplemented in FSlateApplication.

◆ HandleDPIScaleChanged()

virtual void FGenericApplicationMessageHandler::HandleDPIScaleChanged ( const TSharedRef< FGenericWindow > &  Window)
inlinevirtual

Reimplemented in FSlateApplication.

◆ OnApplicationActivationChanged()

virtual bool FGenericApplicationMessageHandler::OnApplicationActivationChanged ( const bool  IsActive)
inlinevirtual

Reimplemented in FSlateApplication.

◆ OnBeginGesture()

virtual void FGenericApplicationMessageHandler::OnBeginGesture ( )
inlinevirtual

◆ OnControllerAnalog()

virtual bool FGenericApplicationMessageHandler::OnControllerAnalog ( FGamepadKeyNames::Type  KeyName,
FPlatformUserId  PlatformUserId,
FInputDeviceId  InputDeviceId,
float  AnalogValue 
)
inlinevirtual

Reimplemented in FSlateApplication.

◆ OnControllerButtonPressed()

virtual bool FGenericApplicationMessageHandler::OnControllerButtonPressed ( FGamepadKeyNames::Type  KeyName,
FPlatformUserId  PlatformUserId,
FInputDeviceId  InputDeviceId,
bool  IsRepeat 
)
inlinevirtual

Reimplemented in FSlateApplication.

◆ OnControllerButtonReleased()

virtual bool FGenericApplicationMessageHandler::OnControllerButtonReleased ( FGamepadKeyNames::Type  KeyName,
FPlatformUserId  PlatformUserId,
FInputDeviceId  InputDeviceId,
bool  IsRepeat 
)
inlinevirtual

Reimplemented in FSlateApplication.

◆ OnConvertibleLaptopModeChanged()

virtual bool FGenericApplicationMessageHandler::OnConvertibleLaptopModeChanged ( )
inlinevirtual

Reimplemented in FSlateApplication.

◆ OnCursorSet()

virtual bool FGenericApplicationMessageHandler::OnCursorSet ( )
inlinevirtual

Reimplemented in FSlateApplication.

◆ OnDragDrop()

virtual EDropEffect::Type FGenericApplicationMessageHandler::OnDragDrop ( const TSharedPtr< FGenericWindow > &  Window)
inlinevirtual

Reimplemented in FSlateApplication.

◆ OnDragEnterExternal()

virtual EDropEffect::Type FGenericApplicationMessageHandler::OnDragEnterExternal ( const TSharedRef< FGenericWindow > &  Window,
const FString &  Text,
const TArray< FString > &  Files 
)
inlinevirtual

Reimplemented in FSlateApplication.

◆ OnDragEnterFiles()

virtual EDropEffect::Type FGenericApplicationMessageHandler::OnDragEnterFiles ( const TSharedRef< FGenericWindow > &  Window,
const TArray< FString > &  Files 
)
inlinevirtual

Reimplemented in FSlateApplication.

◆ OnDragEnterText()

virtual EDropEffect::Type FGenericApplicationMessageHandler::OnDragEnterText ( const TSharedRef< FGenericWindow > &  Window,
const FString &  Text 
)
inlinevirtual

Reimplemented in FSlateApplication.

◆ OnDragLeave()

virtual void FGenericApplicationMessageHandler::OnDragLeave ( const TSharedPtr< FGenericWindow > &  Window)
inlinevirtual

Reimplemented in FSlateApplication.

◆ OnDragOver()

virtual EDropEffect::Type FGenericApplicationMessageHandler::OnDragOver ( const TSharedPtr< FGenericWindow > &  Window)
inlinevirtual

Reimplemented in FSlateApplication.

◆ OnEndGesture()

virtual void FGenericApplicationMessageHandler::OnEndGesture ( )
inlinevirtual

◆ OnInputLanguageChanged()

virtual void FGenericApplicationMessageHandler::OnInputLanguageChanged ( )
inlinevirtual

Reimplemented in FSlateApplication.

◆ OnKeyChar()

virtual bool FGenericApplicationMessageHandler::OnKeyChar ( const TCHAR  Character,
const bool  IsRepeat 
)
inlinevirtual

Reimplemented in FSlateApplication.

◆ OnKeyDown()

virtual bool FGenericApplicationMessageHandler::OnKeyDown ( const int32  KeyCode,
const uint32  CharacterCode,
const bool  IsRepeat 
)
inlinevirtual

Reimplemented in FSlateApplication.

◆ OnKeyUp()

virtual bool FGenericApplicationMessageHandler::OnKeyUp ( const int32  KeyCode,
const uint32  CharacterCode,
const bool  IsRepeat 
)
inlinevirtual

Reimplemented in FSlateApplication.

◆ OnMotionDetected() [1/2]

virtual bool FGenericApplicationMessageHandler::OnMotionDetected ( const FVector &  Tilt,
const FVector &  RotationRate,
const FVector &  Gravity,
const FVector &  Acceleration,
FPlatformUserId  PlatformUserId,
FInputDeviceId  InputDeviceId 
)
inlinevirtual

Reimplemented in FSlateApplication.

◆ OnMotionDetected() [2/2]

virtual bool FGenericApplicationMessageHandler::OnMotionDetected ( const FVector &  Tilt,
const FVector &  RotationRate,
const FVector &  Gravity,
const FVector &  Acceleration,
int32  ControllerId 
)
inlinevirtual

◆ OnMouseDoubleClick() [1/2]

virtual bool FGenericApplicationMessageHandler::OnMouseDoubleClick ( const TSharedPtr< FGenericWindow > &  Window,
const EMouseButtons::Type  Button 
)
inlinevirtual

Reimplemented in FSlateApplication.

◆ OnMouseDoubleClick() [2/2]

virtual bool FGenericApplicationMessageHandler::OnMouseDoubleClick ( const TSharedPtr< FGenericWindow > &  Window,
const EMouseButtons::Type  Button,
const FVector2D  CursorPos 
)
inlinevirtual

Reimplemented in FSlateApplication.

◆ OnMouseDown() [1/2]

virtual bool FGenericApplicationMessageHandler::OnMouseDown ( const TSharedPtr< FGenericWindow > &  Window,
const EMouseButtons::Type  Button 
)
inlinevirtual

Reimplemented in FSlateApplication.

◆ OnMouseDown() [2/2]

virtual bool FGenericApplicationMessageHandler::OnMouseDown ( const TSharedPtr< FGenericWindow > &  Window,
const EMouseButtons::Type  Button,
const FVector2D  CursorPos 
)
inlinevirtual

Reimplemented in FSlateApplication.

◆ OnMouseMove()

virtual bool FGenericApplicationMessageHandler::OnMouseMove ( )
inlinevirtual

Reimplemented in FSlateApplication.

◆ OnMouseUp() [1/2]

virtual bool FGenericApplicationMessageHandler::OnMouseUp ( const EMouseButtons::Type  Button)
inlinevirtual

Reimplemented in FSlateApplication.

◆ OnMouseUp() [2/2]

virtual bool FGenericApplicationMessageHandler::OnMouseUp ( const EMouseButtons::Type  Button,
const FVector2D  CursorPos 
)
inlinevirtual

Reimplemented in FSlateApplication.

◆ OnMouseWheel() [1/2]

virtual bool FGenericApplicationMessageHandler::OnMouseWheel ( const float  Delta)
inlinevirtual

Reimplemented in FSlateApplication.

◆ OnMouseWheel() [2/2]

virtual bool FGenericApplicationMessageHandler::OnMouseWheel ( const float  Delta,
const FVector2D  CursorPos 
)
inlinevirtual

Reimplemented in FSlateApplication.

◆ OnMovedWindow()

virtual void FGenericApplicationMessageHandler::OnMovedWindow ( const TSharedRef< FGenericWindow > &  Window,
const int32  X,
const int32  Y 
)
inlinevirtual

Reimplemented in FSlateApplication.

◆ OnOSPaint()

virtual void FGenericApplicationMessageHandler::OnOSPaint ( const TSharedRef< FGenericWindow > &  Window)
inlinevirtual

Reimplemented in FSlateApplication.

◆ OnRawMouseMove()

virtual bool FGenericApplicationMessageHandler::OnRawMouseMove ( const int32  X,
const int32  Y 
)
inlinevirtual

Reimplemented in FSlateApplication.

◆ OnResizingWindow()

virtual void FGenericApplicationMessageHandler::OnResizingWindow ( const TSharedRef< FGenericWindow > &  Window)
inlinevirtual

Reimplemented in FSlateApplication.

◆ OnSizeChanged()

virtual bool FGenericApplicationMessageHandler::OnSizeChanged ( const TSharedRef< FGenericWindow > &  Window,
const int32  Width,
const int32  Height,
bool  bWasMinimized = false 
)
inlinevirtual

Reimplemented in FSlateApplication.

◆ OnTouchEnded() [1/2]

virtual bool FGenericApplicationMessageHandler::OnTouchEnded ( const FVector2D &  Location,
int32  TouchIndex,
FPlatformUserId  PlatformUserId,
FInputDeviceId  DeviceID 
)
inlinevirtual

Reimplemented in FSlateApplication.

◆ OnTouchEnded() [2/2]

virtual bool FGenericApplicationMessageHandler::OnTouchEnded ( const FVector2D &  Location,
int32  TouchIndex,
int32  ControllerId 
)
inlinevirtual

◆ OnTouchFirstMove() [1/2]

virtual bool FGenericApplicationMessageHandler::OnTouchFirstMove ( const FVector2D &  Location,
float  Force,
int32  TouchIndex,
FPlatformUserId  PlatformUserId,
FInputDeviceId  DeviceID 
)
inlinevirtual

Reimplemented in FSlateApplication.

◆ OnTouchFirstMove() [2/2]

virtual bool FGenericApplicationMessageHandler::OnTouchFirstMove ( const FVector2D &  Location,
float  Force,
int32  TouchIndex,
int32  ControllerId 
)
inlinevirtual

◆ OnTouchForceChanged() [1/2]

virtual bool FGenericApplicationMessageHandler::OnTouchForceChanged ( const FVector2D &  Location,
float  Force,
int32  TouchIndex,
FPlatformUserId  PlatformUserId,
FInputDeviceId  DeviceID 
)
inlinevirtual

Reimplemented in FSlateApplication.

◆ OnTouchForceChanged() [2/2]

virtual bool FGenericApplicationMessageHandler::OnTouchForceChanged ( const FVector2D &  Location,
float  Force,
int32  TouchIndex,
int32  ControllerId 
)
inlinevirtual

◆ OnTouchGesture()

virtual bool FGenericApplicationMessageHandler::OnTouchGesture ( EGestureEvent  GestureType,
const FVector2D &  Delta,
float  WheelDelta,
bool  bIsDirectionInvertedFromDevice 
)
inlinevirtual

Reimplemented in FSlateApplication.

◆ OnTouchMoved() [1/2]

virtual bool FGenericApplicationMessageHandler::OnTouchMoved ( const FVector2D &  Location,
float  Force,
int32  TouchIndex,
FPlatformUserId  PlatformUserId,
FInputDeviceId  DeviceID 
)
inlinevirtual

Reimplemented in FSlateApplication.

◆ OnTouchMoved() [2/2]

virtual bool FGenericApplicationMessageHandler::OnTouchMoved ( const FVector2D &  Location,
float  Force,
int32  TouchIndex,
int32  ControllerId 
)
inlinevirtual

◆ OnTouchStarted() [1/2]

virtual bool FGenericApplicationMessageHandler::OnTouchStarted ( const TSharedPtr< FGenericWindow > &  Window,
const FVector2D &  Location,
float  Force,
int32  TouchIndex,
FPlatformUserId  PlatformUserId,
FInputDeviceId  DeviceId 
)
inlinevirtual

Reimplemented in FSlateApplication.

◆ OnTouchStarted() [2/2]

virtual bool FGenericApplicationMessageHandler::OnTouchStarted ( const TSharedPtr< FGenericWindow > &  Window,
const FVector2D &  Location,
float  Force,
int32  TouchIndex,
int32  ControllerId 
)
inlinevirtual

◆ OnWindowAction()

virtual bool FGenericApplicationMessageHandler::OnWindowAction ( const TSharedRef< FGenericWindow > &  Window,
const EWindowAction::Type  InActionType 
)
inlinevirtual

Reimplemented in FSlateApplication.

◆ OnWindowActivationChanged()

virtual bool FGenericApplicationMessageHandler::OnWindowActivationChanged ( const TSharedRef< FGenericWindow > &  Window,
const EWindowActivation  ActivationType 
)
inlinevirtual

Reimplemented in FSlateApplication.

◆ OnWindowClose()

virtual void FGenericApplicationMessageHandler::OnWindowClose ( const TSharedRef< FGenericWindow > &  Window)
inlinevirtual

Reimplemented in FSlateApplication.

◆ SetCursorPos()

virtual void FGenericApplicationMessageHandler::SetCursorPos ( const FVector2D &  MouseCoordinate)
inlinevirtual

Reimplemented in FSlateApplication.

◆ ShouldProcessUserInputMessages()

virtual bool FGenericApplicationMessageHandler::ShouldProcessUserInputMessages ( const TSharedPtr< FGenericWindow > &  PlatformWindow) const
inlinevirtual

Reimplemented in FSlateApplication.

◆ ShouldSimulateGesture()

virtual void FGenericApplicationMessageHandler::ShouldSimulateGesture ( EGestureEvent  Gesture,
bool  bEnable 
)
inlinevirtual

Reimplemented in FSlateApplication.

◆ ShouldUsePlatformUserId()

virtual bool FGenericApplicationMessageHandler::ShouldUsePlatformUserId ( ) const
inlinevirtual

Return true if this message handler expects FPlatformUserIds. This base class will convert both directions. As part of a larger fixup to allow mapping of multiple input devices to the same player, physical device id will be passed as part of the InputScope above and used to compute a logical input user.

◆ SignalSystemDPIChanged()

virtual void FGenericApplicationMessageHandler::SignalSystemDPIChanged ( const TSharedRef< FGenericWindow > &  Window)
inlinevirtual

Reimplemented in FSlateApplication.

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