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"
26 /////////////////////////////////////////////////////////////////////////
30 /////////////////////////////////////////////////////////////////////////
32 /// Used for images etc.
33 class InsetGraphics : public Inset
37 InsetGraphics(Buffer * buf);
42 static void string2params(std::string const & data,
43 Buffer const & buffer,
44 InsetGraphicsParams &);
46 static std::string params2string(InsetGraphicsParams const &,
49 /** Set the inset parameters, used by the GUIndependent dialog.
50 Return true of new params are different from what was so far.
52 bool setParams(InsetGraphicsParams const & params);
54 InsetGraphicsParams getParams() const { return params_;}
56 bool clickable(BufferView const &, int, int) const { return true; }
58 bool canPaintChange(BufferView const &) const { return true; };
62 InsetGraphics(InsetGraphics const &);
65 bool isLabeled() const { return true; }
66 void metrics(MetricsInfo &, Dimension &) const;
68 bool hasSettings() const { return true; }
70 void write(std::ostream &) const;
72 void read(Lexer & lex);
73 /** returns the number of rows (\n's) of generated tex code.
74 #fragile == true# means, that the inset should take care about
75 fragile commands by adding a #\protect# before.
77 void latex(otexstream &, OutputParams const &) const;
79 int plaintext(odocstringstream & ods, OutputParams const & op,
80 size_t max_length = INT_MAX) const;
82 int docbook(odocstream &, OutputParams const &) const;
84 docstring xhtml(XHTMLStream & os, OutputParams const &) const;
85 /** Tell LyX what the latex features you need i.e. what latex packages
86 you need to be included.
88 void validate(LaTeXFeatures & features) const;
89 /// returns LyX code associated with the inset. Used for TOC, ...)
90 InsetCode lyxCode() const { return GRAPHICS_CODE; }
92 docstring layoutName() const { return from_ascii("Graphics"); }
93 /// Get the inset parameters, used by the GUIndependent dialog.
94 InsetGraphicsParams const & params() const;
96 void draw(PainterInfo & pi, int x, int y) const;
98 bool showInsetDialog(BufferView * bv) const;
100 void editGraphics(InsetGraphicsParams const &) const;
102 bool getStatus(Cursor &, FuncRequest const &, FuncStatus &) const;
104 void addToToc(DocIterator const & di, bool output_active,
105 UpdateType utype) const;
107 std::string contextMenuName() const;
108 /// Force inset into LTR environment if surroundings are RTL
109 bool forceLTR() const { return true; }
111 void doDispatch(Cursor & cur, FuncRequest & cmd);
113 Inset * clone() const;
114 /// Get the status message, depends on the image loading status.
115 std::string statusMessage() const;
116 /// Create the options for the latex command.
117 std::string createLatexOptions() const;
118 /// Create length values for docbook export.
119 docstring toDocbookLength(Length const & len) const;
120 /// Create the atributes for docbook export.
121 docstring createDocBookAttributes() const;
122 /// Convert the file if needed, and return the location of the file.
123 /// This version is for use with LaTeX-style output.
124 std::string prepareFile(OutputParams const &) const;
125 /// Convert the file if needed, and return the location of the file.
126 /// This version is for use with HTML-style output.
127 /// \return the new filename, relative to the location of the HTML file,
128 /// or an empty string on error.
129 std::string prepareHTMLFile(OutputParams const & runparams) const;
132 InsetGraphicsParams params_;
133 /// holds the entity name that defines the graphics location (SGML).
134 docstring const graphic_label;
136 docstring toolTip(BufferView const & bv, int x, int y) const;
137 /// The thing that actually draws the image on LyX's screen.
138 RenderGraphic * graphic_;
143 /// Saves the list of currently used groups in the document.
144 void getGraphicsGroups(Buffer const &, std::set<std::string> &);
146 /// how many members has the current group?
147 int countGroupMembers(Buffer const &, std::string const &);
149 /// Returns parameters of a given graphics group (except filename).
150 std::string getGroupParams(Buffer const &, std::string const &);
152 /** Synchronize all Graphics insets of the group.
153 Both groupId and params are taken from argument.
155 void unifyGraphicsGroups(Buffer &, std::string const &);
156 InsetGraphics * getCurrentGraphicsInset(Cursor const &);
162 #endif // INSET_GRAPHICS_H