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>
33 GraphicInset(GraphicInset const &);
35 /** Set the message that the inset will show when the
36 * display of the graphic is deactivated.
37 * The default is nothing, meaning that the inset will
38 * show a message descibing the state of the image
41 void setNoDisplayMessage(string const & msg);
43 /// Refresh the info about which file to display and how to display it.
44 void update(grfx::Params const & params);
45 /// File name, image size, rotation angle etc.
46 grfx::Params const & params() const;
48 /// compute the size of the object returned in dim
49 void metrics(MetricsInfo & mi, Dimension & dim) const;
50 /// draw inset and update (xo, yo)-cache
51 void draw(PainterInfo & pi, int x, int y) const;
53 /// Is the stored checksum different to that of the graphics loader?
54 bool hasFileChanged() const;
55 /// An accessor function to the cached store.
56 BufferView * view() const;
58 /** Connect and you'll be informed when the loading status of the image
61 typedef boost::signal0<void>::slot_type slot_type;
62 boost::signals::connection connect(slot_type const &) const;
71 /// Is the image ready to draw, or should we display a message instead?
72 DisplayType displayType() const;
74 /// The message to display instead of the graphic itself.
75 string const statusMessage() const;
80 string nodisplay_message_;
82 /// These are all cached variables.
83 mutable int old_ascent_;
84 mutable unsigned long checksum_;
85 mutable boost::weak_ptr<BufferView> view_;
86 mutable Dimension dim_;
90 #endif // NOT GRAPHICINSET_H