X-Git-Url: https://git.brokenzipper.com/gitweb?a=blobdiff_plain;f=otk%2Ftimerqueuemanager.hh;h=042ede4c6c2ff035b67f007b3a4851adfb081c6b;hb=4c71c71d57e87c5273e09976fbac5b3a2f83bc52;hp=48e15e5b2cf283ef1ebe7c4dcd712a565f924ce9;hpb=b0a532db8adeb909fa2cd8e518ca6917a2d7df0a;p=chaz%2Fopenbox

diff --git a/otk/timerqueuemanager.hh b/otk/timerqueuemanager.hh
index 48e15e5b..042ede4c 100644
--- a/otk/timerqueuemanager.hh
+++ b/otk/timerqueuemanager.hh
@@ -1,4 +1,4 @@
-// -*- mode: C++; indent-tabs-mode: nil; -*-
+// -*- mode: C++; indent-tabs-mode: nil; c-basic-offset: 2; -*-
 #ifndef __timerqueuemanager_hh
 #define __timerqueuemanager_hh
 
@@ -6,38 +6,39 @@
 
 namespace otk {
 
-//! Manages a queue of OBTimer objects
+//! Manages a queue of Timer objects
 /*!
-  All OBTimer objects add themself to an OBTimerQueueManager. The manager is
+  All Timer objects add themself to a TimerQueueManager. The manager is
   what fires the timers when their time has elapsed. This is done by having the
-  application call the OBTimerQueueManager::fire class in its main event loop.
+  application call the TimerQueueManager::fire class in its main event loop.
 */
-class OBTimerQueueManager {
+class TimerQueueManager {
 private:
   //! A priority queue of all timers being managed by this class.
   TimerQueue timerList;
 public:
-  //! Constructs a new OBTimerQueueManager
-  OBTimerQueueManager() {}
-  //! Destroys the OBTimerQueueManager
-  virtual ~OBTimerQueueManager() {}
+  //! Constructs a new TimerQueueManager
+  TimerQueueManager() {}
+  //! Destroys the TimerQueueManager
+  virtual ~TimerQueueManager() {}
 
-  //! Will wait for and fire the next timer in the queue.
+  //! Fire the next timer in the queue.
   /*!
-    The function will stop waiting if an event is received from the X server.
+    @param wait If true, this function will wait for the next timer, breaking
+                on any events from the X server.
   */
-  virtual void fire();
+  virtual void fire(bool wait = true);
 
   //! Adds a new timer to the queue
   /*!
-    @param timer An OBTimer to add to the queue
+    @param timer An Timer to add to the queue
   */
-  virtual void addTimer(OBTimer* timer);
+  virtual void addTimer(Timer* timer);
   //! Removes a timer from the queue
   /*!
-    @param timer An OBTimer already in the queue to remove
+    @param timer An Timer already in the queue to remove
   */
-  virtual void removeTimer(OBTimer* timer);
+  virtual void removeTimer(Timer* timer);
 };
 
 }