]> git.lyx.org Git - features.git/blobdiff - src/graphics/GraphicsLoader.h
Replace LString.h with support/std_string.h,
[features.git] / src / graphics / GraphicsLoader.h
index 08f30fa69ac368db925596dafd1fdbd9583b66d0..5da61930ad7f182f4f2697d591c82928e0580b95 100644 (file)
@@ -1,40 +1,39 @@
 // -*- C++ -*-
 /**
- *  \file GraphicsLoader.h
- *  Copyright 2002 the LyX Team
- *  Read the file COPYING
+ * \file GraphicsLoader.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
  *
- *  The public face of the graphics cache.
+ * Full author contact details are available in file CREDITS.
+ *
+ * The public face of the graphics cache.
  *
  *  * The user supplies an image file and the display parameters.
  *  * He can change the file or the display parameters through a reset() method.
  *  * He must start the loading process explicitly with startLoading().
- *  * He receives a statusChanged signal when the loading status changes.
- *  * When (status() == Ready), he uses image() to access the loaded image
- *    and passes it to the Painter.
+ *  * If he is connected through the connect() method, then he'll be informed
+ *    when the loading status changes.
+ *  * When (status() == Ready), he can use image() to access the loaded image
+ *    and pass it to the Painter.
  *
- *  What could be simpler?
+ * What could be simpler?
  */
 
 #ifndef GRAPHICSLOADER_H
 #define GRAPHICSLOADER_H
 
-#ifdef __GNUG__
-#pragma interface
-#endif
-
 #include "GraphicsTypes.h"
-#include "LString.h"
+#include "support/std_string.h"
 
 #include <boost/signals/signal0.hpp>
 #include <boost/scoped_ptr.hpp>
 
-class Inset;
-class BufferView;
+class InsetOld;
 
-namespace grfx {
+namespace lyx {
+namespace graphics {
 
 class Image;
 class Params;
@@ -47,10 +46,14 @@ public:
        Loader(string const & file_with_path, DisplayType = ColorDisplay);
        /// The image is transformed before display.
        Loader(string const & file_with_path, Params const &);
+       ///
+       Loader(Loader const &);
 
        /// Define an empty d-tor out-of-line to keep boost::scoped_ptr happy.
        ~Loader();
 
+       Loader & operator=(Loader const &);
+
        /// The file can be changed, or the display params, or both.
        void reset(string const & file_with_path,
                   DisplayType = ColorDisplay) const;
@@ -64,13 +67,23 @@ public:
        ///
        bool empty() const { return filename().empty(); }
 
-       /// We are explicit about when we begin the loading process.
+       /** starting loading of the image is done by a urgency-based
+        *  decision. Here we only call LoaderQueue::touch to request it.
+        */
        void startLoading() const;
 
-       /** starting loading of the image is conditional upon the
-        *  inset being visible or not.
+       /** Monitor any changes to the file.
+        *  There is no point monitoring the file before startLoading() is
+        *  invoked.
+        */
+       void startMonitoring() const;
+       ///
+       bool monitoring() const;
+       /** Returns the check sum of filename() so that, for example, you can
+        *  ascertain whether to output a new PostScript version of the file
+        *  for a LaTeX run.
         */
-       void startLoading(Inset const &, BufferView const &) const;
+       unsigned long checksum() const;
 
        /// How far have we got in loading the image?
        ImageStatus status() const;
@@ -94,6 +107,7 @@ private:
        boost::scoped_ptr<Impl> const pimpl_;
 };
 
-} // namespace grfx
+} // namespace graphics
+} // namespace lyx
 
 #endif // GRAPHICSLOADER_H