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