Event Struct Reference

A single event that has information about the event and state for the event. More...

Inheritance diagram for Event:

Public Member Functions
constexpr	Event () noexcept=default
constexpr	Event (EventId id) noexcept
constexpr	Event (EventId id, const Key &key) noexcept
constexpr	Event (EventId id, const Pointer &pointer) noexcept
void	grab (Widget *widget)
	Grab any related following events to this one. More...
EGT_NODISCARD const EventId &	id () const noexcept
	Get the id of the event. More...
void	id (EventId id)
	Change the id of the event. More...
Key &	key ()
	Get the Key event data. More...
EGT_NODISCARD const Key &	key () const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...
Pointer &	pointer ()
	Get the Pointer event data. More...
EGT_NODISCARD const Pointer &	pointer () const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...
Public Member Functions inherited from EventArg
EGT_NODISCARD bool	quit () const
	Was the event stopped from propagating? More...
void	stop ()
	Stop the event from propagating. More...

Protected Attributes
EventId	m_id {EventId::none}
	The EventId. More...
Key	m_key
	Key event data. More...
Pointer	m_pointer
	Pointer event data. More...
Protected Attributes inherited from EventArg
bool	m_stop {false}
	Is the event stopped. More...

Detailed Description

A single event that has information about the event and state for the event.

Constructor & Destructor Documentation

Event() [1/4]

constexpr Event ( )

constexprdefaultnoexcept

Event() [2/4]

constexpr Event ( EventId  id )

inlineexplicitconstexprnoexcept

Parameters

[in]

id

Event id.

Event() [3/4]

constexpr Event ( EventId  id, const Pointer &  pointer  )

inlineconstexprnoexcept

Parameters

[in]	id	Event id.
[in]	pointer	Pointer data for the event.

Event() [4/4]

constexpr Event ( EventId  id, const Key &  key  )

inlineconstexprnoexcept

Parameters

[in]	id	Event id.
[in]	key	Key data for the event.

Member Function Documentation

grab()

void grab

(

Widget *

widget

)

Grab any related following events to this one.

Note

grab() implies stop().

id() [1/2]

EGT_NODISCARD const EventId& id ( ) const

inlinenoexcept

Get the id of the event.

id() [2/2]

void id ( EventId  id )

inline

Change the id of the event.

key() [1/2]

Key& key ( )

inline

Get the Key event data.

Only valid with the following events:

• EventId::keyboard_down,
• EventId::keyboard_up,
• EventId::keyboard_repeat,

key() [2/2]

EGT_NODISCARD const Key& key ( ) const

inline

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

pointer() [1/2]

Pointer& pointer ( )

inline

Get the Pointer event data.

Only valid with the following events:

• EventId::raw_pointer_down
• EventId::raw_pointer_up
• EventId::raw_pointer_move
• EventId::pointer_click
• EventId::pointer_dblclick
• EventId::pointer_hold
• EventId::pointer_drag_start
• EventId::pointer_drag
• EventId::pointer_drag_stop

pointer() [2/2]

EGT_NODISCARD const Pointer& pointer ( ) const

inline

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Member Data Documentation

m_id

EventId m_id {EventId::none}

protected

The EventId.

m_key

Key m_key

protected

Key event data.

m_pointer

Pointer m_pointer

protected

Pointer event data.