diff options
| -rw-r--r-- | slideshow/source/inc/eventqueue.hxx | 39 |
1 files changed, 25 insertions, 14 deletions
diff --git a/slideshow/source/inc/eventqueue.hxx b/slideshow/source/inc/eventqueue.hxx index 4334e4a9053c..bbcabfd293eb 100644 --- a/slideshow/source/inc/eventqueue.hxx +++ b/slideshow/source/inc/eventqueue.hxx @@ -4,9 +4,9 @@ * * $RCSfile: eventqueue.hxx,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: rt $ $Date: 2005-09-07 21:11:43 $ + * last change: $Author: rt $ $Date: 2006-02-09 14:49:14 $ * * The Contents of this file are made available subject to * the terms of GNU Lesser General Public License Version 2.1. @@ -71,25 +71,36 @@ namespace presentation /** Process the event queue. - This method performs the smallest atomic processing - possible on the queue (typically, this means one event - get processed). + This method executes all events whose timeout has + expired when calling this method (i.e. all events + whose scheduled time is less or equal the current + time). - @return Timeout in seconds, until the next event is - ready. The time returned here is relative to the pres - timer (i.e. the timer specified at the EventQueue - constructor). When the queue is empty (i.e. isEmpty() - returns true), the returned value is the highest - representable double value - (::std::numeric_limits<double>::max()). + Check for the next available event's timeout via + nextTimeout(), or whether the queue is empty + altogether via isEmpty(). */ - double process(); + void process(); /** Query state of the queue @return false, if queue is empty, true otherwise */ - bool isEmpty(); + bool isEmpty() const; + + /** Query timeout for the topmost event in the queue. + + @return Timeout in seconds, until the next event is + ready. The time returned here is relative to the pres + timer (i.e. the timer specified at the EventQueue + constructor). When the queue is empty (i.e. isEmpty() + returns true), the returned value is the highest + representable double value + (::std::numeric_limits<double>::max()). If the topmost + event in the queue is already pending, the timeout + returned here will actually be negative. + */ + double nextTimeout() const; /** Remove all pending events from the queue. */ |