]> git.lyx.org Git - lyx.git/blob - src/graphics/GraphicsCacheItem.h
3e8755fcaad7b6391d3eb21dfe373283a2dd04cb
[lyx.git] / src / graphics / GraphicsCacheItem.h
1 // -*- C++ -*-
2 /**
3  * \file GraphicsCacheItem.h
4  * This file is part of LyX, the document processor.
5  * Licence details can be found in the file COPYING.
6  *
7  * \author Baruch Even
8  * \author Angus Leeming
9  *
10  * Full author contact details are available in file CREDITS
11  *
12  * The graphics cache is a container of grfx::CacheItems.
13  * Each grfx::CacheItem, defined here represents a separate image file.
14  *
15  * The routines here can be used to load the graphics file into memory at
16  * which point (status() == grfx::Loaded).
17  * The user is then free to access image() in order to copy it and to then
18  * transform the copy (rotate, scale, clip) and to generate the pixmap.
19  *
20  * The graphics cache supports fully asynchronous:
21  * file conversion to a loadable format;
22  * file loading.
23  *
24  * Whether you get that, of course, depends on grfx::Converter and on the
25  * grfx::Image-derived image class.
26  */
27
28 #ifndef GRAPHICSCACHEITEM_H
29 #define GRAPHICSCACHEITEM_H
30
31 #include "GraphicsTypes.h"
32 #include "LString.h"
33
34 #include <boost/utility.hpp>
35 #include <boost/scoped_ptr.hpp>
36 #include <boost/signals/signal0.hpp>
37
38 class InsetGraphics;
39
40 namespace grfx {
41
42 class Image;
43 class Converter;
44
45 /// A grfx::Cache item holder.
46 class CacheItem : boost::noncopyable {
47 public:
48         ///
49         CacheItem(string const & file);
50
51         /// Define an empty d-tor out-of-line to keep boost::scoped_ptr happy.
52         ~CacheItem();
53
54         ///
55         string const & filename() const;
56
57         /// It's in the cache. Now start the loading process.
58         void startLoading() const;
59
60         /** Monitor any changes to the file.
61          *  There is no point monitoring the file before startLoading() is
62          *  invoked.
63          */
64         void startMonitoring() const;
65         ///
66         bool monitoring() const;
67         /** Returns the check sum of filename() so that, for example, you can
68          *  ascertain whether to output a new PostScript version of the file
69          *  for a LaTeX run.
70          */
71         unsigned long checksum() const;
72
73         /** Get the image associated with filename().
74          *  If the image is not yet loaded, returns 0.
75          *  This routine returns a pointer to const; if you want to modify it,
76          *  create a copy and modify that.
77          */
78         Image const * image() const;
79
80         /// How far have we got in loading the image?
81         ImageStatus status() const;
82
83         /** Connect and you'll be informed when the loading status of the image
84          *  changes.
85          */
86         typedef boost::signal0<void>::slot_type slot_type;
87         ///
88         boost::signals::connection connect(slot_type const &) const;
89
90 private:
91         /// Use the Pimpl idiom to hide the internals.
92         class Impl;
93
94         /// The pointer never changes although *pimpl_'s contents may.
95         boost::scoped_ptr<Impl> const pimpl_;
96 };
97
98 } // namespace grfx
99
100 #endif // GRAPHICSCACHEITEM_H