]> git.lyx.org Git - lyx.git/blobdiff - src/graphics/GraphicsLoader.h
Remove obsolete (and false) comment.
[lyx.git] / src / graphics / GraphicsLoader.h
index 9ebe27a258705134fff496ecbb3a933d4223a2d5..0a299cba1a6e89870d40e2e8251d297da110e2f8 100644 (file)
@@ -1,13 +1,14 @@
 // -*- C++ -*-
 /**
- *  \file GraphicsLoader.h
- *  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 
+ * \author Angus Leeming
  *
- * Full author contact details available in file CREDITS
+ * Full author contact details are available in file CREDITS.
  *
- *  The public face of the graphics cache.
+ * 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.
  *  * 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 <boost/signals/signal0.hpp>
-#include <boost/scoped_ptr.hpp>
+#include "support/signals.h"
+
+namespace lyx {
 
-class Inset;
-class BufferView;
+namespace support { class FileName; }
 
-namespace grfx {
+namespace graphics {
 
 class Image;
 class Params;
@@ -44,35 +40,39 @@ class Params;
 class Loader {
 public:
        /// Must use the reset methods to make this instance usable.
-       Loader();
+       Loader(support::FileName const & doc_file);
        /// The image is not transformed, just displayed as-is.
-       Loader(string const & file_with_path, DisplayType = ColorDisplay);
+       Loader(support::FileName const & doc_file, support::FileName const & file_with_path, bool display = true);
        /// The image is transformed before display.
-       Loader(string const & file_with_path, Params const &);
-
-       /// Define an empty d-tor out-of-line to keep boost::scoped_ptr happy.
+       Loader(support::FileName const & doc_file, support::FileName const & file_with_path, Params const &);
+       ///
+       Loader(support::FileName const & doc_file, Loader const &);
+       ///
+       Loader(Loader const & other);
+       /// Needed for the pimpl
        ~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;
+       void reset(support::FileName const & file_with_path, bool display = true) const;
        ///
-       void reset(string const & file_with_path, Params const &) const;
+       void reset(support::FileName const & file_with_path, Params const &) const;
        ///
        void reset(Params const &) const;
 
        /// Returns the absolute path of the loaded (loading?) file.
-       string const & filename() const;
+       support::FileName const & filename() const;
        ///
-       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.
+       /** Tries to reload the image.
         */
-       void startLoading(Inset const &, BufferView const &) const;
+       void reload() const;
 
        /** Monitor any changes to the file.
         *  There is no point monitoring the file before startLoading() is
@@ -81,11 +81,8 @@ public:
        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.
-        */
-       unsigned long checksum() const;
+       ///
+       void checkModifiedAsync() const;
 
        /// How far have we got in loading the image?
        ImageStatus status() const;
@@ -93,22 +90,27 @@ public:
        /** Connect and you'll be informed when the loading status of the image
         *  changes.
         */
-       typedef boost::signal0<void>::slot_type slot_type;
+       typedef signals2::signal<void()> sig;
+       typedef sig::slot_type slot;
        ///
-       boost::signals::connection connect(slot_type const &) const;
+       signals2::connection connect(slot const &) const;
 
        /** The loaded image with Pixmap set.
         *  If the Pixmap is not yet set (see status() for why...), returns 0.
         */
        Image const * image() const;
 
+       double displayPixelRatio() const;
+       void setDisplayPixelRatio(double scale);
+
 private:
        /// Use the Pimpl idiom to hide the internals.
        class Impl;
        /// The pointer never changes although *pimpl_'s contents may.
-       boost::scoped_ptr<Impl> const pimpl_;
+       Impl * pimpl_;
 };
 
-} // namespace grfx
+} // namespace graphics
+} // namespace lyx
 
 #endif // GRAPHICSLOADER_H