]> git.lyx.org Git - lyx.git/blobdiff - src/graphics/GraphicsLoader.h
Store an InsetBase & in MailInset.
[lyx.git] / src / graphics / GraphicsLoader.h
index 08f30fa69ac368db925596dafd1fdbd9583b66d0..893070919a9232bd9ddd564d0d5030f787e29729 100644 (file)
@@ -1,19 +1,22 @@
 // -*- C++ -*-
 /**
  *  \file GraphicsLoader.h
- *  Copyright 2002 the LyX Team
- *  Read the file COPYING
+ * 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 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?
  */
 #ifndef GRAPHICSLOADER_H
 #define GRAPHICSLOADER_H
 
-#ifdef __GNUG__
-#pragma interface
-#endif
-
 #include "GraphicsTypes.h"
 #include "LString.h"
 
@@ -64,13 +63,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;