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 #include <config.h>
  26
  27 #ifdef __GNUG__
  28 #pragma interface
  29 #endif
  30
  31 #include "LString.h"
  32 #include "symbol_def.h"
  33 #include "xarray.h"
  34
  35 /** Abstract base class for all math objects.
  36     A math insets is for use of the math editor only, it isn't a
  37     general LyX inset. It's used to represent all the math objects.
  38     The formulaInset (a LyX inset) encapsulates a math inset.
  39 */
  40
  41
  42 class LaTeXFeatures;
  43
  44 class MathInset {
  45 public:
  46         ///
  47         explicit MathInset(string const & nm = string());
  48
  49         /// the virtual base destructor
  50         virtual ~MathInset() {}
  51
  52         /// draw the object, sets xo_ and yo_ cached values
  53         virtual void draw(Painter &, int x, int y) const;
  54         /// write LaTeX and Lyx code
  55         virtual void write(std::ostream &, bool fragile) const;
  56         /// write normalized content
  57         virtual void writeNormal(std::ostream &) const;
  58         /// reproduce 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, sets ascend_, descend_ and width_
  63         virtual void metrics(MathStyles st) const;
  64         ///
  65         virtual int ascent() const { return 1; }
  66         ///
  67         virtual int descent() const { return 1; }
  68         ///
  69         virtual int width() const { return 2; }
  70         ///
  71         virtual int height() const;
  72         ///
  73         virtual string const & name() const;
  74         ///
  75         virtual void setName(string const & n);
  76         ///
  77         virtual MathStyles size() const;
  78
  79         /// Where should we go when we press the up cursor key?
  80         virtual bool idxUp(int & idx, int & pos) const;
  81         /// The down key
  82         virtual bool idxDown(int & idx, int & pos) const;
  83         /// The left key
  84         virtual bool idxLeft(int & idx, int & pos) const;
  85         /// The right key
  86         virtual bool idxRight(int & idx, int & pos) const;
  87
  88         /// Move one physical cell up
  89         virtual bool idxNext(int & idx, int & pos) const;
  90         /// Move one physical cell down
  91         virtual bool idxPrev(int & idx, int & pos) const;
  92
  93         /// Target pos when we enter the inset from the left by pressing "Right"
  94         virtual bool idxFirst(int & idx, int & pos) const;
  95         /// Target pos when we enter the inset from the left by pressing "Up"
  96         virtual bool idxFirstUp(int & idx, int & pos) const;
  97         /// Target pos when we enter the inset from the left by pressing "Down"
  98         virtual bool idxFirstDown(int & idx, int & pos) const;
  99
 100         /// Target pos when we enter the inset from the right by pressing "Left"
 101         virtual bool idxLast(int & idx, int & pos) const;
 102         /// Target pos when we enter the inset from the right by pressing "Up"
 103         virtual bool idxLastUp(int & idx, int & pos) const;
 104         /// Target pos when we enter the inset from the right by pressing "Down"
 105         virtual bool idxLastDown(int & idx, int & pos) const;
 106
 107         /// Where should we go if we press home?
 108         virtual bool idxHome(int & idx, int & pos) const;
 109         /// Where should we go if we press end?
 110         virtual bool idxEnd(int & idx, int & pos) const;
 111
 112         /// Delete a cell and move cursor
 113         // the return value indicates whether the cursor should leave the inset
 114         // and/or the whole inset should be deleted
 115         virtual void idxDelete(int & idx, bool & popit, bool & deleteit);
 116         // deletes a cell range and moves the cursor
 117         virtual void idxDeleteRange(int from, int to);
 118         // returns list of cell indices that are "between" from and to for
 119         // selection purposes
 120         virtual std::vector<int> idxBetween(int from, int to) const;
 121
 122         ///
 123         virtual int nargs() const;
 124
 125         ///
 126         virtual MathArray & cell(int);
 127         ///
 128         virtual MathArray const & cell(int) const;
 129         ///
 130         virtual MathXArray & xcell(int);
 131         ///
 132         virtual MathXArray const & xcell(int) const;
 133
 134         ///
 135         virtual int xo() const;
 136         ///
 137         virtual int yo() const;
 138         ///
 139         virtual void xo(int tx) const;
 140         ///
 141         virtual void yo(int ty) const;
 142         ///
 143
 144         ///
 145         virtual int ncols() const { return 1; }
 146         ///
 147         virtual int nrows() const { return 1; }
 148         ///
 149         virtual int col(int) const { return 0; }
 150         ///
 151         virtual int row(int) const { return 0; }
 152         ///
 153         virtual void addRow(int) {}
 154         ///
 155         virtual void delRow(int) {}
 156         ///
 157         virtual void addCol(int) {}
 158         ///
 159         virtual void delCol(int) {}
 160
 161         ///
 162         virtual void userSetSize(MathStyles &) {}
 163
 164         ///
 165         virtual void getXY(int & x, int & y) const;
 166         ///
 167         virtual bool covers(int x, int y) const;
 168         /// identifies things that can get scripts
 169         virtual bool isScriptable() const { return false; }
 170         /// identifies ScriptInsets
 171         virtual bool isScriptInset() const { return false; }
 172         /// identifies SpaceInsets
 173         virtual bool isSpaceInset() const { return false; }
 174         /// identifies GridInsets
 175         virtual bool isGrid() const { return false; }
 176         /// identifies ArrayInsets
 177         virtual bool isArray() const { return false; }
 178         /// identifies Charinsets
 179         virtual bool isCharInset() const { return false; }
 180         ///
 181         virtual bool isActive() const { return nargs() > 0; }
 182         ///
 183         virtual char getChar() const { return 0; }
 184
 185         ///
 186         virtual void push_back(MathInset *);
 187         ///
 188         virtual void push_back(unsigned char ch, MathTextCodes fcode);
 189         ///
 190         virtual void dump() const;
 191
 192         ///
 193         virtual void validate(LaTeXFeatures & features) const;
 194
 195         ///
 196         static int workwidth;
 197
 198         /// the inherited text style
 199         virtual MathTextCodes code() const;
 200         ///
 201         virtual void code(MathTextCodes t);
 202
 203 protected:
 204         /// usually the LaTeX name of the thingy
 205         string name_;
 206         /// _sets_ style
 207         void size(MathStyles s) const;
 208         /// the used font size
 209         mutable MathStyles size_;
 210         /// the inherited text style
 211         mutable MathTextCodes code_;
 212
 213 private:
 214         /// the following are used for positioning the cursor with the mouse
 215         /// cached cursor start position in pixels from the document left
 216         mutable int xo_;
 217         /// cached cursor start position in pixels from the document top
 218         mutable int yo_;
 219 };
 220
 221 std::ostream & operator<<(std::ostream &, MathInset const &);
 222
 223 #endif