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>
30 class InsetGraphics : public Inset, public boost::signals::trackable {
37 void setBuffer(Buffer & buffer);
39 bool isLabeled() const { return true; }
40 void metrics(MetricsInfo &, Dimension &) const;
42 EDITABLE editable() const;
44 void write(std::ostream &) const;
46 void read(Lexer & 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(odocstream &, OutputParams const &) const;
54 int plaintext(odocstream &, OutputParams const &) const;
56 int docbook(odocstream &, OutputParams const &) const;
58 /** Tell LyX what the latex features you need i.e. what latex packages
59 you need to be included.
61 void validate(LaTeXFeatures & features) const;
63 /// returns LyX code associated with the inset. Used for TOC, ...)
64 InsetCode lyxCode() const { return GRAPHICS_CODE; }
66 /** Set the inset parameters, used by the GUIndependent dialog.
67 Return true of new params are different from what was so far.
69 bool setParams(InsetGraphicsParams const & params);
71 /// Get the inset parameters, used by the GUIndependent dialog.
72 InsetGraphicsParams const & params() const;
74 void draw(PainterInfo & pi, int x, int y) const;
76 void edit(Cursor & cur, bool front, EntryDirection entry_from);
78 void editGraphics(InsetGraphicsParams const &, Buffer const &) const;
80 bool getStatus(Cursor &, FuncRequest const &, FuncStatus &) const;
81 /// all graphics can be embedded
82 void registerEmbeddedFiles(EmbeddedFileList &) const;
84 void updateEmbeddedFile(EmbeddedFile const &);
86 void addToToc(ParConstIterator const &) const;
88 docstring contextMenu(BufferView const & bv, int x, int y) const;
90 /// Force inset into LTR environment if surroundings are RTL?
91 virtual bool forceLTR() const { return true; }
93 InsetGraphics(InsetGraphics const &);
95 virtual void doDispatch(Cursor & cur, FuncRequest & cmd);
97 friend class InsetGraphicsMailer;
99 virtual Inset * clone() const;
101 /// Read the inset native format
102 void readInsetGraphics(Lexer & lex, std::string const & bufpath);
104 /// Get the status message, depends on the image loading status.
105 std::string const statusMessage() const;
106 /// Create the options for the latex command.
107 std::string const createLatexOptions() const;
108 /// Create length values for docbook export.
109 docstring const toDocbookLength(Length const & len) const;
110 /// Create the atributes for docbook export.
111 docstring const createDocBookAttributes() const;
112 /// Convert the file if needed, and return the location of the file.
113 std::string prepareFile(OutputParams const &) const;
116 InsetGraphicsParams params_;
118 /// holds the entity name that defines the graphics location (SGML).
119 docstring const graphic_label;
121 /// The thing that actually draws the image on LyX's screen.
122 boost::scoped_ptr<RenderGraphic> const graphic_;
126 class InsetGraphicsMailer : public MailInset {
129 InsetGraphicsMailer(InsetGraphics & inset);
131 virtual Inset & inset() const { return inset_; }
133 virtual std::string const & name() const { return name_; }
135 virtual std::string const inset2string(Buffer const &) const;
137 static void string2params(std::string const & data,
138 Buffer const & buffer,
139 InsetGraphicsParams &);
141 static std::string const params2string(InsetGraphicsParams const &,
145 static std::string const name_;
147 InsetGraphics & inset_;