Correct comment

[lyx.git] / src / DocIterator.h

diff --git a/src/DocIterator.h b/src/DocIterator.h
index 9582ea30f95b6e4fdd6fe9913c7c7e5c4d771ea7..69930fcc7d09b3e50f3dc7e08bd5c30c87960bac 100644 (file)
--- a/src/DocIterator.h
+++ b/src/DocIterator.h
@@ -69,10 +69,10 @@ public:
 
        /// does this iterator have any content?
        bool empty() const { return slices_.empty(); }
+       /// is this the begin position?
+       bool atBegin() const { return depth() == 1 && pit() == 0 && pos() == 0; }
        /// is this the end position?
        bool atEnd() const { return slices_.empty(); }
-       /// is this the last possible position?
-       bool atLastPos() const { return pit() == lastpit() && pos() == lastpos(); }
 
        /// checks the cursor slices for disabled spell checker insets
        bool allowSpellCheck() const;
@@ -126,6 +126,7 @@ public:
        /// return the last column of the top grid
        col_type lastcol() const { return ncols() - 1; }
        /// the inset just behind the cursor
+       /// returns 0 if there is no inset (e.g. normal text)
        Inset * nextInset() const;
        /// the inset just in front of the cursor
        Inset * prevInset() const;
@@ -207,10 +208,12 @@ public:
        void forwardChar();
        /// move on one paragraph
        void forwardPar();
-       /// move on one inset
+       /// move on to the next closest inset
        void forwardInset();
        /// move backward one logical position
        void backwardPos();
+       /// move backward one logical position, skip collapsed insets
+       void backwardPosIgnoreCollapsed();
        /// move backward one physical character or inset
        void backwardChar();
        /// move backward one paragraph
@@ -248,6 +251,10 @@ public:
        /// Repopulate the slices insets from bottom to top. Useful
        /// for stable iterators or Undo data.
        void sanitize();
+       ///
+       bool isInside(Inset const *) const;
+       /// make sure we are outside of given inset
+       void leaveInset(Inset const & inset);
 
        /// find index of CursorSlice with &cell() == &cell (or -1 if not found)
        int find(MathData const & cell) const;