]> git.lyx.org Git - lyx.git/blobdiff - src/Cursor.h
* cs.po
[lyx.git] / src / Cursor.h
index a275260bf895953ddc7397e3eaec7eedadc63bfc..19eeca964b32db2670bdab9110d066eddafe85e7 100644 (file)
@@ -71,6 +71,12 @@ public:
        bool selection() const { return selection_; }
        /// selection active?
        bool & selection() { return selection_; }
+       /// do we have a multicell selection?
+       bool selIsMultiCell() const 
+               { return selection_ && selBegin().idx() != selEnd().idx(); }
+       /// do we have a multiline selection?
+       bool selIsMultiLine() const 
+               { return selection_ && selBegin().pit() != selEnd().pit(); }
        /// did we place the anchor?
        bool mark() const { return mark_; }
        /// did we place the anchor?
@@ -94,7 +100,7 @@ public:
        ///
        docstring selectionAsString(bool label) const;
        ///
-       docstring currentState();
+       docstring currentState() const;
 
        /// auto-correct mode
        bool autocorrect() const { return autocorrect_; }
@@ -106,6 +112,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 +128,38 @@ public:
        bool posBackward();
        /// move one step forward
        bool posForward();
+       /// move visually one step to the right
+       /**
+        * @note: This method may move into an inset unless skip_inset == true.
+        * @note: This method may move into a new paragraph.
+        * @note: This method may move out of the current slice.
+        * @return: true if moved, false if not moved
+        */
+       bool posVisRight(bool skip_inset = false);
+       /// move visually one step to the left
+       /**
+        * @note: This method may move into an inset unless skip_inset == true.
+        * @note: This method may move into a new paragraph.
+        * @note: This method may move out of the current slice.
+        * @return: true if moved, false if not moved
+        */
+       bool posVisLeft(bool skip_inset = false);
+       /// 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 +232,7 @@ public:
 
        /// output
        friend std::ostream & operator<<(std::ostream & os, Cursor const & cur);
+       friend LyXErr & operator<<(LyXErr & os, Cursor const & cur);
 
        ///
        bool textUndo();
@@ -195,26 +240,35 @@ public:
        bool textRedo();
 
        /// makes sure the next operation will be stored
-       void finishUndo();
+       void finishUndo() const;
+
+       /// open a new group of undo operations. Groups can be nested.
+       void beginUndoGroup() const;
+
+       /// end the current undo group
+       void endUndoGroup() const;
 
        /// The general case: prepare undo for an arbitrary range.
-       void recordUndo(UndoKind kind, pit_type from, pit_type to);
+       void recordUndo(UndoKind kind, pit_type from, pit_type to) const;
 
        /// Convenience: prepare undo for the range between 'from' and cursor.
-       void recordUndo(UndoKind kind, pit_type from);
+       void recordUndo(UndoKind kind, pit_type from) const;
 
        /// Convenience: prepare undo for the single paragraph or cell
        /// containing the cursor
-       void recordUndo(UndoKind kind = ATOMIC_UNDO);
+       void recordUndo(UndoKind kind = ATOMIC_UNDO) const;
 
        /// Convenience: prepare undo for the inset containing the cursor
-       void recordUndoInset(UndoKind kind = ATOMIC_UNDO);
+       void recordUndoInset(UndoKind kind = ATOMIC_UNDO) const;
 
        /// Convenience: prepare undo for the whole buffer
-       void recordUndoFullDocument();
+       void recordUndoFullDocument() const;
 
-       /// Convenience: prepare undo for the selected paragraphs
-       void recordUndoSelection();
+       /// Convenience: prepare undo for the selected paragraphs or cells
+       void recordUndoSelection() const;
+
+       ///
+       void checkBufferStructure();
 
 public:
        ///
@@ -253,10 +307,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 +378,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?
@@ -354,7 +406,7 @@ public:
        /// display an error message
        void errorMessage(docstring const & msg) const;
        ///
-       docstring getPossibleLabel();
+       docstring getPossibleLabel() const;
 
        /// the name of the macro we are currently inputting
        docstring macroName();
@@ -371,10 +423,10 @@ 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);
+bool notifyCursorLeaves(Cursor const & old, Cursor & cur);
 
 
 } // namespace lyx