]> git.lyx.org Git - lyx.git/blobdiff - src/mathed/math_cursor.h
make \newcommand{\bb}[1]{\mathbf{#1}} work for read/write/display.
[lyx.git] / src / mathed / math_cursor.h
index bea6dcfce563a16f8564569eee1d3e991ec11979..6e2742fd6505e64415185e9b946663798f44836f 100644 (file)
 
 #include "math_defs.h"
 #include "math_inset.h"
+#include "math_pos.h"
 #include "LString.h"
 
 class InsetFormulaBase;
 class Painter;
 class Selection;
 
-/// Description of a position 
-struct MathCursorPos {
-       /// inset
-       MathAtom * par_;
-       /// cell index
-       MathInset::idx_type idx_;
-       /// cell position
-       MathInset::pos_type pos_;
+/**
 
-       /// returns cell corresponding to this position
-       MathArray & cell() const;
-       /// returns cell corresponding to this position
-       MathArray & cell(MathInset::idx_type idx) const;
-       /// returns xcell corresponding to this position
-       MathXArray & xcell() const;
-       /// returns xcell corresponding to this position
-       MathXArray & xcell(MathInset::idx_type idx) const;
-};
+[Have a look at math_inset.h first]
+
+The MathCursor is different from the kind of cursor used in the Outer
+World. It contains a stack of MathCursorPositions, each of which is made
+up of a inset pointer, an index and a position offset, marking a path from
+this formula's mathHullInset to the current position.
 
-/// 
-bool operator==(MathCursorPos const &, MathCursorPos const &);
-/// 
-bool operator<(MathCursorPos const &, MathCursorPos const &);
+*/
 
 
-/// This is the external interface of Math's subkernel
 class MathCursor {
 public:
        /// short of anything else reasonable
@@ -82,25 +69,25 @@ public:
        void erase();
        ///
        void backspace();
-       ///
+       /// called for LFUN_HOME etc
        void home(bool sel = false);
-       ///
+       /// called for LFUN_END etc
        void end(bool sel = false);
-       ///
+       /// called for LFUN_RIGHT and LFUN_RIGHTSEL
        bool right(bool sel = false);
-       ///
+       /// called for LFUN_LEFT etc
        bool left(bool sel = false);
-       ///
+       /// called for LFUN_UP etc
        bool up(bool sel = false);
-       ///
+       /// called for LFUN_DOWN etc
        bool down(bool sel = false);
        /// Put the cursor in the first position
        void first();
        /// Put the cursor in the last position
        void last();
-       ///
+       /// move to next cell in current inset
        void idxNext();
-       ///
+       /// move to previous cell in current inset
        void idxPrev();
        ///
        void plainErase();
@@ -111,31 +98,31 @@ public:
 
        ///
        void delLine();
-       /// This is in pixels from (maybe?) the top of inset
+       /// in pixels from top of screen
        void setPos(int x, int y);
-       /// This is in pixels from (maybe?) the top of inset, don't move further
-       ///
+       /// in pixels from top of screen
        void getPos(int & x, int & y);
-       ///
-       MathAtom & par() const;
+       /// current inset
+       MathInset * par() const;
        /// return the next enclosing grid inset and the cursor's index in it
        MathGridInset * enclosingGrid(idx_type &) const;
        ///
-       InsetFormulaBase const * formula();
-       ///
+       InsetFormulaBase * formula();
+       /// current offset in the current cell
        pos_type pos() const;
-       ///
+       /// current cell
        idx_type idx() const;
-       ///
+       /// size of current cell
        size_type size() const;
        ///
+       bool script(bool);
+       ///
        bool interpret(string const &);
        ///
        bool interpret(char);
        ///
        bool toggleLimits();
-       ///
-       // Macro mode methods
+       /// interpret name a name of a macro
        void macroModeClose();
        ///
        bool inMacroMode() const;
@@ -167,14 +154,14 @@ public:
        void handleDelim(string const & l, string const & r);
        ///
        void handleNest(MathInset * p);
-       /// Splits cells and shifts right part to the next cell
+       /// splits cells and shifts right part to the next cell
        void splitCell();
-       /// Splits line and insert new row of cell 
+       /// splits line and insert new row of cell 
        void breakLine();
        /// read contents of line into an array
        void readLine(MathArray & ar) const;
-       ///
-       MathTextCodes getLastCode() const;
+       /// remove this as soon as LyXFunc::getStatus is "localized"
+       MathTextCodes getLastCode() const { return lastcode_; }
        ///
        void pullArg(bool goright);
        ///
@@ -186,14 +173,16 @@ public:
        ///
        char halign() const;
        ///
-       col_type ncols() const;
+       col_type hullCol() const;
+       ///
+       row_type hullRow() const;
        ///
-       col_type col() const;
+       col_type gridCol() const;
        ///
-       row_type row() const;
+       row_type gridRow() const;
 
-       /// Make sure cursor position is valid
-       void normalize() const;
+       /// make sure cursor position is valid
+       void normalize();
        ///
        UpdatableInset * asHyperActiveInset() const;
 
@@ -233,19 +222,21 @@ public:
        /// path of positions the cursor had to go if it were leving each inset
        cursor_type Cursor_;
        /// path of positions the anchor had to go if it were leving each inset
-       cursor_type Anchor_;
+       mutable cursor_type Anchor_;
 
-       /// reference to the last item of the path
+       /// reference to the last item of the path, i.e. "The Cursor"
        MathCursorPos & cursor();
-       ///
+       /// reference to the last item of the path, i.e. "The Cursor"
        MathCursorPos const & cursor() const;
 
-       ///
+       /// dump selection information for debugging
        void seldump(char const * str) const;
-       ///
+       /// dump selection information for debugging
        void dump(char const * str) const;
        ///
        void stripFromLastEqualSign();
+       /// moves on 
+       void setSelection(cursor_type const & where, size_type n);
 
        ///
        friend class Selection;
@@ -259,30 +250,26 @@ private:
        bool idxLeft();
        /// moves cursor index one cell to the right
        bool idxRight();
-       /// moves position somehow up
-       bool goUp();
-       /// moves position somehow down
-       bool goDown();
-       /// moves position somehow down
-       bool bruteUpDown(int ylow, int yhigh);
+       /// moves position somehow up or down
+       bool goUpDown(bool up);
+       /// moves position into box
+       bool bruteFind(int xo, int yo, int xlow, int xhigh, int ylow, int yhigh);
 
        ///
        string macroName() const;
        ///
-       int macroNamePos() const;
+       MathInset::difference_type macroNamePos() const;
        ///
        void insert(char, MathTextCodes t);
        /// can we enter the inset? 
        bool openable(MathAtom const &, bool selection) const;
-       /// can the setPos routine enter that inset?
-       bool positionable(MathAtom const &, int x, int y) const;
        /// write access to cursor cell position
        pos_type & pos();
        /// write access to cursor cell index
        idx_type & idx();
 
        ///
-       InsetFormulaBase * const formula_;
+       InsetFormulaBase * formula_;
        ///
        MathTextCodes lastcode_;
        // Selection stuff