Event Class Reference

Event. More...

#include <Event.h>

Classes
struct	EventFlags

Public Types
using	Flags = uint32_t

Public Member Functions
	Event ()=default
	Event (const Event &)=delete
	Event (Event &&other)=default
Event &	operator= (const Event &)=delete
Event &	operator= (Event &&)=default
	Event (EventTypes type, void *target=nullptr, void *data=nullptr, Flags flags=EventFlags::NoFlags)
	Create Event with data (POD).
	Event (EventTypes type, void *target, EventData *dataObject)

accessors
EventTypes	getType () const
	Get event type.
void *	getTarget () const
	Get the event target.
void *	getData () const
	Get the event data (POD).
EventData *	getDataObject () const
	Get the event data (non-POD).
Flags	getFlags () const
	Get event flags.

manipulators
void	setDataObject (EventData *dataObject)
	Set data (non-POD).
static void	deleteData (const Event &event)
	Release event data.

Detailed Description

Event.

Event holds an event type and a pointer to event data. It is movable, but not copyable

Member Typedef Documentation

Flags

using Event::Flags = uint32_t

Constructor & Destructor Documentation

Event() [1/5]

Event::Event ( )

default

Event() [2/5]

Event::Event ( const Event & )

delete

Event() [3/5]

Event::Event ( Event && other )

default

Event() [4/5]

Event::Event ( EventTypes type, void * target = nullptr, void * data = nullptr, Flags flags = EventFlags::NoFlags )

inlineexplicit

Create Event with data (POD).

The data must be POD (plain old data) allocated by malloc(), which means it cannot have a constructor, destructor or be composed of any types that do. For non-POD (normal C++ objects use setDataObject() or use appropriate constructor. target is the intended recipient of the event. flags is any combination of Flags.

Event() [5/5]

Event::Event ( EventTypes type, void * target, EventData * dataObject )

inline

Member Function Documentation

deleteData()

void Event::deleteData ( const Event & event )

inlinestatic

Release event data.

Deletes event data for the given event (using free()).

getData()

void * Event::getData ( ) const

inline

Get the event data (POD).

Returns the event data (POD).

getDataObject()

EventData * Event::getDataObject ( ) const

inline

Get the event data (non-POD).

Returns the event data (non-POD). The difference between this and getData() is that when delete is called on this data, so non-POD (non plain old data) dtor is called.

getFlags()

Flags Event::getFlags ( ) const

inline

Get event flags.

Returns the event flags.

getTarget()

void * Event::getTarget ( ) const

inline

Get the event target.

Returns the event target.

getType()

EventTypes Event::getType ( ) const

inline

Get event type.

Returns the event type.

operator=() [1/2]

Event & Event::operator= ( const Event & )

delete

operator=() [2/2]

Event & Event::operator= ( Event && )

default

setDataObject()

void Event::setDataObject ( EventData * dataObject )

inline

Set data (non-POD).

Set non-POD (non plain old data), where delete is called when the event is deleted, and the destructor is called.

---

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

• src/lib/base/Event.h