Public Types | Public Member Functions | Public Attributes | List of all members
Window Class Referenceabstract

#include <window.h>

Public Types

using EventPtrList = std::vector< EventPtr >
using EventPtrConstIterator = utility::UniquePtrConstVectorWrapper< WindowEventPtrList, Event * >

Public Member Functions

void addEvent (WindowEventPtr inEvent)
void processEvents ()
virtual uint getNumber () const =0
EventPtrConstIterator GetEvents () const
- Public Member Functions inherited from Resource
 Resource ()
- Public Member Functions inherited from Object
 Object ()
virtual ~Object ()
virtual bool init (utility::ErrorState &errorState)
virtual void onDestroy ()
 Object (Object &)=delete
Objectoperator= (const Object &)=delete
 Object (Object &&)=delete
Objectoperator= (Object &&)=delete

Public Attributes

Signal< const WindowEvent & > mWindowEvent
- Public Attributes inherited from Object
std::string mID
 Property: 'mID' unique name of the object. Used as an identifier by the system. More...

Additional Inherited Members

- Static Public Member Functions inherited from Object
static bool isIDProperty (rtti::Instance &object, const rtti::Property &property)


This is the Window abstraction that has no relationship to any physical or visible Window. Instead it is meant to provide an abstract way of dealing with events, making it suitable for dealing with input and window related messages, without relying on any platform or graphics API.

Inheritance diagram for Window:
Collaboration diagram for Window:

Member Typedef Documentation

◆ EventPtrConstIterator

◆ EventPtrList

using EventPtrList = std::vector<EventPtr>

Member Function Documentation

◆ addEvent()

void addEvent ( WindowEventPtr  inEvent)

Adds an event to the queue, to be processed later.

inEventThe event to add, ownership is transfered here.

◆ GetEvents()

EventPtrConstIterator GetEvents ( ) const
all queued events. Queue is not cleared.

◆ getNumber()

virtual uint getNumber ( ) const
pure virtual
the associated window number

Implemented in RenderWindow.

◆ processEvents()

void processEvents ( )

Processes the queue that was built up in addEvent. Sends all the queued events by signaling onEvent. After processing, the queue is cleared.

Member Data Documentation

◆ mWindowEvent

Signal<const WindowEvent&> mWindowEvent