X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Fgraphics%2FGraphicsCacheItem.h;h=6f7f968bc6a44086af831849470043faa4053c0e;hb=c8230ab0d0a919530c43c29395f4d9961498bf15;hp=52d710cc08b502b1a964facccde2890ec4012195;hpb=39b3fd44b958bff1250a943f5685e23f1b9e41fb;p=lyx.git

diff --git a/src/graphics/GraphicsCacheItem.h b/src/graphics/GraphicsCacheItem.h
index 52d710cc08..6f7f968bc6 100644
--- a/src/graphics/GraphicsCacheItem.h
+++ b/src/graphics/GraphicsCacheItem.h
@@ -1,103 +1,103 @@
 // -*- C++ -*-
-/* This file is part of
- * =================================================
- * 
- *          LyX, The Document Processor
- *          Copyright 1995 Matthias Ettrich.
- *          Copyright 1995-2000 The LyX Team.
+/**
+ * \file GraphicsCacheItem.h
+ * This file is part of LyX, the document processor.
+ * Licence details can be found in the file COPYING.
  *
- *          This file Copyright 2000 Baruch Even
- * ================================================= */
+ * \author Baruch Even
+ * \author Angus Leeming
+ *
+ * Full author contact details are available in file CREDITS.
+ *
+ * The graphics cache is a container of graphics::CacheItems.
+ * Each graphics::CacheItem, defined here represents a separate image file.
+ *
+ * The routines here can be used to load the graphics file into memory at
+ * which point (status() == graphics::Loaded).
+ * The user is then free to access image() in order to copy it and to then
+ * transform the copy (rotate, scale, clip) and to generate the pixmap.
+ *
+ * The graphics cache supports fully asynchronous:
+ * file conversion to a loadable format;
+ * file loading.
+ *
+ * Whether you get that, of course, depends on graphics::Converter and
+ * on the graphics::Image-derived image class.
+ */
 
 #ifndef GRAPHICSCACHEITEM_H
 #define GRAPHICSCACHEITEM_H
 
-#include <config.h>
+#include "GraphicsTypes.h"
 
-#ifdef __GNUG__
-#pragma interface
-#endif
+#include "support/signals.h"
 
-#include XPM_H_LOCATION
-#include "LString.h"
 
-#include "sigc++/signal_system.h"
-#ifdef SIGC_CXX_NAMESPACES
-using SigC::Signal0;
-#endif
+namespace lyx {
 
+namespace support { class FileName; }
 
-/* (Baruch Even 2000-08-05)
- * This has a major drawback: it is only designed for X servers, no easy
- * porting to non X-server based platform is offered right now, this is done
- * in order to get a first version out of the door.
- *
- * Later versions should consider how to do this with more platform 
- * independence, this will probably involve changing the Painter class too.
- */
+namespace graphics {
 
-class GraphicsCacheItem_pimpl;
-class LyXImage;
+class Image;
+class Converter;
 
-/// A GraphicsCache item holder.
-class GraphicsCacheItem {
+/// A graphics::Cache item holder.
+class CacheItem {
 public:
-	/// d-tor, frees the image structures.
-	~GraphicsCacheItem();
-	/// copy c-tor.
-	GraphicsCacheItem(GraphicsCacheItem const &);
-	/// Assignment operator.
-	GraphicsCacheItem & operator=(GraphicsCacheItem const &);
-	
-	/// Return a pixmap that can be displayed on X server.
-	LyXImage * getImage() const; 
 	///
-	enum ImageStatus {
-		///
-		Loading = 1,
-		///
-		ErrorConverting,
-		///
-		ErrorReading,
-		///
-		UnknownError,
-		///
-		Loaded
-	};
-	
-	/// Is the pixmap ready for display?
-	ImageStatus getImageStatus() const; 
-
-	/** Get a notification when the image conversion is done.
-	    used by an internal callback mechanism.
-	*/
-	void imageConverted(int retval);
-
-	/// Create another copy of the object.
-	GraphicsCacheItem * Clone() const;
-	
-private:
-	/// Private c-tor so that only GraphicsCache can create an instance.
-	GraphicsCacheItem();
+	CacheItem(support::FileName const & file, support::FileName const & doc_file);
+	/// Needed for the pimpl
+	~CacheItem();
 
-	/// internal copy mechanism.
-	void copy(GraphicsCacheItem const &);
-	/// internal destroy mechanism.
-	void destroy();
+	///
+	support::FileName const & filename() const;
 
-	/// Set the filename this item will be pointing too.
-	bool setFilename(string const & filename);
+	/// Try to load a display format.
+	bool tryDisplayFormat() const;
 
-	///
-	friend class GraphicsCache;
+	/// It's in the cache. Now start the loading process.
+	void startLoading() const;
 
+	/** Monitor any changes to the file.
+	 *  There is no point monitoring the file before startLoading() is
+	 *  invoked.
+	 */
+	void startMonitoring() const;
 	///
-	GraphicsCacheItem_pimpl * pimpl;
+	bool monitoring() const;
+	/// perform a modification check asynchronously
+	void checkModifiedAsync() const;
+
+	/** Get the image associated with filename().
+	 *  If the image is not yet loaded, returns 0.
+	 *  This routine returns a pointer to const; if you want to modify it,
+	 *  create a copy and modify that.
+	 */
+	Image const * image() const;
+
+	/// How far have we got in loading the image?
+	ImageStatus status() const;
+
+	/** Connect and you'll be informed when the loading status of the image
+	 *  changes.
+	 */
+	typedef signals2::signal<void()>::slot_type slot_type;
+	///
+	signals2::connection connect(slot_type const &) const;
 
-	/** The filename we refer too.
-	    This is used when removing ourselves from the cache.
-	*/
-	string filename_;
+private:
+	/// noncopyable
+	CacheItem(CacheItem const &);
+	void operator=(CacheItem const &);
+
+	/// Use the Pimpl idiom to hide the internals.
+	class Impl;
+	/// The pointer never changes although *pimpl_'s contents may.
+	Impl * const pimpl_;
 };
 
-#endif
+} // namespace graphics
+} // namespace lyx
+
+#endif // GRAPHICSCACHEITEM_H