* Doxy: polish html output.

[lyx.git] / src / CursorSlice.h

diff --git a/src/CursorSlice.h b/src/CursorSlice.h
index 0b198e8fa5e6d6ee649a26281f7e1b952d9e6724..be31f56a99cff5bf0709c28bd525ff8b82fa9f9c 100644 (file)
--- a/src/CursorSlice.h
+++ b/src/CursorSlice.h
@@ -18,11 +18,9 @@
 #define CURSORSLICE_H
 
 #include "support/types.h"
+#include "support/strfwd.h"
 #include "insets/Inset.h"
 
-#include <cstddef>
-#include <iosfwd>
-
 
 namespace lyx {
 
@@ -40,6 +38,12 @@ class Paragraph;
 
 class CursorSlice {
 public:
+       /// Those needs inset_ access.
+       ///@{
+       friend class DocIterator;
+       friend class StableDocIterator;
+       ///@}
+
        /// type for cell number in inset
        typedef size_t idx_type;
        /// type for row indices
@@ -64,6 +68,8 @@ public:
        pit_type pit() const { return pit_; }
        /// set the offset of the paragraph this cursor is in
        pit_type & pit() { return pit_; }
+       /// return the last paragraph offset within the ParagraphList
+       pit_type lastpit() const;
        /// increments the paragraph this cursor is in
        void incrementPar();
        /// decrements the paragraph this cursor is in
@@ -95,13 +101,9 @@ public:
        /// texted specific stuff
        ///
        /// returns text corresponding to this position
-       Text * text() { return inset_->getText(idx_); }
-       /// returns text corresponding to this position
-       Text const * text() const { return inset_->getText(idx_); }
+       Text * text() const { return inset_->getText(idx_); }
        /// paragraph in this cell
-       Paragraph & paragraph();
-       /// paragraph in this cell
-       Paragraph const & paragraph() const;
+       Paragraph & paragraph() const;
 
        ///
        /// mathed specific stuff
@@ -113,10 +115,24 @@ public:
 
        /// write some debug information to \p os
        friend std::ostream & operator<<(std::ostream &, CursorSlice const &);
-public:
+       /// move to next position
+       void forwardPos();
+       /// move to previous position
+       void backwardPos();
+       /// move to next cell
+       void forwardIdx();
+       /// move to previous cell
+       void backwardIdx();
+       /// are we at the end of this slice
+       bool at_end() const;
+       /// are we at the start of this slice
+       bool at_begin() const;
+       
+private:
+
        /// pointer to 'owning' inset. This is some kind of cache.
        Inset * inset_;
-private:
+
        /*!
         * Cell index of a position in this inset.
         * This is the primary cell information also for grid like insets,
@@ -134,8 +150,6 @@ private:
        idx_type idx_;
        /// paragraph in this cell (used by texted)
        pit_type pit_;
-       /// true if 'pit' was properly initialized
-       bool pit_valid_;
        /// position in this cell
        pos_type pos_;
 };