Fix crash with updateLabels(). I changed the the test in the assertion but endless...

[lyx.git] / src / graphics / LoaderQueue.h

diff --git a/src/graphics/LoaderQueue.h b/src/graphics/LoaderQueue.h
index aec1c9d7d8a4966dc9e35a261ddeb98c638009b5..2259d74a2f0ebb239ccbdc78f395b6699d95d00b 100644 (file)
--- a/src/graphics/LoaderQueue.h
+++ b/src/graphics/LoaderQueue.h
@@ -1,16 +1,16 @@
 // -*- C++ -*-
 /**
- *  \file LoaderQueue.h
+ * \file LoaderQueue.h
  * This file is part of LyX, the document processor.
  * Licence details can be found in the file COPYING.
  *
- *  \author Alfredo Braunstein
+ * \author Alfredo Braunstein
  *
- * Full author contact details are available in file CREDITS. 
+ * Full author contact details are available in file CREDITS.
  *
  * This implements a threaded service queue which loads images on background.
  * In order to request an image loading you call touch() with the pointer to
- * the cached image. Then it will try to satisfy the request as soon as 
+ * the cached image. Then it will try to satisfy the request as soon as
  * posible (that's it: after finishing an eventual loading on progress)
  * touch() returns inmediately, in order not tu disrupt the flow of the main
  * thread.
@@ -22,48 +22,58 @@
 #define LOADERQUEUE_H
 
 #include "GraphicsCache.h"
-#include "GraphicsCacheItem.h"
-
-#include "frontends/Timeout.h"
+#include "support/Timeout.h"
 
 #include <set>
 #include <queue>
 
-namespace grfx {
+namespace lyx {
+namespace graphics {
 
 class LoaderQueue {
 public:
-       //use this to request a loading
+       /// Use this to request that the item is loaded.
        void touch(Cache::ItemPtr const & item);
-       //query if the clock is ticking
+       /// Query whether the clock is ticking.
        bool running() const;
-       //get the and only instance of the class
+       ///get the and only instance of the class
        static LoaderQueue & get();
+       /** Adjusts the queue priority:
+        *  numimages is the number of images loaded in a particular call
+        *  from the timer.
+        *  millisecs is the time interval between calls.
+        *  Higher numimages, lower millisecs means higher priority.
+        */
+       static void setPriority(int numimages , int millisecs);
 private:
-       //this class is a singleton class... use LoaderQueue::get() instead
+       /// This class is a singleton class... use LoaderQueue::get() instead
        LoaderQueue();
-       //in-progress loading queue (elements are unique here) 
+       /// The in-progress loading queue (elements are unique here).
        std::list<Cache::ItemPtr> cache_queue_;
-       //makes faster the insertion of new elements
+       /// Used to make the insertion of new elements faster.
        std::set<Cache::ItemPtr> cache_set_;
-       //newly touched element go here, loadNext move them to cache_queue_
+       /// Newly touched elements go here. loadNext moves them to cache_queue_
        std::queue<Cache::ItemPtr> bucket_;
-       //
+       ///
        Timeout timer;
-       //
+       ///
        bool running_;
-       //moves bucket_ to cache_queue_
-       void emptyBucket();
-       //adds or reprioritizes one element in cache_queue_
-       void addToQueue(Cache::ItemPtr const & item);
-       //this is the 'threaded' method, that does the loading in background
+       ///
+       static int s_numimages_ ;
+       ///
+       static int s_millisecs_ ;
+
+       /** This is the 'threaded' method, that does the loading in the
+        *  background.
+        */
        void loadNext();
-       //
+       ///
        void startLoader();
-       //
+       ///
        void stopLoader();
 };
 
-} // namespace grfx
+} // namespace graphics
+} // namespace lyx
 
 #endif // LOADERQUEUE_H