src/mathed/InsetMathScript.h

   1 // -*- C++ -*-
   2 /**
   3  * \file InsetMathScript.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author André Pönitz
   8  *
   9  * Full author contact details are available in file CREDITS.
  10  */
  11
  12 #ifndef MATH_SCRIPTINSET_H
  13 #define MATH_SCRIPTINSET_H
  14
  15 #include "InsetMathNest.h"
  16
  17
  18 namespace lyx {
  19
  20
  21 // An inset for super- and subscripts or both.  The 'nucleus' is always
  22 // cell 0.  If there is just one script, it's cell 1 and cell_1_is_up_
  23 // is set accordingly.  If both are used, cell 1 is up and cell 2 is down.
  24
  25 class InsetMathScript : public InsetMathNest {
  26 public:
  27         /// create inset without scripts
  28         InsetMathScript(Buffer * buf);
  29         /// create inset with single script
  30         explicit InsetMathScript(Buffer * buf, bool up);
  31         /// create inset with single script and given nucleus
  32         InsetMathScript(Buffer * buf, MathAtom const & at, bool up);
  33         ///
  34         mode_type currentMode() const { return MATH_MODE; }
  35         ///
  36         void metrics(MetricsInfo & mi, Dimension & dim) const;
  37         ///
  38         void draw(PainterInfo & pi, int x, int y) const;
  39         ///
  40         void metricsT(TextMetricsInfo const & mi, Dimension & dim) const;
  41         ///
  42         void drawT(TextPainter & pi, int x, int y) const;
  43
  44         /// move cursor backwards
  45         bool idxBackward(Cursor & cur) const;
  46         /// move cursor forward
  47         bool idxForward(Cursor & cur) const;
  48         /// move cursor up or down
  49         bool idxUpDown(Cursor & cur, bool up) const;
  50         /// Target pos when we enter the inset while moving forward
  51         bool idxFirst(Cursor & cur) const;
  52         /// Target pos when we enter the inset while moving backwards
  53         bool idxLast(Cursor & cur) const;
  54
  55         /// write LaTeX and Lyx code
  56         void write(WriteStream & os) const;
  57         /// write normalized content
  58         void normalize(NormalStream &) const;
  59         /// write content as something readable by Maple
  60         void maple(MapleStream &) const;
  61         /// write content as something readable by Mathematica
  62         void mathematica(MathematicaStream &) const;
  63         /// write content as something resembling MathML
  64         docstring mathmlize(MathStream &) const;
  65         /// write content as something readable by Octave
  66         void octave(OctaveStream &) const;
  67
  68         /// identifies scriptinsets
  69         InsetMathScript const * asScriptInset() const;
  70         ///
  71         InsetMathScript * asScriptInset();
  72
  73         /// set limits
  74         void limits(int lim) { limits_ = lim; }
  75         /// get limits
  76         int limits() const { return limits_; }
  77         /// returns subscript. Always run 'hasDown' or 'has(false)' before!
  78         MathData const & down() const;
  79         /// returns subscript. Always run 'hasDown' or 'has(false)' before!
  80         MathData & down();
  81         /// returns superscript. Always run 'hasUp' or 'has(true)' before!
  82         MathData const & up() const;
  83         /// returns superscript. Always run 'hasUp' or 'has(true)' before!
  84         MathData & up();
  85         /// returns nucleus
  86         MathData const & nuc() const;
  87         /// returns nucleus
  88         MathData & nuc();
  89         /// do we have a superscript?
  90         bool hasUp() const;
  91         /// do we have a subscript?
  92         bool hasDown() const;
  93         /// do we have a script?
  94         bool has(bool up) const;
  95         /// what idx has super/subscript?
  96         idx_type idxOfScript(bool up) const;
  97         /// remove script
  98         void removeScript(bool up);
  99         /// make sure a script is accessible
 100         void ensure(bool up);
 101         /// say that we have scripts
 102         void infoize(odocstream & os) const;
 103         /// say whether we have displayed limits
 104         void infoize2(odocstream & os) const;
 105         ///
 106         InsetCode lyxCode() const { return MATH_SCRIPT_CODE; }
 107
 108 protected:
 109         virtual void doDispatch(Cursor & cur, FuncRequest & cmd);
 110 private:
 111         virtual Inset * clone() const;
 112         /// returns x offset for main part
 113         int dxx(BufferView const & bv) const;
 114         /// returns width of nucleus if any
 115         int nwid(BufferView const &) const;
 116         /// returns y offset for either superscript or subscript
 117         int dy01(BufferView const &, int asc, int des, int what) const;
 118         /// returns y offset for superscript
 119         int dy0(BufferView const &) const;
 120         /// returns y offset for subscript
 121         int dy1(BufferView const &) const;
 122         /// returns x offset for superscript
 123         int dx0(BufferView const & bv) const;
 124         /// returns x offset for subscript
 125         int dx1(BufferView const & bv) const;
 126         /// returns ascent of nucleus if any
 127         int nasc(BufferView const &) const;
 128         /// returns descent of nucleus if any
 129         int ndes(BufferView const &) const;
 130         /// returns superscript kerning of nucleus if any
 131         int nker(BufferView const * bv) const;
 132         /// where do we have to draw the scripts?
 133         bool hasLimits() const;
 134         /// clean up empty cells and return true if a cell has been deleted.
 135         bool notifyCursorLeaves(Cursor const & old, Cursor & cur);
 136
 137         /// possible subscript (index 0) and superscript (index 1)
 138         bool cell_1_is_up_;
 139         /// 1 - "limits", -1 - "nolimits", 0 - "default"
 140         int limits_;
 141 };
 142
 143
 144 } // namespace lyx
 145
 146 #endif