2 /* This file is part of
3 * ======================================================
5 * LyX, The Document Processor
7 * Copyright 1995 Matthias Ettrich
8 * Copyright 1995-2000 the LyX Team.
10 * ====================================================== */
12 #ifndef INSET_GRAPHICS_H
13 #define INSET_GRAPHICS_H
20 #include "insets/lyxinset.h"
21 #include "insets/insetgraphicsParams.h"
22 #include "graphics/GraphicsCacheItem.h"
24 #include "LaTeXFeatures.h"
26 // We need a signal here to hide an active dialog when we are deleted.
27 #include "sigc++/signal_system.h"
28 #ifdef SIGC_CXX_NAMESPACES
38 #ifdef SIGC_CXX_NAMESPACES
39 class InsetGraphics : public Inset, public SigC::Object
41 class InsetGraphics : public Inset, public Object
50 int ascent(BufferView *, LyXFont const &) const;
52 int descent(BufferView *, LyXFont const &) const;
54 int width(BufferView *, LyXFont const &) const;
56 bool display() const { return true; }
58 void draw(BufferView *, LyXFont const &, int, float &, bool) const;
60 void Edit(BufferView *, int, int, unsigned int);
62 EDITABLE Editable() const;
64 void Write(Buffer const *, std::ostream &) const;
66 void Read(Buffer const *, LyXLex & 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(Buffer const *, std::ostream &,
73 bool fragile, bool free_spc) const;
75 int Ascii(Buffer const *, std::ostream &, int linelen) const;
77 int Linuxdoc(Buffer const *, std::ostream &) const;
79 int DocBook(Buffer const *, std::ostream &) const;
81 /** Tell LyX what the latex features you need i.e. what latex packages
82 you need to be included.
84 void Validate(LaTeXFeatures & features) const;
86 /// returns LyX code associated with the inset. Used for TOC, ...)
87 Inset::Code LyxCode() const { return Inset::GRAPHICS_CODE; }
90 Inset * Clone(Buffer const &) const;
92 /** Set the inset parameters, used by the GUIndependent dialog.
93 Return true of new params are different from what was so far.
95 bool setParams(InsetGraphicsParams const & params);
97 /// Get the inset parameters, used by the GUIndependent dialog.
98 InsetGraphicsParams getParams() const;
100 /** This signal is connected by our dialog and called when the inset
105 /// Update the inset after parameter change.
106 void updateInset() const;
107 /// Get the status message, depends on the image loading status.
108 char const * statusMessage() const;
110 /// The graphics cache handle.
111 mutable GraphicsCacheItem * cacheHandle;
114 mutable LyXImage * pixmap;
115 /// is the pixmap initialized?
116 mutable bool pixmapInitialized;
118 InsetGraphicsParams params;
120 // Baruch Even (baruch.even@writeme.com) 2000-07-17
121 // This was the intended way however it is not flexible enough and
122 // only provides for LaTeX output.
124 // We need variables to store the size of the boundingbox and
125 // to store a pointer to the pixmap in.. The question is if
126 // these should be in a "pixmap" class.
127 // We also need to have variables about rotation and scaling,
128 // width and height. in effect all the paramters that
129 // \includegraphics can handle. (the graphix.sty package)
131 /** The "bounding box" of the graphics image. Its value field
132 must contain four dimensions, separated by spaces. */
134 /** The bounding box above is used for display and file both.
135 But we need this variable below to know if we shall use the
136 bounding box in the LaTex command or not. (i.e. if the user
137 has manually set the bb.) */
140 /** When a graphics file is parsed we first check for BoundingBox
141 and then for HiResBoundingBox, and set hiresbb depending on this.
142 This key makes LaTeX search for %%HiResBoundingBox comments
143 instead of the normal %%BoundingBox. Some applications use
144 this to specify more precise bounding boxes, becase the numbers
145 can normally only have integer values. It is a Boolean, either
146 "true" or "false". */
149 /** This key takes four arguments (like bb), but in this case the
150 origin is taken with respect to the bounding box specified in
151 the file. So to view a 20 bp square at the lower left-hand corner
152 of the picture, specify viewport=0 0 20 20. */
153 BoundingBox viewport;
155 /** Similar to the viewport key, but the four dimensions correspond
156 to the amount of space to be trimmed (cut off) at the left-hand
157 side, bottom, right-hand side and top of the included graphics. */
160 /// Natural height of figure
163 /// Natural width of figure.
166 /// Rotation angle (in degrees, counterclockwise).
169 /** Origin for rotation, similar to the origin parameter of
170 the \rotatebox command described on p.46 and Fig. 2.2 on p.46. */
173 /// Required width (the width of the image is scaled to that value).
176 /// Required height (the height of the image is scaled to that value).
179 /** Required total height (the total height of the image is scaled
180 to that value). This key should be used instead of height if
181 images are rotated over 90 degrees, since the height can
182 disappear (and become the depth) and LaTeX will have difficulties
183 satisfying the user's request. */
184 LyXLength totalheight;
186 /** Boolean variable that can have the values "true" and "false"
187 (se above for defaults). When true, specifying both width and
188 height parameters does not distort the picture, but the image
189 is scaled so that neither of the width of height exceeds the
191 bool keepaspectratio;
196 /** Clip the graphic to the bounding box. It is a Boolean, either
197 "true" or "false". */
200 /// Locally switch to draft mode. A Boolean valued key, like clip.
203 /// The graphics type.
206 /// The file extension of the file containing the image data.
209 /// The file extension of the file "read" by LaTeX.
212 /// Any command to be applied to the file.