LKeyboardModifiersEvent Class Reference

Keyboard modifiers event. More...

#include <LKeyboardModifiersEvent.h>

Inheritance diagram for LKeyboardModifiersEvent:

Classes
struct	Modifiers
	Keyboard modifiers. More...

Public Member Functions
	LKeyboardModifiersEvent (const Modifiers &modifiers={0, 0, 0, 0}, UInt32 serial=LTime::nextSerial(), UInt32 ms=LTime::ms(), UInt64 us=LTime::us(), LInputDevice *device=nullptr) noexcept
	Constructor for LKeyboardModifiersEvent.
void	setModifiers (const Modifiers &modifiers) noexcept
	Sets the keyboard modifiers for this event.
const Modifiers &	modifiers () const noexcept
	Gets the keyboard modifiers for this event.
Public Member Functions inherited from LInputEvent
void	setDevice (LInputDevice *device) noexcept
	Sets the input device that originated the event.
LInputDevice *	device () const noexcept
	Gets the input device that originated this event.
Public Member Functions inherited from LEvent
	~LEvent () noexcept=default
	Destructor.
Type	type () const noexcept
	Retrieves the type of the event.
Subtype	subtype () const noexcept
	Retrieves the subtype of the event.
void	setSerial (UInt32 serial) noexcept
	Sets the serial of the event.
UInt32	serial () const noexcept
	Retrieves the serial of the event.
void	setMs (UInt32 ms) noexcept
	Sets the time the event was generated in milliseconds.
UInt32	ms () const noexcept
	Retrieves the time the event was generated in milliseconds.
void	setUs (UInt32 us) noexcept
	Sets the time the event was generated in microseconds.
UInt64	us () const noexcept
	Retrieves the time the event was generated in microseconds.
LEvent *	copy () const noexcept
	Creates a deep copy of the event.

Additional Inherited Members
Public Types inherited from LEvent
enum class	Type : UInt8
	Defines the type of event. More...
enum class	Subtype : UInt8
	Defines the subtype of event. More...

Detailed Description

Keyboard modifiers event.

Keyboard modifiers events are automatically sent to client surfaces when they acquire keyboard focus.

---

Class Documentation

Louvre::LKeyboardModifiersEvent::Modifiers

struct Louvre::LKeyboardModifiersEvent::Modifiers

Keyboard modifiers.

Class Members
UInt32	depressed = 0	Active modifiers when physically pressed.
UInt32	latched = 0	Hooked modifiers that will be disabled after a non-modifier key is pressed.
UInt32	locked = 0	Active modifiers until they are pressed again (e.g. the Shift key)
UInt32	group = 0	Group the above states (use this value if the source of a modifier change is not of your interest)

Constructor & Destructor Documentation

LKeyboardModifiersEvent()

LKeyboardModifiersEvent ( const Modifiers &  modifiers = {0, 0, 0, 0}, UInt32  serial = LTime::nextSerial(), UInt32  ms = LTime::ms(), UInt64  us = LTime::us(), LInputDevice *  device = nullptr  )

inlinenoexcept

Constructor for LKeyboardModifiersEvent.

Parameters

modifiers	The keyboard modifiers to be set.
serial	The serial number of the event.
ms	The millisecond timestamp of the event.
us	The microsecond timestamp of the event.
device	The input device that originated the event.

Member Function Documentation

setModifiers()

void setModifiers ( const Modifiers &  modifiers )

inlinenoexcept

Sets the keyboard modifiers for this event.

modifiers()

const Modifiers & modifiers ( ) const

inlinenoexcept

Gets the keyboard modifiers for this event.