Fix preview with a nested preview not being shown (#10795)

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

diff --git a/src/graphics/GraphicsLoader.h b/src/graphics/GraphicsLoader.h
index 8cb1408bf96e0b156a77a88c6379b91b7bfb3420..0a299cba1a6e89870d40e2e8251d297da110e2f8 100644 (file)
--- a/src/graphics/GraphicsLoader.h
+++ b/src/graphics/GraphicsLoader.h
@@ -1,87 +1,116 @@
 // -*- 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
+ *
+ * Full author contact details are available in file CREDITS.
+ *
+ * The public face of the graphics cache.
  *
- *  The public view 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 <boost/signals/signal0.hpp>
-#include <boost/scoped_ptr.hpp>
+#include "support/signals.h"
 
-namespace grfx {
+namespace lyx {
 
-class GParams;
+namespace support { class FileName; }
+
+namespace graphics {
+
+class Image;
+class Params;
 
-/** One image, one instance of grfx::Loader, although the image can be
- *  changed.
- */
 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, GParams 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);
+       void reset(support::FileName const & file_with_path, bool display = true) const;
        ///
-       void reset(string const & file_with_path, GParams const &);
+       void reset(support::FileName const & file_with_path, Params const &) const;
        ///
-       void reset(GParams 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.
-       void startLoading();
+       /** starting loading of the image is done by a urgency-based
+        *  decision. Here we only call LoaderQueue::touch to request it.
+        */
+       void startLoading() const;
+
+       /** Tries to reload the image.
+        */
+       void reload() const;
+
+       /** Monitor any changes to the file.
+        *  There is no point monitoring the file before startLoading() is
+        *  invoked.
+        */
+       void startMonitoring() const;
+       ///
+       bool monitoring() const;
+       ///
+       void checkModifiedAsync() const;
 
-       ///  How far have we got in loading the image?
+       /// How far have we got in loading the image?
        ImageStatus status() const;
 
-       /// This signal is emitted when the image loading status changes.
-       boost::signal0<void> statusChanged;
+       /** Connect and you'll be informed when the loading status of the image
+        *  changes.
+        */
+       typedef signals2::signal<void()> sig;
+       typedef sig::slot_type slot;
+       ///
+       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.
         */
-       GImage const * image() const;
+       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