src/graphics/GraphicsLoader.h

   1 // -*- C++ -*-
   2 /**
   3  *  \file GraphicsLoader.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  *  \author Angus Leeming
   8  *
   9  * Full author contact details are available in file CREDITS
  10  *
  11  *  The public face of the graphics cache.
  12  *
  13  *  * The user supplies an image file and the display parameters.
  14  *  * He can change the file or the display parameters through a reset() method.
  15  *  * He must start the loading process explicitly with startLoading().
  16  *  * If he is connected through the connect() method, then he'll be informed
  17  *    when the loading status changes.
  18  *  * When (status() == Ready), he can use image() to access the loaded image
  19  *    and pass it to the Painter.
  20  *
  21  *  What could be simpler?
  22  */
  23
  24 #ifndef GRAPHICSLOADER_H
  25 #define GRAPHICSLOADER_H
  26
  27 #include "GraphicsTypes.h"
  28 #include "LString.h"
  29
  30 #include <boost/signals/signal0.hpp>
  31 #include <boost/scoped_ptr.hpp>
  32
  33 class Inset;
  34
  35 namespace lyx {
  36 namespace graphics {
  37
  38 class Image;
  39 class Params;
  40
  41 class Loader {
  42 public:
  43         /// Must use the reset methods to make this instance usable.
  44         Loader();
  45         /// The image is not transformed, just displayed as-is.
  46         Loader(string const & file_with_path, DisplayType = ColorDisplay);
  47         /// The image is transformed before display.
  48         Loader(string const & file_with_path, Params const &);
  49         ///
  50         Loader(Loader const &);
  51
  52         /// Define an empty d-tor out-of-line to keep boost::scoped_ptr happy.
  53         ~Loader();
  54
  55         Loader & operator=(Loader const &);
  56
  57         /// The file can be changed, or the display params, or both.
  58         void reset(string const & file_with_path,
  59                    DisplayType = ColorDisplay) const;
  60         ///
  61         void reset(string const & file_with_path, Params const &) const;
  62         ///
  63         void reset(Params const &) const;
  64
  65         /// Returns the absolute path of the loaded (loading?) file.
  66         string const & filename() const;
  67         ///
  68         bool empty() const { return filename().empty(); }
  69
  70         /** starting loading of the image is done by a urgency-based
  71          *  decision. Here we only call LoaderQueue::touch to request it.
  72          */
  73         void startLoading() const;
  74
  75         /** Monitor any changes to the file.
  76          *  There is no point monitoring the file before startLoading() is
  77          *  invoked.
  78          */
  79         void startMonitoring() const;
  80         ///
  81         bool monitoring() const;
  82         /** Returns the check sum of filename() so that, for example, you can
  83          *  ascertain whether to output a new PostScript version of the file
  84          *  for a LaTeX run.
  85          */
  86         unsigned long checksum() const;
  87
  88         /// How far have we got in loading the image?
  89         ImageStatus status() const;
  90
  91         /** Connect and you'll be informed when the loading status of the image
  92          *  changes.
  93          */
  94         typedef boost::signal0<void>::slot_type slot_type;
  95         ///
  96         boost::signals::connection connect(slot_type const &) const;
  97
  98         /** The loaded image with Pixmap set.
  99          *  If the Pixmap is not yet set (see status() for why...), returns 0.
 100          */
 101         Image const * image() const;
 102
 103 private:
 104         /// Use the Pimpl idiom to hide the internals.
 105         class Impl;
 106         /// The pointer never changes although *pimpl_'s contents may.
 107         boost::scoped_ptr<Impl> const pimpl_;
 108 };
 109
 110 } // namespace graphics
 111 } // namespace lyx
 112
 113 #endif // GRAPHICSLOADER_H