*
* Copyright: 1996, 1997 Alejandro Aguilar Sierra
*
- * Version: 0.8beta, Mathed & Lyx project.
+ * Version: 0.8beta, Math & Lyx project.
*
* You are free to use and modify this code under the terms of
* the GNU General Public Licence version 2 or later.
*/
-// Note: These math insets are internal to Mathed and are not derived
+// Note: These math insets are internal to Math and are not derived
// from lyx inset.
-#ifndef MATH_INSET
-#define MATH_INSET
+#ifndef MATH_INSET_H
+#define MATH_INSET_H
+
+#include <config.h>
#ifdef __GNUG__
#pragma interface
#endif
#include "LString.h"
-#include "math_defs.h"
#include "symbol_def.h"
+#include "xarray.h"
/** Abstract base class for all math objects.
A math insets is for use of the math editor only, it isn't a
general LyX inset. It's used to represent all the math objects.
The formulaInset (a LyX inset) encapsulates a math inset.
- */
-class MathedInset {
- public:
- /// A math inset has a name (usually its LaTeX name), type and font-size
- MathedInset(string const & nm, short ot, short st);
- ///
- explicit
- MathedInset(MathedInset *);
- ///
- virtual ~MathedInset() {}
- /// Draw the object
- virtual void draw(Painter &, int x, int baseline) = 0;
- /// Write LaTeX and Lyx code
- virtual void Write(std::ostream &, bool fragile) = 0;
- /// Reproduces itself
- virtual MathedInset * Clone() = 0;
- /// Compute the size of the object
- virtual void Metrics() = 0;
- ///
- virtual int Ascent() const { return ascent; }
- ///
- virtual int Descent() const { return descent; }
- ///
- virtual int Width() const { return width; }
- ///
- virtual int Height() const { return ascent + descent; }
- ///
- virtual bool GetLimits() const { return false; }
- ///
- virtual void SetLimits(bool) {}
- ///
- string const & GetName() const { return name; }
- ///
- short GetType() const { return objtype; }
- ///
- short GetStyle() const { return size; }
- //Man: Avoid to use these functions if it's not strictly necessary
- ///
- virtual void SetType(short t) { objtype = t; }
- ///
- virtual void SetStyle(short st) { size = st; } // Metrics();
- ///
- virtual void SetName(string const & n) { name = n; }
- ///
- static int workWidth;
- protected:
- ///
- string name;
- ///
- short objtype;
- ///
- int width;
- ///
- int ascent;
- ///
- int descent;
- ///
- short size;
- /// Default metrics
- static int df_asc;
- ///
- static int df_des;
- ///
- static int df_width;
- /// In a near future maybe we use a better fonts renderer than X
- void drawStr(Painter &, short, int, int, int, string const &);
- ///
- friend class MathedCursor;
- ///
- friend void mathed_init_fonts();
+*/
+
+
+class LaTeXFeatures;
+
+class MathInset {
+public:
+ /** A math inset has a name (usually its LaTeX name),
+ type and font-size
+ */
+ ///
+ explicit MathInset
+ (int na = 0, string const & nm = string(), MathInsetTypes ot = LM_OT_SIMPLE);
+
+ /// The virtual base destructor
+ virtual ~MathInset() {}
+
+ /// Draw the object
+ virtual void draw(Painter &, int x, int baseline) = 0;
+ /// Write LaTeX and Lyx code
+ virtual void Write(std::ostream &, bool fragile) const = 0;
+ /// Write normalized content
+ virtual void WriteNormal(std::ostream &) const;
+ /// Reproduces itself
+ virtual MathInset * clone() const = 0;
+ /// Appends itself with macro arguments substituted
+ virtual void substitute(MathArray & array, MathMacro const & macro) const;
+ /// Compute the size of the object
+ virtual void Metrics(MathStyles st, int = 0, int = 0) = 0;
+ ///
+ virtual int ascent() const;
+ ///
+ virtual int descent() const;
+ ///
+ virtual int width() const;
+ ///
+ virtual int height() const;
+ ///
+ virtual int limits() const;
+ ///
+ virtual void limits(int);
+ ///
+ string const & name() const;
+ ///
+ MathInsetTypes GetType() const;
+ //Man: Avoid to use these functions if it's not strictly necessary
+ ///
+ virtual void SetType(MathInsetTypes t);
+ ///
+ virtual void SetName(string const & n);
+ ///
+ MathStyles size() const;
+
+ /// Where should we go when we press the up cursor key?
+ virtual bool idxUp(int & idx, int & pos) const;
+ /// The down key
+ virtual bool idxDown(int & idx, int & pos) const;
+ /// The left key
+ virtual bool idxLeft(int & idx, int & pos) const;
+ /// The right key
+ virtual bool idxRight(int & idx, int & pos) const;
+
+ /// Move one physical cell up
+ virtual bool idxNext(int & idx, int & pos) const;
+ /// Move one physical cell down
+ virtual bool idxPrev(int & idx, int & pos) const;
+
+ /// Target pos when we enter the inset from the left by pressing "Right"
+ virtual bool idxFirst(int & idx, int & pos) const;
+ /// Target pos when we enter the inset from the left by pressing "Up"
+ virtual bool idxFirstUp(int & idx, int & pos) const;
+ /// Target pos when we enter the inset from the left by pressing "Down"
+ virtual bool idxFirstDown(int & idx, int & pos) const;
+
+ /// Target pos when we enter the inset from the right by pressing "Left"
+ virtual bool idxLast(int & idx, int & pos) const;
+ /// Target pos when we enter the inset from the right by pressing "Up"
+ virtual bool idxLastUp(int & idx, int & pos) const;
+ /// Target pos when we enter the inset from the right by pressing "Down"
+ virtual bool idxLastDown(int & idx, int & pos) const;
+
+ /// Where should we go if we press home?
+ virtual bool idxHome(int & idx, int & pos) const;
+ /// Where should we go if we press end?
+ virtual bool idxEnd(int & idx, int & pos) const;
+
+ /// Delete a cell and move cursor
+ // the return value indicates whether the cursor should leave the inset
+ // and/or the whole inset should be deleted
+ virtual void idxDelete(int & idx, bool & popit, bool & deleteit);
+ // deletes a cell range and moves the cursor
+ virtual void idxDeleteRange(int from, int to);
+ // returns list of cell indices that are "between" from and to for
+ // selction purposes
+ virtual std::vector<int> idxBetween(int from, int to) const;
+
+ ///
+ int nargs() const;
+
+ ///
+ MathArray & cell(int);
+ ///
+ MathArray const & cell(int) const;
+ ///
+ MathXArray & xcell(int);
+ ///
+ MathXArray const & xcell(int) const;
+
+ ///
+ int xo() const;
+ ///
+ int yo() const;
+ ///
+ void xo(int tx);
+ ///
+ void yo(int ty);
+ ///
+
+ ///
+ virtual int ncols() const { return 1; }
+ ///
+ virtual int nrows() const { return 1; }
+ ///
+ virtual int col(int) const { return 0; }
+ ///
+ virtual int row(int) const { return 0; }
+ ///
+ virtual void addRow(int) {}
+ ///
+ virtual void delRow(int) {}
+ ///
+ virtual void addCol(int) {}
+ ///
+ virtual void delCol(int) {}
+
+ ///
+ virtual void UserSetSize(MathStyles &) {}
+
+ ///
+ void GetXY(int & x, int & y) const;
+ ///
+ bool covers(int x, int y) const;
+ /// Identifies ScriptInsets
+ virtual bool isUpDownInset() const { return false; }
+ /// Identifies BigopInsets
+ virtual bool isBigopInset() const { return false; }
+ ///
+ virtual bool isActive() const { return nargs() > 0; }
+
+
+ ///
+ void push_back(MathInset *);
+ ///
+ void push_back(unsigned char ch, MathTextCodes fcode);
+ ///
+ void dump() const;
+
+ ///
+ void Validate(LaTeXFeatures & features) const;
+
+ ///
+ static int workwidth;
+protected:
+ ///
+ string name_;
+ ///
+ MathInsetTypes objtype;
+ ///
+ int width_;
+ ///
+ int ascent_;
+ ///
+ int descent_;
+ ///
+ void size(MathStyles s);
+ ///
+ MathStyles size_;
+
+protected:
+ ///
+ typedef std::vector<MathXArray> cells_type;
+ /**
+ * The contents of the inset are contained here.
+ * Each inset is build from a number of insets.
+ * For instance, a
+ */
+ cells_type cells_;
+
+private:
+ /// Cursor start position in pixels from the document top
+ int xo_;
+ ///
+ int yo_;
};
+
+std::ostream & operator<<(std::ostream &, MathInset const &);
+
#endif
projects / lyx.git / blobdiff