split the OBTimerQueueManager and TimerQueue into their own files

[chaz/openbox] / otk / timerqueuemanager.hh

diff --git a/otk/timerqueuemanager.hh b/otk/timerqueuemanager.hh
new file mode 100644 (file)
index 0000000..48e15e5
--- /dev/null
+++ b/otk/timerqueuemanager.hh
@@ -0,0 +1,45 @@
+// -*- mode: C++; indent-tabs-mode: nil; -*-
+#ifndef __timerqueuemanager_hh
+#define __timerqueuemanager_hh
+
+#include "timerqueue.hh"
+
+namespace otk {
+
+//! Manages a queue of OBTimer objects
+/*!
+  All OBTimer objects add themself to an OBTimerQueueManager. 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.
+*/
+class OBTimerQueueManager {
+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() {}
+
+  //! Will wait for and fire the next timer in the queue.
+  /*!
+    The function will stop waiting if an event is received from the X server.
+  */
+  virtual void fire();
+
+  //! Adds a new timer to the queue
+  /*!
+    @param timer An OBTimer to add to the queue
+  */
+  virtual void addTimer(OBTimer* timer);
+  //! Removes a timer from the queue
+  /*!
+    @param timer An OBTimer already in the queue to remove
+  */
+  virtual void removeTimer(OBTimer* timer);
+};
+
+}
+
+#endif // __timerqueuemanager_hh