]> git.lyx.org Git - lyx.git/blobdiff - src/graphics/PreviewLoader.h
A bunch of conversion to docstring.
[lyx.git] / src / graphics / PreviewLoader.h
index ba6613bedb2db51f2a2ec3d0a8f77415c6909d65..84c7295c91522756b774f86fda70a7d093d83753 100644 (file)
@@ -1,27 +1,26 @@
 // -*- C++ -*-
 /**
- *  \file PreviewLoader.h
+ * \file PreviewLoader.h
  * This file is part of LyX, the document processor.
  * Licence details can be found in the file COPYING.
  *
  * \author Angus Leeming
  *
- * Full author contact details are available in file CREDITS
+ * Full author contact details are available in file CREDITS.
  *
- *  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.
+ * 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
 
-#include "LString.h"
 #include <boost/utility.hpp>
 #include <boost/scoped_ptr.hpp>
-#include <boost/signals/signal1.hpp>
+#include <boost/signal.hpp>
 
 class Buffer;
 
@@ -42,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 {
@@ -57,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.
@@ -72,9 +71,10 @@ 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;
+       typedef boost::signal<void(PreviewImage const &)> sig_type;
+       typedef sig_type::slot_type slot_type;
        ///
        boost::signals::connection connect(slot_type const &) const;