3 * \file insetgraphics.h
4 * This file is part of LyX, the document processor.
5 * Licence details can be found in the file COPYING.
10 * Full author contact details are available in file CREDITS
13 #ifndef INSET_GRAPHICS_H
14 #define INSET_GRAPHICS_H
16 #include "insets/inset.h"
17 #include "insets/insetgraphicsParams.h"
19 #include <boost/signals/trackable.hpp>
20 #include <boost/scoped_ptr.hpp>
26 class InsetGraphics : public Inset, public boost::signals::trackable {
31 InsetGraphics(InsetGraphics const &, string const & filepath,
32 bool same_id = false);
36 virtual dispatch_result localDispatch(FuncRequest const & cmd);
38 void dimension(BufferView *, LyXFont const &, Dimension &) const;
40 void draw(BufferView *, LyXFont const &, int, float &) const;
42 EDITABLE editable() const;
44 void write(Buffer const *, std::ostream &) const;
46 void read(Buffer const *, LyXLex & lex);
48 /** returns the number of rows (\n's) of generated tex code.
49 #fragile == true# means, that the inset should take care about
50 fragile commands by adding a #\protect# before.
52 int latex(Buffer const *, std::ostream &, LatexRunParams const &,
55 int ascii(Buffer const *, std::ostream &, int linelen) const;
57 int linuxdoc(Buffer const *, std::ostream &) const;
59 int docbook(Buffer const *, std::ostream &, bool mixcont) const;
61 /** Tell LyX what the latex features you need i.e. what latex packages
62 you need to be included.
64 void validate(LaTeXFeatures & features) const;
66 /// returns LyX code associated with the inset. Used for TOC, ...)
67 Inset::Code lyxCode() const { return Inset::GRAPHICS_CODE; }
70 virtual Inset * clone(Buffer const &, bool same_id = false) const;
72 /** Set the inset parameters, used by the GUIndependent dialog.
73 Return true of new params are different from what was so far.
75 bool setParams(InsetGraphicsParams const & params,
76 string const & filepath);
78 /// Get the inset parameters, used by the GUIndependent dialog.
79 InsetGraphicsParams const & params() const;
82 /// Returns the cached BufferView.
83 BufferView * view() const;
86 friend class InsetGraphicsMailer;
88 /// Is the image ready to draw, or should we display a message instead?
89 bool imageIsDrawable() const;
91 /** This method is connected to cache_->statusChanged, so we are
92 informed when the image has been loaded.
96 /// Read the inset native format
97 void readInsetGraphics(LyXLex & lex);
99 /// Get the status message, depends on the image loading status.
100 string const statusMessage() const;
101 /// Create the options for the latex command.
102 string const createLatexOptions() const;
103 /// Convert the file if needed, and return the location of the file.
104 string const prepareFile(Buffer const * buf, LatexRunParams const &) const;
107 InsetGraphicsParams params_;
109 /// holds the entity name that defines the graphics location (SGML).
110 string const graphic_label;
112 /// The cached variables
115 /// The pointer never changes although *cache_'s contents may.
116 boost::scoped_ptr<Cache> const cache_;
120 #include "mailinset.h"
122 class InsetGraphicsMailer : public MailInset {
125 InsetGraphicsMailer(InsetGraphics & inset);
127 virtual InsetBase & inset() const { return inset_; }
129 virtual string const & name() const { return name_; }
131 virtual string const inset2string() const;
133 static void string2params(string const &, InsetGraphicsParams &);
135 static string const params2string(InsetGraphicsParams const &);
138 static string const name_;
140 InsetGraphics & inset_;