3 * \file GraphicsLoader.h
4 * This file is part of LyX, the document processor.
5 * Licence details can be found in the file COPYING.
7 * \author Angus Leeming
9 * Full author contact details are available in file CREDITS.
11 * The public face of the graphics cache.
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.
21 * What could be simpler?
24 #ifndef GRAPHICSLOADER_H
25 #define GRAPHICSLOADER_H
27 #include "GraphicsTypes.h"
29 #include <boost/signal.hpp>
33 namespace support { class FileName; }
42 /// Must use the reset methods to make this instance usable.
44 /// The image is not transformed, just displayed as-is.
45 Loader(support::FileName const & file_with_path, bool display = true);
46 /// The image is transformed before display.
47 Loader(support::FileName const & file_with_path, Params const &);
49 Loader(Loader const &);
50 /// Needed for the pimpl
53 Loader & operator=(Loader const &);
55 /// The file can be changed, or the display params, or both.
56 void reset(support::FileName const & file_with_path, bool display = true) const;
58 void reset(support::FileName const & file_with_path, Params const &) const;
60 void reset(Params const &) const;
62 /// Returns the absolute path of the loaded (loading?) file.
63 support::FileName const & filename() const;
66 /** starting loading of the image is done by a urgency-based
67 * decision. Here we only call LoaderQueue::touch to request it.
69 void startLoading() const;
71 /** Monitor any changes to the file.
72 * There is no point monitoring the file before startLoading() is
75 void startMonitoring() const;
77 bool monitoring() const;
78 /** Returns the check checksum of filename() so that, for example, you can
79 * ascertain whether to output a new PostScript version of the file
82 unsigned long checksum() const;
84 /// How far have we got in loading the image?
85 ImageStatus status() const;
87 /** Connect and you'll be informed when the loading status of the image
90 typedef boost::signal<void()> sig_type;
91 typedef sig_type::slot_type slot_type;
93 boost::signals::connection connect(slot_type const &) const;
95 /** The loaded image with Pixmap set.
96 * If the Pixmap is not yet set (see status() for why...), returns 0.
98 Image const * image() const;
101 /// Use the Pimpl idiom to hide the internals.
103 /// The pointer never changes although *pimpl_'s contents may.
107 } // namespace graphics
110 #endif // GRAPHICSLOADER_H