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
19 #include "insets/lyxinset.h"
20 #include "LaTeXFeatures.h"
22 #include "insets/BoundingBox.h"
25 class InsetGraphics : public Inset {
28 int ascent(Painter &, LyXFont const &) const;
30 int descent(Painter &, LyXFont const &) const;
32 int width(Painter &, LyXFont const &) const;
34 void draw(Painter &, LyXFont const &,
35 int baseline, float & x) const;
37 void Edit(BufferView *, int, int, unsigned int);
39 EDITABLE Editable() const;
41 void Write(ostream &) const;
43 void Read(LyXLex & lex);
44 /** returns the number of rows (\n's) of generated tex code.
45 fragile != 0 means, that the inset should take care about
46 fragile commands by adding a \protect before.
48 int Latex(ostream &, signed char fragile) const;
49 #ifndef USE_OSTREAM_ONLY
51 int Latex(string & file, signed char fragile) const;
53 int Linuxdoc(string & /*file*/) const;
55 int DocBook(string & /*file*/) const;
58 int Linuxdoc(ostream &) const;
60 int DocBook(ostream &) const;
62 /// Updates needed features for this inset.
63 void Validate(LaTeXFeatures & features) const;
65 /// returns LyX code associated with the inset. Used for TOC, ...)
66 Inset::Code LyxCode() const { return Inset::GRAPHICS_CODE; }
69 Inset * Clone() const;
76 // We need variables to store the size of the boundingbox and
77 // to store a pointer to the pixmap in.. The question is if
78 // these should be in a "pixmap" class.
79 // We also need to have variables about rotation and scaling,
80 // width and height. in effect all the paramters that
81 // \includegrapichs can handle. (the graphix.sty package)
83 /** The "bounding box" of the graphics image. Its value field
84 must contain four dimensions, separated by spaces. */
86 /** The bounding box above is used for display and file both.
87 But we need this variable below to know if we shall use the
88 bounding box in the LaTex command or not. (i.e. if the user
89 has manually set the bb.) */
92 /** When a graphics file is parsed we first check for BoundingBox
93 and then for HiResBoundingBox, and set hiresbb depending on this.
94 This key makes LaTeX search for %%HiResBoundingBox comments
95 instead of the normal %%BoundingBox. Some applications use
96 this to specify more precise bounding boxes, becase the cumbers
97 can normally only have integer values. It is a Boolean, either
100 /** This key takes four arguments (like bb), but in this case the
101 origin is taken with respect to the bounding box specified in
102 the file. So to view a 20 bp square at the lower left-hand corner
103 of the picture, specify viewport=0 0 20 20. */
104 BoundingBox viewport;
105 /** Similar to the viewport key, but the four dimensions correspond
106 to the amount of space to be trimmed (cut off) at the left-hand
107 side, bottom, right-hand side and top of the included graphics. */
109 /// Natural height of figure
111 /// Natural width of figure.
113 /// Rotation angle (in degrees, counterclockwise).
115 /// This is the different origins that the graphicx package support.
130 REFERENCE_POINT = LEFTBASELINE
132 /** Origin for rotation, similar to the origin parameter of
133 the \rotatebox command described on p.46 and Fig. 2.2 on p.46. */
135 /// Required width (the width of the image is scaled to that value).
137 /// Required height (the height of the image is scaled to that value).
139 /** Required total height (the total height of the image is scaled
140 to that value). This key should be used instead of height if
141 images are rotated over 90 degrees, since the height can
142 disappear (and become the depth) and LaTeX will have difficulties
143 satisfying the user's request. */
144 LyXLength totalheight;
145 /** Boolean variable that can have the values "true" and "false"
146 (se above for defaults). When true, specifying both width and
147 height parameters does not distort the picture, but the image
148 is scaled so that neither of the width of height exceeds the
150 bool keepaspectratio;
153 /** Clip the graphic to the bounding box. It is a Boolean, either
154 "true" or "false". */
156 /// Locally switch to draft mode. A Boolean valued key, like clip.
158 /// The graphics type.
160 ///x The file extension of the file containing the image data.
162 /// The file extension of the file "read" by LaTeX.
164 /// Any command to be applied to the file.