]> git.lyx.org Git - lyx.git/blobdiff - src/graphics/PreviewLoader.h
Store an InsetBase & in MailInset.
[lyx.git] / src / graphics / PreviewLoader.h
index 1270a59ea921abf86b97f2bf2b4b34de57d196c4..93ea8da64b3e0b9ccd66b35aa6c362697c3cefb4 100644 (file)
@@ -1,25 +1,23 @@
 // -*- C++ -*-
 /**
  *  \file PreviewLoader.h
- *  Copyright 2002 the LyX Team
- *  Read the file COPYING
+ * 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
+ *
+ * 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 readyToDisplay signal
- *  to inform the initiating process.
+ *  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>
@@ -59,20 +57,33 @@ public:
 
        /// How far have we got in loading the image?
        Status status(string const & latex_snippet) const;
-       
+
        /// Add a snippet of LaTeX to the queue for processing.
-       void add(string const & latex_snippet);
+       void add(string const & latex_snippet) const;
 
        /// Remove this snippet of LaTeX from the PreviewLoader.
-       void remove(string const & latex_snippet);
-       
+       void remove(string const & latex_snippet) const;
+
        /** We have accumulated several latex snippets with status "InQueue".
         *  Initiate their transformation into bitmap images.
         */
-       void startLoading();
+       void startLoading() const;
+
+       /** Connect and you'll be informed when the bitmap image file
+        *  has been created and is ready for loading through
+        *  grfx::PreviewImage::image().
+        */
+       typedef boost::signal1<void, PreviewImage const &>::slot_type slot_type;
+       ///
+       boost::signals::connection connect(slot_type const &) const;
+
+       /** When PreviewImage has finished loading the image file into memory,
+        *  it tells the PreviewLoader to tell the outside world
+        */
+       void emitSignal(PreviewImage const &) const;
 
-       /// Emit this signal when an image is ready for display.
-       boost::signal1<void, PreviewImage const &> imageReady;
+       /// Which buffer owns this loader.
+       Buffer const & buffer() const;
 
 private:
        /// Use the Pimpl idiom to hide the internals.