This is the first of a series of commits that will make InsetLayout a real class.

[lyx.git] / src / Cursor.h

diff --git a/src/Cursor.h b/src/Cursor.h
index a275260bf895953ddc7397e3eaec7eedadc63bfc..52220585b1db08c51c429018a713f4bcf0aa57d8 100644 (file)
--- a/src/Cursor.h
+++ b/src/Cursor.h
@@ -106,6 +106,12 @@ public:
        bool & macromode() { return macromode_; }
        /// returns x,y position
        void getPos(int & x, int & y) const;
+       /// return logical positions between which the cursor is situated
+       /**
+        * If the cursor is at the edge of a row, the position which is "over the 
+        * edge" will be returned as -1.
+        */
+       void getSurroundingPos(pos_type & left_pos, pos_type & right_pos);
        /// the row in the paragraph we're in
        Row const & textRow() const;
 
@@ -116,6 +122,22 @@ public:
        bool posBackward();
        /// move one step forward
        bool posForward();
+       /// move visually to next/previous row
+       /**
+        * Assuming we were to keep moving left (right) from the current cursor
+        * position, place the cursor at the rightmost (leftmost) edge of the 
+        * new row to which we would move according to visual-mode cursor movement.
+        * This could be either the next or the previous row, depending on the
+        * direction in which we're moving, and whether we're in an LTR or RTL 
+        * paragraph. 
+        * @note: The new position may even be in a new paragraph.
+        * @note: This method will not move out of the current slice.
+        * @return: false if not moved (no more rows to move to in given direction)
+        * @return: true if moved
+        */
+       bool posVisToNewRow(bool movingLeft);
+       /// move to right or left extremity of the current row
+       void posVisToRowExtremity(bool left);
 
        /// insert an inset
        void insert(Inset *);
@@ -188,6 +210,7 @@ public:
 
        /// output
        friend std::ostream & operator<<(std::ostream & os, Cursor const & cur);
+       friend LyXErr & operator<<(LyXErr & os, Cursor const & cur);
 
        ///
        bool textUndo();
@@ -216,6 +239,9 @@ public:
        /// Convenience: prepare undo for the selected paragraphs
        void recordUndoSelection();
 
+       ///
+       void checkBufferStructure();
+
 public:
        ///
        BufferView * bv_;
@@ -253,10 +279,6 @@ private:
        // of a big inset spanning a whole row and computing coordinates for
        // displaying the cursor.
        bool logicalpos_;
-       /// x position before dispatch started
-       int beforeDispX_;
-       /// y position before dispatch started
-       int beforeDispY_;
        /// position before dispatch started
        DocIterator beforeDispatchCursor_;
 
@@ -328,12 +350,14 @@ public:
        bool inMacroMode() const;
        /// get access to the macro we are currently typing
        InsetMathUnknown * activeMacro();
+       /// get access to the macro we are currently typing
+       InsetMathUnknown const * activeMacro() const;
 
        /// replace selected stuff with at, placing the former
        // selection in given cell of atom
        void handleNest(MathAtom const & at, int cell = 0);
        ///
-       bool isInside(Inset const *);
+       bool isInside(Inset const *) const;
 
        /// make sure cursor position is valid
        /// FIXME: It does a subset of fixIfBroken. Maybe merge them?
@@ -371,7 +395,7 @@ public:
 
 /**
  * Notifies all insets which appear in old, but not in cur. Make
- * Sure that the cursor old is valid, i.e. als inset pointer
+ * Sure that the cursor old is valid, i.e. all inset pointers
  * point to valid insets! Use Cursor::fixIfBroken if necessary.
  */
 bool notifyCursorLeaves(DocIterator const & old, Cursor & cur);