X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;ds=sidebyside;f=src%2Fgraphics%2FGraphicsLoader.h;h=b1c82d9067d39fb47f7a8424154d7f09d7882d34;hb=98ddc514dabfb2556fdfc6c9a8531daf838bebbb;hp=3054b8cbaf098859b23db26e31ee6739844900df;hpb=e5185674dec5f01e155f23bdd31bf8238539bb63;p=lyx.git

diff --git a/src/graphics/GraphicsLoader.h b/src/graphics/GraphicsLoader.h
index 3054b8cbaf..b1c82d9067 100644
--- a/src/graphics/GraphicsLoader.h
+++ b/src/graphics/GraphicsLoader.h
@@ -1,37 +1,38 @@
 // -*- 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 <boost/signals/signal0.hpp>
-#include <boost/scoped_ptr.hpp>
+#include <boost/signal.hpp>
+
+namespace lyx {
+
+namespace support { class FileName; }
 
-namespace grfx {
+namespace graphics {
 
 class Image;
 class Params;
@@ -41,33 +42,56 @@ public:
 	/// Must use the reset methods to make this instance usable.
 	Loader();
 	/// The image is not transformed, just displayed as-is.
-	Loader(string const & file_with_path, DisplayType = ColorDisplay);
+	Loader(support::FileName const & file_with_path, DisplayType = ColorDisplay);
 	/// 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 & file_with_path, Params const &);
+	///
+	Loader(Loader const &);
+	/// 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,
+		   DisplayType = ColorDisplay) const;
 	///
-	void reset(string const & file_with_path, Params const &);
+	void reset(support::FileName const & file_with_path, Params const &) const;
 	///
-	void reset(Params 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;
+
+	/** 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.
+	 */
+	unsigned long checksum() const;
 
 	/// 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 boost::signal<void()> sig_type;
+	typedef sig_type::slot_type slot_type;
+	///
+	boost::signals::connection connect(slot_type const &) const;
 
 	/** The loaded image with Pixmap set.
 	 *  If the Pixmap is not yet set (see status() for why...), returns 0.
@@ -78,9 +102,10 @@ 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 * const pimpl_;
 };
 
-} // namespace grfx
+} // namespace graphics
+} // namespace lyx
 
 #endif // GRAPHICSLOADER_H