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
12 #ifndef GRAPHICINSET_H
13 #define GRAPHICINSET_H
15 #include "dimension.h"
17 #include "graphics/GraphicsLoader.h"
18 #include "graphics/GraphicsParams.h"
19 #include "graphics/GraphicsTypes.h"
21 #include <boost/weak_ptr.hpp>
22 #include <boost/signals/signal0.hpp>
34 GraphicInset(GraphicInset const &);
36 /** Set the message that the inset will show when the
37 * display of the graphic is deactivated.
38 * The default is nothing, meaning that the inset will
39 * show a message descibing the state of the image
42 void setNoDisplayMessage(string const & msg);
44 /// Refresh the info about which file to display and how to display it.
45 void update(grfx::Params const & params);
47 /// compute the size of the object returned in dim
48 void metrics(MetricsInfo & mi, Dimension & dim) const;
49 /// draw inset and update (xo, yo)-cache
50 void draw(PainterInfo & pi, int x, int y) const;
52 /// Is the stored checksum different to that of the graphics loader?
53 bool hasFileChanged() const;
54 /// Set the cached store.
55 void view(BufferView *) const;
56 /// An accessor function to the cached store.
57 BufferView * view() const;
59 /** Connect and you'll be informed when the loading status of the image
62 typedef boost::signal0<void>::slot_type slot_type;
63 boost::signals::connection connect(slot_type const &) const;
67 GraphicInset & operator=(GraphicInset const &);
69 /// The message to display instead of the graphic itself.
70 string const statusMessage() const;
78 /// Is the image ready to draw, or should we display a message instead?
79 DisplayType displayType() const;
84 string nodisplay_message_;
86 /// These are all cached variables.
87 mutable unsigned long checksum_;
88 mutable boost::weak_ptr<BufferView> view_;
89 mutable Dimension dim_;
93 #endif // NOT GRAPHICINSET_H