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
18 #include "InsetGraphicsParams.h"
25 /////////////////////////////////////////////////////////////////////////
29 /////////////////////////////////////////////////////////////////////////
31 /// Used for images etc.
32 class InsetGraphics : public Inset
36 InsetGraphics(Buffer & buf);
41 static void string2params(std::string const & data,
42 Buffer const & buffer,
43 InsetGraphicsParams &);
45 static std::string params2string(InsetGraphicsParams const &,
48 /** Set the inset parameters, used by the GUIndependent dialog.
49 Return true of new params are different from what was so far.
51 bool setParams(InsetGraphicsParams const & params);
53 InsetGraphicsParams getParams() const { return params_;}
57 InsetGraphics(InsetGraphics const &);
60 bool isLabeled() const { return true; }
61 void metrics(MetricsInfo &, Dimension &) const;
63 EDITABLE editable() const;
65 void write(std::ostream &) const;
67 void read(Lexer & lex);
68 /** returns the number of rows (\n's) of generated tex code.
69 #fragile == true# means, that the inset should take care about
70 fragile commands by adding a #\protect# before.
72 int latex(odocstream &, OutputParams const &) const;
74 int plaintext(odocstream &, OutputParams const &) const;
76 int docbook(odocstream &, OutputParams const &) const;
77 /** Tell LyX what the latex features you need i.e. what latex packages
78 you need to be included.
80 void validate(LaTeXFeatures & features) const;
81 /// returns LyX code associated with the inset. Used for TOC, ...)
82 InsetCode lyxCode() const { return GRAPHICS_CODE; }
83 /// Get the inset parameters, used by the GUIndependent dialog.
84 InsetGraphicsParams const & params() const;
86 void draw(PainterInfo & pi, int x, int y) const;
88 void edit(Cursor & cur, bool front, EntryDirection entry_from);
90 void editGraphics(InsetGraphicsParams const &, Buffer const &) const;
92 bool getStatus(Cursor &, FuncRequest const &, FuncStatus &) const;
94 void addToToc(DocIterator const &);
96 docstring contextMenu(BufferView const & bv, int x, int y) const;
97 /// Force inset into LTR environment if surroundings are RTL?
98 bool forceLTR() const { return true; }
100 void doDispatch(Cursor & cur, FuncRequest & cmd);
102 Inset * clone() const;
103 /// Get the status message, depends on the image loading status.
104 std::string statusMessage() const;
105 /// Create the options for the latex command.
106 std::string createLatexOptions() const;
107 /// Create length values for docbook export.
108 docstring toDocbookLength(Length const & len) const;
109 /// Create the atributes for docbook export.
110 docstring createDocBookAttributes() const;
111 /// Convert the file if needed, and return the location of the file.
112 std::string prepareFile(OutputParams const &) const;
115 InsetGraphicsParams params_;
116 /// holds the entity name that defines the graphics location (SGML).
117 docstring const graphic_label;
118 /// The thing that actually draws the image on LyX's screen.
119 RenderGraphic * graphic_;
124 /// Saves the list of currently used groups in the document.
125 void getGraphicsGroups(Buffer const &, std::set<std::string> &);
127 /// how many members has the current group?
128 int countGroupMembers(Buffer const &, std::string const &);
130 /// Returns parameters of a given graphics group (except filename).
131 std::string getGroupParams(Buffer const &, std::string const &);
133 /** Synchronize all Graphics insets of the group.
134 Both groupId and params are taken from argument.
136 void unifyGraphicsGroups(Buffer &, std::string const &);
137 InsetGraphics * getCurrentGraphicsInset(Cursor const &);
143 #endif // INSET_GRAPHICS_H