]> git.lyx.org Git - lyx.git/blobdiff - src/DocIterator.h
When ignoring an update, request one for later
[lyx.git] / src / DocIterator.h
index 471f52d4be18079a6638682a540efff7fb99f7fe..cd9ce0f0b4c82fbc8e1f1ad426c4f55e59721747 100644 (file)
@@ -20,6 +20,7 @@
 namespace lyx {
 
 class DocIterator;
+class Encoding;
 class LyXErr;
 class MathAtom;
 class Paragraph;
@@ -64,9 +65,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(); }
@@ -167,6 +166,8 @@ 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
@@ -184,6 +185,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
@@ -253,6 +258,9 @@ public:
        /// push one CursorSlice on top and set its index and position
        void append(idx_type idx, pos_type pos);
 
+       ///
+       Encoding const * getEncoding() const;
+
 private:
        friend class InsetIterator;
        friend DocIterator doc_iterator_begin(Buffer const * buf, Inset const * inset);
@@ -261,22 +269,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).
@@ -320,21 +328,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);