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 explicit 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; }
60 InsetGraphics * asInsetGraphics() { return this; }
62 InsetGraphics const * asInsetGraphics() const { return this; }
65 bool isLabeled() const { return true; }
67 bool hasSettings() const { return true; }
69 void write(std::ostream &) const;
71 void read(Lexer & lex);
72 /** returns the number of rows (\n's) of generated tex code.
73 #fragile == true# means, that the inset should take care about
74 fragile commands by adding a #\protect# before.
76 void latex(otexstream &, OutputParams const &) const;
78 int plaintext(odocstringstream & ods, OutputParams const & op,
79 size_t max_length = INT_MAX) const;
81 void docbook(XMLStream &, OutputParams const &) const;
83 docstring xhtml(XMLStream & os, OutputParams const &) const;
84 /** Tell LyX what the latex features you need i.e. what latex packages
85 you need to be included.
87 void validate(LaTeXFeatures & features) const;
88 /// returns LyX code associated with the inset. Used for TOC, ...)
89 InsetCode lyxCode() const { return GRAPHICS_CODE; }
91 docstring layoutName() const { return from_ascii("Graphics"); }
92 /// Get the inset parameters, used by the GUIndependent dialog.
93 InsetGraphicsParams const & params() const;
96 int topOffset(BufferView const *) const { return 0; }
98 int bottomOffset(BufferView const *) const { return 0; }
100 int leftOffset(BufferView const *) const { return 0; }
102 int rightOffset(BufferView const *) const { return 0; }
105 void metrics(MetricsInfo &, Dimension &) const;
107 void draw(PainterInfo & pi, int x, int y) const;
109 bool showInsetDialog(BufferView * bv) const;
111 void editGraphics(InsetGraphicsParams const &) const;
113 bool getStatus(Cursor &, FuncRequest const &, FuncStatus &) const;
115 void addToToc(DocIterator const & di, bool output_active,
116 UpdateType utype, TocBackend & backend) const;
118 std::string contextMenuName() const;
119 /// Force inset into LTR environment if surroundings are RTL
120 bool forceLTR(OutputParams const &) const { return true; }
122 void doDispatch(Cursor & cur, FuncRequest & cmd);
124 Inset * clone() const;
125 /// Get the status message, depends on the image loading status.
126 std::string statusMessage() const;
127 /// Get the output bounding box accounting for raster formats.
128 void outBoundingBox(graphics::BoundingBox &) const;
129 /// Create the options for the latex command.
130 std::string createLatexOptions(bool const ps) const;
131 /// Create length values for docbook export.
132 docstring toDocbookLength(Length const & len) const;
133 /// Create the attributes for docbook export.
134 docstring createDocBookAttributes() const;
135 /// Convert the file if needed, and return the location of the file.
136 /// This version is for use with LaTeX-style output.
137 std::string prepareFile(OutputParams const &) const;
138 /// Convert the file if needed, and return the location of the file.
139 /// This version is for use with HTML-style output.
140 /// \return the new filename, relative to the location of the HTML file,
141 /// or an empty string on error.
142 std::string prepareHTMLFile(OutputParams const & runparams) const;
144 OutputParams::CtObject CtObject(OutputParams const &) const { return OutputParams::CT_OBJECT; }
148 InsetGraphics(InsetGraphics const &);
151 InsetGraphicsParams params_;
152 /// holds the entity name that defines the graphics location (SGML).
153 docstring const graphic_label;
155 docstring toolTip(BufferView const & bv, int x, int y) const;
156 /// The thing that actually draws the image on LyX's screen.
157 RenderGraphic * graphic_;
162 /// Saves the list of currently used groups in the document.
163 void getGraphicsGroups(Buffer const &, std::set<std::string> &);
165 /// how many members has the current group?
166 int countGroupMembers(Buffer const &, std::string const &);
168 /// Returns parameters of a given graphics group (except filename).
169 std::string getGroupParams(Buffer const &, std::string const &);
171 /** Synchronize all Graphics insets of the group.
172 Both groupId and params are taken from argument.
174 void unifyGraphicsGroups(Buffer &, std::string const &);
175 InsetGraphics * getCurrentGraphicsInset(Cursor const &);
177 } // namespace graphics
181 #endif // INSET_GRAPHICS_H