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
17 #include "insetgraphicsParams.h"
18 #include "mailinset.h"
20 #include <boost/scoped_ptr.hpp>
21 #include <boost/signals/trackable.hpp>
31 class InsetGraphics : public InsetOld, public boost::signals::trackable {
38 void metrics(MetricsInfo &, Dimension &) const;
40 EDITABLE editable() const;
42 void write(Buffer const &, std::ostream &) const;
44 void read(Buffer const &, LyXLex & lex);
46 /** returns the number of rows (\n's) of generated tex code.
47 #fragile == true# means, that the inset should take care about
48 fragile commands by adding a #\protect# before.
50 int latex(Buffer const &, odocstream &,
51 OutputParams const &) const;
53 int plaintext(Buffer const &, odocstream &,
54 OutputParams const &) const;
56 int docbook(Buffer const &, odocstream &,
57 OutputParams const &) const;
59 /** Tell LyX what the latex features you need i.e. what latex packages
60 you need to be included.
62 void validate(LaTeXFeatures & features) const;
64 /// returns LyX code associated with the inset. Used for TOC, ...)
65 InsetBase::Code lyxCode() const { return InsetBase::GRAPHICS_CODE; }
67 /** Set the inset parameters, used by the GUIndependent dialog.
68 Return true of new params are different from what was so far.
70 bool setParams(InsetGraphicsParams const & params);
72 /// Get the inset parameters, used by the GUIndependent dialog.
73 InsetGraphicsParams const & params() const;
75 void draw(PainterInfo & pi, int x, int y) const;
77 void edit(LCursor & cur, bool left);
79 void editGraphics(InsetGraphicsParams const &, Buffer const &) const;
81 bool getStatus(LCursor &, FuncRequest const &, FuncStatus &) const;
83 InsetGraphics(InsetGraphics const &);
85 virtual void doDispatch(LCursor & cur, FuncRequest & cmd);
87 friend class InsetGraphicsMailer;
89 virtual std::auto_ptr<InsetBase> doClone() const;
91 /// Read the inset native format
92 void readInsetGraphics(LyXLex & lex, std::string const & bufpath);
94 /// Get the status message, depends on the image loading status.
95 std::string const statusMessage() const;
96 /// Create the options for the latex command.
97 std::string const createLatexOptions() const;
98 /// Create length values for docbook export.
99 std::string const toDocbookLength(LyXLength const & len) const;
100 /// Create the atributes for docbook export.
101 std::string const createDocBookAttributes() const;
102 /// Convert the file if needed, and return the location of the file.
103 std::string const prepareFile(Buffer const & buf, OutputParams const &) const;
106 InsetGraphicsParams params_;
108 /// holds the entity name that defines the graphics location (SGML).
109 std::string const graphic_label;
111 /// The thing that actually draws the image on LyX's screen.
112 boost::scoped_ptr<RenderGraphic> const graphic_;
116 class InsetGraphicsMailer : public MailInset {
119 InsetGraphicsMailer(InsetGraphics & inset);
121 virtual InsetBase & inset() const { return inset_; }
123 virtual std::string const & name() const { return name_; }
125 virtual std::string const inset2string(Buffer const &) const;
127 static void string2params(std::string const & data,
128 Buffer const & buffer,
129 InsetGraphicsParams &);
131 static std::string const params2string(InsetGraphicsParams const &,
135 static std::string const name_;
137 InsetGraphics & inset_;