src/mathed/math_scriptinset.h

   1 // -*- C++ -*-
   2 #ifndef MATH_SCRIPTINSET_H
   3 #define MATH_SCRIPTINSET_H
   4
   5 #include "math_nestinset.h"
   6
   7 #ifdef __GNUG__
   8 #pragma interface
   9 #endif
  10
  11 /** Inset for super- and subscripts
  12     \author André Pönitz
  13  */
  14
  15 class MathScriptInset : public MathNestInset {
  16 public:
  17         ///
  18         MathScriptInset();
  19         ///
  20         explicit MathScriptInset(bool up);
  21         ///
  22         MathInset * clone() const;
  23         ///
  24         void write(WriteStream & os) const;
  25         ///
  26         void normalize(NormalStream & os) const;
  27         ///
  28         void metrics(MathMetricsInfo const & st) const;
  29         ///
  30         void draw(Painter &, int x, int y) const;
  31
  32         ///
  33         void metrics(MathInset const * nuc, MathMetricsInfo const & st) const;
  34         ///
  35         void draw(MathInset const * nuc, Painter &, int x, int y) const;
  36         ///
  37         int ascent(MathInset const * nuc) const;
  38         ///
  39         int descent(MathInset const * nuc) const;
  40         ///
  41         int width(MathInset const * nuc) const;
  42
  43         ///
  44         bool idxLeft(idx_type &, pos_type &) const;
  45         ///
  46         bool idxRight(idx_type &, pos_type &) const;
  47         ///
  48         bool idxFirstUp(idx_type &, pos_type &) const;
  49         ///
  50         bool idxFirstDown(idx_type &, pos_type &) const;
  51         ///
  52         bool idxLastUp(idx_type &, pos_type &) const;
  53         ///
  54         bool idxLastDown(idx_type &, pos_type &) const;
  55
  56         ///
  57         MathScriptInset const * asScriptInset() const;
  58         ///
  59         MathScriptInset * asScriptInset();
  60
  61         /// set limits
  62         void limits(int lim) { limits_ = lim; }
  63         ///
  64         int limits() const { return limits_; }
  65         ///
  66         bool hasLimits(MathInset const * nuc) const;
  67         /// true if we have an "inner" position
  68         MathXArray const & up() const;
  69         /// returns subscript
  70         MathXArray const & down() const;
  71         /// returns superscript
  72         MathXArray & up();
  73         /// returns subscript
  74         MathXArray & down();
  75         /// do we have a superscript?
  76         bool hasUp() const;
  77         /// do we have a subscript?
  78         bool hasDown() const;
  79         /// do we have a script?
  80         bool has(bool up) const;
  81         /// remove script
  82         void removeScript(bool up);
  83         /// remove script
  84         void removeEmptyScripts();
  85         ///
  86         void ensure(bool up);
  87
  88         // call these methods ...2 to make compaq cxx in anal mode happy...
  89         /// suppresses empty braces if necessary
  90         virtual void write2(MathInset const * nuc, WriteStream & os) const;
  91         ///
  92         virtual void normalize2(MathInset const * nuc, NormalStream & os) const;
  93         ///
  94         virtual void octavize2(MathInset const * nuc, OctaveStream & os) const;
  95         ///
  96         virtual void maplize2(MathInset const * nuc, MapleStream & os) const;
  97         ///
  98         virtual void mathmlize2(MathInset const * nuc, MathMLStream & os) const;
  99
 100 public:
 101         /// returns x offset for main part
 102         int dxx(MathInset const * nuc) const;
 103         /// returns width of nucleus if any
 104         int nwid(MathInset const * nuc) const;
 105 private:
 106         /// returns y offset for superscript
 107         int dy0(MathInset const * nuc) const;
 108         /// returns y offset for subscript
 109         int dy1(MathInset const * nuc) const;
 110         /// returns x offset for superscript
 111         int dx0(MathInset const * nuc) const;
 112         /// returns x offset for subscript
 113         int dx1(MathInset const * nuc) const;
 114         /// returns ascent of nucleus if any
 115         int nasc(MathInset const * nuc) const;
 116         /// returns descent of nucleus if any
 117         int ndes(MathInset const * nuc) const;
 118
 119         /// possible subscript (index 0) and superscript (index 1)
 120         bool script_[2];
 121         ///
 122         int limits_;
 123         ///
 124         mutable MathMetricsInfo mi_;
 125 };
 126
 127 #endif
 128