GHOST_IEvent Class Reference

#include <GHOST_IEvent.hh>

Inherited by GHOST_Event.

Public Member Functions
virtual	~GHOST_IEvent ()
virtual GHOST_TEventType	getType () const =0
virtual uint64_t	getTime () const =0
virtual GHOST_IWindow *	getWindow () const =0
virtual GHOST_TEventDataPtr	getData () const =0

Detailed Description

Interface class for events received from GHOST. You should not need to inherit this class. The system will pass these events to the GHOST_IEventConsumer::processEvent() method of event consumers.
Use the getType() method to retrieve the type of event and the getData() method to get the event data out. Using the event type you can cast the event data to the correct event data structure.

See also

GHOST_IEventConsumer::processEvent

GHOST_TEventType

Definition at line 27 of file GHOST_IEvent.hh.

Constructor & Destructor Documentation

~GHOST_IEvent()

virtual GHOST_IEvent::~GHOST_IEvent ( )

inlinevirtual

Destructor.

Definition at line 32 of file GHOST_IEvent.hh.

Member Function Documentation

getData()

virtual GHOST_TEventDataPtr GHOST_IEvent::getData ( ) const

pure virtual

Returns the event data.

Returns

The event data.

Implemented in GHOST_Event.

Referenced by GHOST_GetEventData(), and Application::processEvent().

getTime()

virtual uint64_t GHOST_IEvent::getTime ( ) const

pure virtual

Returns the time this event was generated.

Returns

The event generation time.

Implemented in GHOST_Event.

Referenced by GHOST_GetEventTime(), and GHOST_EventPrinter::processEvent().

getType()

virtual GHOST_TEventType GHOST_IEvent::getType ( ) const

pure virtual

Returns the event type.

Returns

The event type.

Implemented in GHOST_Event.

Referenced by GHOST_GetEventType(), Application::processEvent(), and GHOST_EventPrinter::processEvent().

getWindow()

virtual GHOST_IWindow * GHOST_IEvent::getWindow ( ) const

pure virtual

Returns the window this event was generated on, or nullptr if it is a 'system' event.

Returns

The generating window.

Implemented in GHOST_Event.

Referenced by GHOST_GetEventWindow().

---

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

• GHOST_IEvent.hh