LPointerButtonEvent Class Reference

Pointer button event. More...

#include <LPointerButtonEvent.h>

Inheritance diagram for LPointerButtonEvent:

Public Types
enum	Button : UInt32
	Pointer buttons. More...
enum	State : UInt32
	Pointer button states. More...
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...

Public Member Functions
	LPointerButtonEvent (Button button=Left, State state=Pressed, UInt32 serial=LTime::nextSerial(), UInt32 ms=LTime::ms(), UInt64 us=LTime::us(), LInputDevice *device=nullptr) noexcept
	Constructs an LPointerButtonEvent object.
void	setButton (Button button) noexcept
	Sets the button code associated with the event.
Button	button () const noexcept
	Gets the button code associated with the event.
void	setState (State state) noexcept
	Sets the state of the button.
State	state () const noexcept
	Gets the state of the button.
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.

Detailed Description

Pointer button event.

Member Enumeration Documentation

Button

enum Button : UInt32

Pointer buttons.

Enumeration of common pointer buttons.

You can find the complete list of pointer button codes in the <linux/input-event-codes.h> header.

Enumerator
Left	Left button.
Right	Right button.
Middle	Middle button.
Side	Side button.
Extra	Extra button.
Forward	Forward button.
Back	Back button.
Task	Task button.

State

enum State : UInt32

Pointer button states.

Possible states of a pointer button.

Enumerator
Released	Button released.
Pressed	Button pressed.

Constructor & Destructor Documentation

LPointerButtonEvent()

LPointerButtonEvent ( Button  button = Left, State  state = Pressed, UInt32  serial = LTime::nextSerial(), UInt32  ms = LTime::ms(), UInt64  us = LTime::us(), LInputDevice *  device = nullptr  )

inlinenoexcept

Constructs an LPointerButtonEvent object.

Parameters

button	The button associated with the event.
state	The state of the button.
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

setButton()

void setButton ( Button  button )

inlinenoexcept

Sets the button code associated with the event.

button()

Button button ( ) const

inlinenoexcept

Gets the button code associated with the event.

setState()

void setState ( State  state )

inlinenoexcept

Sets the state of the button.

state()

State state ( ) const

inlinenoexcept

Gets the state of the button.