the AM_* flags patch

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

diff --git a/src/graphics/GraphicsCacheItem.h b/src/graphics/GraphicsCacheItem.h
index bb25b408e1ddb35c608512d7edda24e933362f44..e55e3885e338833faea17d9070d4f2f06293b89c 100644 (file)
--- a/src/graphics/GraphicsCacheItem.h
+++ b/src/graphics/GraphicsCacheItem.h
@@ -1,17 +1,19 @@
 // -*- C++ -*-
-/*
+/**
  * \file GraphicsCacheItem.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 Baruch Even <baruch.even@writeme.com>
- * \author Angus Leeming <leeming@lyx.org>
+ * \author Baruch Even
+ * \author Angus Leeming
  *
- * The graphics cache is a container of grfx::CacheItems.
- * Each grfx::CacheItem, definedhere represents a separate image file.
+ * Full author contact details are available in file CREDITS.
+ *
+ * The graphics cache is a container of lyx::graphics::CacheItems.
+ * Each lyx::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() == grfx::Loaded).
+ * which point (status() == lyx::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.
  *
@@ -19,47 +21,57 @@
  * file conversion to a loadable format;
  * file loading.
  *
- * Whether you get that, of course, depends on grfx::Converter and on the
- * grfx::Image-derived image class.
+ * Whether you get that, of course, depends on lyx::graphics::Converter and
+ * on the lyx::graphics::Image-derived image class.
  */
 
 #ifndef GRAPHICSCACHEITEM_H
 #define GRAPHICSCACHEITEM_H
 
-#ifdef __GNUG__
-#pragma interface
-#endif
-
 #include "GraphicsTypes.h"
-#include "LString.h"
 
 #include <boost/utility.hpp>
 #include <boost/scoped_ptr.hpp>
-#include <boost/signals/signal0.hpp>
+#include <boost/signal.hpp>
+
 
 class InsetGraphics;
 
-namespace grfx {
+namespace lyx {
+namespace graphics {
 
 class Image;
 class Converter;
 
-/// A grfx::Cache item holder.
+/// A lyx::graphics::Cache item holder.
 class CacheItem : boost::noncopyable {
 public:
        ///
-       CacheItem(string const & file);
+       CacheItem(std::string const & file);
 
        /// Define an empty d-tor out-of-line to keep boost::scoped_ptr happy.
        ~CacheItem();
 
        ///
-       string const & filename() const;
+       std::string const & filename() const;
 
        /// It's in the cache. Now start the loading process.
-       void startLoading();
+       void startLoading() const;
 
-       /** Get the image associated with filename_.
+       /** 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;
+
+       /** 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.
@@ -69,8 +81,13 @@ public:
        /// 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;
 
 private:
        /// Use the Pimpl idiom to hide the internals.
@@ -80,6 +97,7 @@ private:
        boost::scoped_ptr<Impl> const pimpl_;
 };
 
-} // namespace grfx
+} // namespace graphics
+} // namespace lyx
 
 #endif // GRAPHICSCACHEITEM_H