src/mathed/math_inset.h

   1 // -*- C++ -*-
   2 /*
   3  *  File:        math_inset.h
   4  *  Purpose:     Declaration of insets for mathed
   5  *  Author:      Alejandro Aguilar Sierra <asierra@servidor.unam.mx>
   6  *  Created:     January 1996
   7  *  Description: Math paragraph and objects for a WYSIWYG math editor.
   8  *
   9  *  Dependencies: Xlib, XForms
  10  *
  11  *  Copyright: 1996, 1997 Alejandro Aguilar Sierra
  12  *
  13  *   Version: 0.8beta, Math & Lyx project.
  14  *
  15  *   You are free to use and modify this code under the terms of
  16  *   the GNU General Public Licence version 2 or later.
  17  */
  18
  19 //  Note: These math insets are internal to Math and are not derived
  20 //        from lyx inset.
  21
  22 #ifndef MATH_INSET_H
  23 #define MATH_INSET_H
  24
  25 #ifdef __GNUG__
  26 #pragma interface
  27 #endif
  28
  29 #include "LString.h"
  30 #include "symbol_def.h"
  31 #include "xarray.h"
  32
  33 /** Abstract base class for all math objects.
  34     A math insets is for use of the math editor only, it isn't a
  35     general LyX inset. It's used to represent all the math objects.
  36     The formulaInset (a LyX inset) encapsulates a math inset.
  37 */
  38
  39
  40 class MathInset {
  41 public:
  42         /** A math inset has a name (usually its LaTeX name),
  43             type and font-size
  44         */
  45         ///
  46         explicit MathInset
  47         (int na = 0, string const & nm = string(), MathInsetTypes ot = LM_OT_SIMPLE);
  48
  49         /// The virtual base destructor
  50         virtual ~MathInset() {}
  51
  52         /// Draw the object
  53         virtual void draw(Painter &, int x, int baseline) = 0;
  54         /// Write LaTeX and Lyx code
  55         virtual void Write(std::ostream &, bool fragile) const = 0;
  56         /// Write normalized content
  57         virtual void WriteNormal(std::ostream &) const;
  58         /// Reproduces itself
  59         virtual MathInset * clone() const = 0;
  60         /// Appends itself with macro arguments substituted
  61         virtual void substitute(MathArray & array, MathMacro const & macro) const;
  62         /// Compute the size of the object
  63         virtual void Metrics(MathStyles st) = 0;
  64         ///
  65         virtual int ascent() const;
  66         ///
  67         virtual int descent() const;
  68         ///
  69         virtual int width() const;
  70         ///
  71         virtual int height() const;
  72         ///
  73         virtual bool hasLimits() const;
  74         ///
  75         virtual int limits() const;
  76         ///
  77         virtual void limits(int);
  78         ///
  79         string const & name() const;
  80         ///
  81         MathInsetTypes GetType() const;
  82         //Man:  Avoid to use these functions if it's not strictly necessary
  83         ///
  84         virtual void SetType(MathInsetTypes t);
  85         ///
  86         virtual void SetName(string const & n);
  87         ///
  88         MathStyles size() const;
  89
  90         /// Where should we go when we press the up cursor key?
  91         virtual bool idxUp(int & idx, int & pos) const;
  92         /// The down key
  93         virtual bool idxDown(int & idx, int & pos) const;
  94         /// The left key
  95         virtual bool idxLeft(int & idx, int & pos) const;
  96         /// The right key
  97         virtual bool idxRight(int & idx, int & pos) const;
  98
  99         /// Move one physical cell up
 100         virtual bool idxNext(int & idx, int & pos) const;
 101         /// Move one physical cell down
 102         virtual bool idxPrev(int & idx, int & pos) const;
 103
 104         /// Target pos when we enter the inset from the left by pressing "Right"
 105         virtual bool idxFirst(int & idx, int & pos) const;
 106         /// Target pos when we enter the inset from the left by pressing "Up"
 107         virtual bool idxFirstUp(int & idx, int & pos) const;
 108         /// Target pos when we enter the inset from the left by pressing "Down"
 109         virtual bool idxFirstDown(int & idx, int & pos) const;
 110
 111         /// Target pos when we enter the inset from the right by pressing "Left"
 112         virtual bool idxLast(int & idx, int & pos) const;
 113         /// Target pos when we enter the inset from the right by pressing "Up"
 114         virtual bool idxLastUp(int & idx, int & pos) const;
 115         /// Target pos when we enter the inset from the right by pressing "Down"
 116         virtual bool idxLastDown(int & idx, int & pos) const;
 117
 118         /// Where should we go if we press home?
 119         virtual bool idxHome(int & idx, int & pos) const;
 120         /// Where should we go if we press end?
 121         virtual bool idxEnd(int & idx, int & pos) const;
 122
 123         /// Delete a cell and move cursor
 124         // a return value true indicates that the whole inset should be deleted
 125         virtual bool idxDelete(int idx);
 126
 127         ///
 128         int nargs() const;
 129
 130         ///
 131         MathArray & cell(int);
 132         ///
 133         MathArray const & cell(int) const;
 134         ///
 135         MathXArray & xcell(int);
 136         ///
 137         MathXArray const & xcell(int) const;
 138         ///
 139         void setData(MathArray const &, int);
 140
 141         ///
 142         int xo() const;
 143         ///
 144         int yo() const;
 145         ///
 146         void xo(int tx);
 147         ///
 148         void yo(int ty);
 149         ///
 150
 151         ///
 152         virtual int ncols() const { return 1; }
 153         ///
 154         virtual int nrows() const { return 1; }
 155         ///
 156         virtual int col(int) const { return 0; }
 157         ///
 158         virtual int row(int) const { return 0; }
 159         ///
 160         virtual void addRow(int) {}
 161         ///
 162         virtual void delRow(int) {}
 163         ///
 164         virtual void addCol(int) {}
 165         ///
 166         virtual void delCol(int) {}
 167
 168         ///
 169         virtual void UserSetSize(MathStyles &) {}
 170
 171         ///
 172         void GetXY(int & x, int & y) const;
 173         ///
 174         bool covers(int x, int y) const;
 175         /// Identifies ScriptInsets
 176         virtual bool isScriptInset() const { return false; }
 177         /// Identifies AccentInsets
 178         virtual bool isAccentInset() const { return false; }
 179         ///
 180         virtual bool isActive() const { return nargs() > 0; }
 181
 182
 183         ///
 184         void push_back(MathInset *);
 185         ///
 186         void push_back(byte ch, MathTextCodes fcode);
 187         ///
 188         void dump() const;
 189
 190         ///
 191         ///
 192         static int workwidth;
 193 protected:
 194         ///
 195         string name_;
 196         ///
 197         MathInsetTypes objtype;
 198         ///
 199         int width_;
 200         ///
 201         int ascent_;
 202         ///
 203         int descent_;
 204         ///
 205         void size(MathStyles s);
 206         ///
 207         MathStyles size_;
 208
 209 protected:
 210         ///
 211         typedef std::vector<MathXArray> cells_type;
 212         /**
 213          * The contents of the inset are contained here.
 214          * Each inset is build from a number of insets.
 215          * For instance, a
 216          */
 217         cells_type cells_;
 218
 219 private:
 220         /// Cursor start position in pixels from the document top
 221         int xo_;
 222         ///
 223         int yo_;
 224 };
 225
 226 std::ostream & operator<<(std::ostream &, MathInset const &);
 227
 228 #endif