Preview fiddling (preparing the way for mathed previews).

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

diff --git a/src/graphics/PreviewLoader.h b/src/graphics/PreviewLoader.h
index 82947e2ac484e0722244b7627803faea481b6362..ecb518f1a880423df1485f1ca14f875c412b1433 100644 (file)
--- a/src/graphics/PreviewLoader.h
+++ b/src/graphics/PreviewLoader.h
@@ -1,33 +1,31 @@
 // -*- C++ -*-
 /**
- *  \file PreviewLoader.h
- *  Copyright 2002 the LyX Team
- *  Read the file COPYING
+ * \file PreviewLoader.h
+ * This file is part of LyX, the document processor.
+ * Licence details can be found in the file COPYING.
  *
- * \author Angus Leeming <leeming@lyx.org>
+ * \author Angus Leeming
  *
- *  grfx::PreviewLoader collects latex snippets together. Then, on a
- *  startLoading() call, these are dumped to file and processed, converting
- *  each snippet to a separate bitmap image file. Once a bitmap file is ready
- *  to be loaded back into LyX, the PreviewLoader emits a signal to inform
- *  the initiating process.
+ * Full author contact details are available in file CREDITS.
+ *
+ * lyx::graphics::PreviewLoader collects latex snippets together. Then, on a
+ * startLoading() call, these are dumped to file and processed, converting
+ * each snippet to a separate bitmap image file. Once a bitmap file is ready
+ * to be loaded back into LyX, the PreviewLoader emits a signal to inform
+ * the initiating process.
  */
 
 #ifndef PREVIEWLOADER_H
 #define PREVIEWLOADER_H
 
-#ifdef __GNUG__
-#pragma interface
-#endif
-
-#include "LString.h"
 #include <boost/utility.hpp>
 #include <boost/scoped_ptr.hpp>
 #include <boost/signals/signal1.hpp>
 
 class Buffer;
 
-namespace grfx {
+namespace lyx {
+namespace graphics {
 
 class PreviewImage;
 
@@ -43,7 +41,7 @@ public:
        /** Is there an image already associated with this snippet of LaTeX?
         *  If so, returns a pointer to it, else returns 0.
         */
-       PreviewImage const * preview(string const & latex_snippet) const;
+       PreviewImage const * preview(std::string const & latex_snippet) const;
 
        ///
        enum Status {
@@ -58,13 +56,13 @@ public:
        };
 
        /// How far have we got in loading the image?
-       Status status(string const & latex_snippet) const;
+       Status status(std::string const & latex_snippet) const;
 
        /// Add a snippet of LaTeX to the queue for processing.
-       void add(string const & latex_snippet) const;
+       void add(std::string const & latex_snippet) const;
 
        /// Remove this snippet of LaTeX from the PreviewLoader.
-       void remove(string const & latex_snippet) const;
+       void remove(std::string const & latex_snippet) const;
 
        /** We have accumulated several latex snippets with status "InQueue".
         *  Initiate their transformation into bitmap images.
@@ -73,7 +71,7 @@ public:
 
        /** Connect and you'll be informed when the bitmap image file
         *  has been created and is ready for loading through
-        *  grfx::PreviewImage::image().
+        *  lyx::graphics::PreviewImage::image().
         */
        typedef boost::signal1<void, PreviewImage const &>::slot_type slot_type;
        ///
@@ -84,6 +82,9 @@ public:
         */
        void emitSignal(PreviewImage const &) const;
 
+       /// Which buffer owns this loader.
+       Buffer const & buffer() const;
+
 private:
        /// Use the Pimpl idiom to hide the internals.
        class Impl;
@@ -91,6 +92,7 @@ private:
        boost::scoped_ptr<Impl> const pimpl_;
 };
 
-} // namespace grfx
+} // namespace graphics
+} // namespace lyx
 
 #endif // PREVIEWLOADER_H