FInputEvent

Base class for all mouse and keyevents.

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

SlateCore

Header

/Engine/Source/Runtime/SlateCore/Public/Input/Events.h

Include

#include "Input/Events.h"

Syntax

struct FInputEvent

Remarks

Base class for all mouse and keyevents.

Variables

Name Description

Protected variable

bool

 

bIsRepeat

True if this key was auto-repeated.

Protected variable

const FWidgetPa ...

 

EventPath

Events are sent along paths. See (GetEventPath).

Protected variable

FModifierKeysSt ...

 

ModifierKeys

State of modifier keys when this event happened.

Protected variable

uint32

 

UserIndex

The index of the user that caused the event.

Constructors

Name Description

Public function

FInputEvent()

UStruct Constructor. Not meant for normal usage.

Public function

FInputEvent

(
    const FModifierKeysState & InModifi...,
    const int32 InUserIndex,
    const bool bInIsRepeat
)

  1. Events are immutable once constructed.

Destructors

Name Description

Public function Virtual

~FInputEvent()

Virtual destructor.

Functions

Name Description

Public function Const

bool

 

AreCapsLocked()

Returns true if caps lock was on when this event occurred

Public function Const

FGeometry

 

FindGeometry

(
    const TSharedRef < SWidget >& Widge...
)

The event path provides additional context for handling

Public function Const

const FWidge ...

 

GetEventPath()

Public function Const

const FModif ...

 

GetModifierKeys()

Returns the complete set of modifier keys

Public function Const

uint32

 

GetUserIndex()

Returns the index of the user that generated this event.

Public function Const

TSharedRef < ...

 

GetWindow()

Public function Const

bool

 

IsAltDown()

Returns true if either alt key was down when this event occurred

Public function Const

bool

 

IsCommandDown()

Returns true if either command key was down when this event occurred

Public function Const

bool

 

IsControlDown()

Returns true if either control key was down when this event occurred

Public function Virtual Const

bool

 

IsKeyEvent()

Is this event a key event.

Public function Const

bool

 

IsLeftAltDown()

Returns true if left alt key was down when this event occurred

Public function Const

bool

 

IsLeftCommandDown()

Returns true if left command key was down when this event occurred

Public function Const

bool

 

IsLeftControlDown()

Returns true if left control key was down when this event occurred

Public function Const

bool

 

IsLeftShiftDown()

Returns true if left shift key was down when this event occurred

Public function Virtual Const

bool

 

IsPointerEvent()

Is this event a pointer event (touch or cursor).

Public function Const

bool

 

IsRepeat()

Returns whether or not this character is an auto-repeated keystroke

Public function Const

bool

 

IsRightAltDown()

Returns true if right alt key was down when this event occurred

Public function Const

bool

 

IsRightCommandDown()

Returns true if right command key was down when this event occurred

Public function Const

bool

 

IsRightControlDown()

Returns true if right control key was down when this event occurred

Public function Const

bool

 

IsRightShiftDown()

Returns true if right shift key was down when this event occurred

Public function Const

bool

 

IsShiftDown()

Returns true if either shift key was down when this event occurred

Public function

void

 

SetEventPath

(
    const FWidgetPath & InEventPath
)

Set the widget path along which this event will be routed

Public function Virtual Const

FText

 

ToText()

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback