- Your Widget Set For OpenGL
Main Page | Namespace List | Class Hierarchy | Class List | File List | Class Members | Related Pages

ufo::UAbstractDisplay Class Reference

Implements some platform independent methods of UDisplay. Provided for convenience. More...

#include <uabstractdisplay.hpp>

Inheritance diagram for ufo::UAbstractDisplay:

ufo::UDisplay ufo::UObject ufo::UCollectable ufo::UXDisplay List of all members.

Public Member Functions

virtual UImage * createImage (const std::string fileName)
virtual UImage * createImage (UImageIO *io)
virtual void addVolatileData (UVolatileData *vdata)
virtual void removeVolatileData (UVolatileData *vdata)
virtual void pushEvent (UEvent *e)
virtual bool dispatchEvent (UEvent *e)
virtual bool dispatchEvents (unsigned int nevents)
virtual bool dispatchEvents ()
virtual UEvent * getCurrentEvent () const
virtual int getEventCount () const
virtual UEvent * peekEvent () const
virtual UEvent * peekEvent (UEvent::Type type) const
virtual UEvent * pollEvent ()
virtual UMod_t getModState () const
virtual UMod_t getMouseState (int *x, int *y) const

Protected Member Functions

void setModState (UMod_t modifiers)
void checkTimerEvents ()

Detailed Description

Implements some platform independent methods of UDisplay. Provided for convenience.

This class is not part of the official UFO API and may be changed without warning.

Author:
Johannes Schmidt

Member Function Documentation

virtual bool ufo::UAbstractDisplay::dispatchEvent (  UEvent *  e  )  [virtual]
 

Dispatches immediately the given event without pushing it to the event queue. Updates the internal mouse and key states.

Parameters:
e The event which should be dispatched.
Returns:
True if a quit event was processed, otherwise false.

Implements ufo::UDisplay.

virtual bool ufo::UAbstractDisplay::dispatchEvents (   )  [virtual]
 

Dispatches all pending events of the event queues.

Returns:
True if a quit event was processed, otherwise false.

Implements ufo::UDisplay.

virtual bool ufo::UAbstractDisplay::dispatchEvents (  unsigned int  nevents  )  [virtual]
 

Dispatches nevents events to the receiver contexts. If the current event is a quit event, it returns immediately true without dispatching more events.

Returns:
True if a quit event was processed, otherwise false.

Implements ufo::UDisplay.

virtual UEvent* ufo::UAbstractDisplay::getCurrentEvent (   )  const [virtual]
 

Returns the event which is currently dispatched by this display object. Returns NULL if no event is currently dispatched.

Implements ufo::UDisplay.

virtual int ufo::UAbstractDisplay::getEventCount (   )  const [virtual]
 

Returns the number of pending events.

Implements ufo::UDisplay.

virtual UMod_t ufo::UAbstractDisplay::getModState (   )  const [virtual]
 

Returns the current state of the modifier keys (like CRTL, ALT, ..). Please note that the current mod state may differ from the current event you are processing. The current mod state is determinded by the last pushed event.

See also:
UInputEvent

Implements ufo::UDisplay.

virtual UMod_t ufo::UAbstractDisplay::getMouseState (  int *  x,
int *  y
)  const [virtual]
 

Returns the current button state as modifier mask. x and y are set to the current mouse position. Both may be NULL. The current mouse state is determinded by the last pushed event.

Parameters:
x filled with the x position of the mouse
y filled with the y position of the mouse
See also:
UInputEvent

Implements ufo::UDisplay.

virtual UEvent* ufo::UAbstractDisplay::peekEvent (  UEvent::Type  type  )  const [virtual]
 

Returns the first event on the event queue of the given type without removeing it.

Implements ufo::UDisplay.

virtual UEvent* ufo::UAbstractDisplay::peekEvent (   )  const [virtual]
 

Returns the first event on the event queue without removeing it.

Implements ufo::UDisplay.

virtual UEvent* ufo::UAbstractDisplay::pollEvent (   )  [virtual]
 

Returns the first event on the event queue and removes it from the event queue. The user takes control over this event and is responsible for unreferencing and deallocating.

Implements ufo::UDisplay.

virtual void ufo::UAbstractDisplay::pushEvent (  UEvent *  e  )  [virtual]
 

Adds e to the event queue. Updates the internal mouse and key states.

Implements ufo::UDisplay.

void ufo::UAbstractDisplay::setModState (  UMod_t  modifiers  )  [protected]
 

Manually sets the modifier state.

Reimplemented in ufo::UXDisplay.

The documentation for this class was generated from the following file:
The libUFO Project - written by Johannes Schmidt