src/insets/insetgraphics.h

   1 // -*- C++ -*-
   2 /* This file is part of
   3  * ======================================================
   4  *
   5  *           LyX, The Document Processor
   6  *
   7  *           Copyright 1995 Matthias Ettrich
   8  *           Copyright 1995-2000 the LyX Team.
   9  *
  10  * ====================================================== */
  11
  12 #ifndef INSET_GRAPHICS_H
  13 #define INSET_GRAPHICS_H
  14
  15 #ifdef __GNUG__
  16 #pragma interface
  17 #endif
  18
  19 #include "insets/lyxinset.h"
  20 #include "LaTeXFeatures.h"
  21 #include "vspace.h"
  22 #include "insets/BoundingBox.h"
  23
  24 ///
  25 class InsetGraphics : public Inset {
  26 public:
  27         ///
  28         int ascent(Painter &, LyXFont const &) const;
  29         ///
  30         int descent(Painter &, LyXFont const &) const;
  31         ///
  32         int width(Painter &, LyXFont const &) const;
  33         ///
  34         void draw(Painter &, LyXFont const &,
  35                           int baseline, float & x) const;
  36         ///
  37         void Edit(BufferView *, int, int, unsigned int);
  38         ///
  39         unsigned char Editable() const;
  40         ///
  41         void Write(ostream &) const;
  42         ///
  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.
  47          */
  48         int Latex(ostream &, signed char fragile) const;
  49 #ifndef USE_OSTREAM_ONLY
  50         ///
  51         int Latex(string & file, signed char fragile) const;
  52 #endif
  53         ///
  54         int Linuxdoc(string & /*file*/) const;
  55         ///
  56         int DocBook(string & /*file*/) const;
  57         /// Updates needed features for this inset.
  58         void Validate(LaTeXFeatures & features) const;
  59
  60         /// returns LyX code associated with the inset. Used for TOC, ...)
  61         Inset::Code LyxCode() const { return Inset::GRAPHICS_CODE; }
  62
  63         ///
  64         Inset * Clone() const;
  65 private:
  66         ///
  67         string graphicsfile;
  68         ///
  69         Pixmap pixmap;
  70
  71         // We need variables to store the size of the boundingbox and
  72         // to store a pointer to the pixmap in.. The question is if
  73         // these should be in a "pixmap" class.
  74         // We also need to have variables about rotation and scaling,
  75         // width and height. in effect all the paramters that
  76         // \includegrapichs can handle. (the graphix.sty package)
  77
  78         /** The "bounding box" of the graphics image. Its value field
  79             must contain four dimensions, separated by spaces.  */
  80         BoundingBox bb;
  81         /** The bounding box above is used for display and file both.
  82             But we need this variable below to know if we shall use the
  83             bounding box in the LaTex command or not. (i.e. if the user
  84             has manually set the bb.) */
  85         bool use_bb;
  86
  87         /** When a graphics file is parsed we first check for BoundingBox
  88             and then for HiResBoundingBox, and set hiresbb depending on this.
  89             This key makes LaTeX search for %%HiResBoundingBox comments
  90             instead of the normal %%BoundingBox. Some applications use
  91             this to specify more precise bounding boxes, becase the cumbers
  92             can normally only have integer values. It is a Boolean, either
  93             "true" or "false". */
  94         bool hiresbb;
  95         /** This key takes four arguments (like bb), but in this case the
  96             origin is taken with respect to the bounding box specified in
  97             the file. So to view a 20 bp square at the lower left-hand corner
  98             of the picture, specify viewport=0 0 20 20. */
  99         BoundingBox viewport;
 100         /** Similar to the viewport key, but the four dimensions correspond
 101             to the amount of space to be trimmed (cut off) at the left-hand
 102             side, bottom, right-hand side and top of the included graphics. */
 103         BoundingBox trim;
 104         /// Natural height of figure
 105         LyXLength natheight;
 106         /// Natural width of figure.
 107         LyXLength natwidth;
 108         /// Rotation angle (in degrees, counterclockwise).
 109         float angle;
 110         /// This is the different origins that the graphicx package support.
 111         enum Origin {
 112                 DEFAULT,
 113                 LEFTTOP,
 114                 LEFTCENTER,
 115                 LEFTBASELINE,
 116                 LEFTBOTTOM,
 117                 CENTERTOP,
 118                 CENTER,
 119                 CENTERBASELINE,
 120                 CENTERBOTTOM,
 121                 RIGHTTOP,
 122                 RIGHTCENTER,
 123                 RIGHTBASELINE,
 124                 RIGHTBOTTOM,
 125                 REFERENCE_POINT = LEFTBASELINE
 126         };
 127         /** Origin for rotation, similar to the origin parameter of
 128             the \rotatebox command described on p.46 and Fig. 2.2 on p.46. */
 129         Origin origin;
 130         /// Required width (the width of the image is scaled to that value).
 131         LyXLength g_width;
 132         /// Required height (the height of the image is scaled to that value).
 133         LyXLength g_height;
 134         /** Required total height (the total height of the image is scaled
 135             to that value). This key should be used instead of height if
 136             images are rotated over 90 degrees, since the height can
 137             disappear (and become the depth) and LaTeX will have difficulties
 138             satisfying the user's request. */
 139         LyXLength totalheight;
 140         /** Boolean variable that can have the values "true" and "false"
 141             (se above for defaults). When true, specifying both width and
 142             height parameters does not distort the picture, but the image
 143             is scaled so that neither of the width of height exceeds the
 144             given dimensions. */
 145         bool keepaspectratio;
 146         /// Scale factor
 147         float scale;
 148         /** Clip the graphic to the bounding box. It is a Boolean, either
 149             "true" or "false". */
 150         bool clip;
 151         /// Locally switch to draft mode. A Boolean valued key, like clip.
 152         bool draft;
 153         /// The graphics type.
 154         string type;
 155         ///x The file extension of the file containing the image data.
 156         string ext;
 157         /// The file extension of the file "read" by LaTeX.
 158         string read;
 159         /// Any command to be applied to the file.
 160         string command;
 161 };
 162
 163 #endif