Whitespace cosmetics

[lyx.git] / src / DocIterator.h

diff --git a/src/DocIterator.h b/src/DocIterator.h
index 2aeff8fca13b69f6488691100a4f9b3b306f901e..4aff05cd0b62e43a5cd27bb4a241f7d5bdfcd568 100644 (file)
--- a/src/DocIterator.h
+++ b/src/DocIterator.h
@@ -15,7 +15,7 @@
 #include "CursorSlice.h"
 
 #include <vector>
-
+#include <algorithm>
 
 namespace lyx {
 
@@ -64,9 +64,7 @@ public:
        void resize(size_t i) { slices_.resize(i); }
 
        /// is the iterator valid?
-       operator const void*() const { return empty() ? 0 : this; }
-       /// is this iterator invalid?
-       bool operator!() const { return empty(); }
+       explicit operator bool() const { return !empty(); }
 
        /// does this iterator have any content?
        bool empty() const { return slices_.empty(); }
@@ -75,6 +73,9 @@ public:
        /// 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;
+
        //
        // access to slice at tip
        //
@@ -164,6 +165,10 @@ public:
        Paragraph & innerParagraph() const;
        /// return the inner text slice.
        CursorSlice const & innerTextSlice() const;
+       // convert a DocIterator into an argument to LFUN_PARAGRAPH_GOTO
+       docstring paragraphGotoArgument() const;
+       /// returns a DocIterator for the containing text inset
+       DocIterator getInnerText() const;
        /// the first and last positions of a word at top cursor slice
        /// \warning only works within text!
        FontSpan locateWord(word_location const loc) const;
@@ -179,6 +184,10 @@ public:
        //
        // elementary moving
        //
+       /// move one step backwards
+       bool posBackward();
+       /// move one step forward
+       bool posForward();
        /**
         * move on one logical position, descend into nested insets
         * including collapsed insets
@@ -202,7 +211,7 @@ public:
        /// move backward one paragraph
        void backwardPar();
        /// move backward one inset
-       /// FIXME: This is not implemented!
+       /// not used currently, uncomment if you need it
        //void backwardInset();
 
        /// are we some 'extension' (i.e. deeper nested) of the given iterator
@@ -231,6 +240,9 @@ public:
        /// fix DocIterator in circumstances that should never happen.
        /// \return true if the DocIterator was fixed.
        bool fixIfBroken();
+       /// Repopulate the slices insets from bottom to top. Useful
+       /// for stable iterators or Undo data.
+       void sanitize();
 
        /// find index of CursorSlice with &cell() == &cell (or -1 if not found)
        int find(MathData const & cell) const;
@@ -253,22 +265,22 @@ private:
        explicit DocIterator(Buffer * buf, Inset * inset);
        /**
         * Normally, when the cursor is at position i, it is painted *before*
-        * the character at position i. However, what if we want the cursor 
+        * the character at position i. However, what if we want the cursor
         * painted *after* position i? That's what boundary_ is for: if
         * boundary_==true, the cursor is painted *after* position i-1, instead
         * of before position i.
         *
         * Note 1: Usually, after i-1 or before i are actually the same place!
-        * However, this is not the case when i-1 and i are not painted 
+        * However, this is not the case when i-1 and i are not painted
         * contiguously, and in these cases we sometimes do want to have control
         * over whether to paint before i or after i-1.
         * Some concrete examples of where this happens:
         * a. i-1 at the end of one row, i at the beginning of next row
         * b. in bidi text, at transitions between RTL and LTR or vice versa
         *
-        * Note 2: Why i and i-1? Why, if boundary_==false means: *before* i, 
-        * couldn't boundary_==true mean: *after* i? 
-        * Well, the reason is this: cursor position is not used only for 
+        * Note 2: Why i and i-1? Why, if boundary_==false means: *before* i,
+        * couldn't boundary_==true mean: *after* i?
+        * Well, the reason is this: cursor position is not used only for
         * painting the cursor, but it also affects other things, for example:
         * where the next insertion will be placed (it is inserted at the current
         * position, pushing anything at the current position and beyond forward).
@@ -312,21 +324,21 @@ bool operator<(DocIterator const & p, DocIterator const & q)
 }
 
 
-inline 
+inline
 bool operator>(DocIterator const & p, DocIterator const & q)
 {
        return q < p;
 }
 
 
-inline 
+inline
 bool operator<=(DocIterator const & p, DocIterator const & q)
 {
        return !(q < p);
 }
 
 
-inline 
+inline
 bool operator>=(DocIterator const & p, DocIterator const & q)
 {
        return !(p < q);