Fix bug 886 and others not reported related with the document paper size.

[lyx.git] / src / cursor_slice.h

diff --git a/src/cursor_slice.h b/src/cursor_slice.h
index 06414cfc4f2d3f00b6bddd179542ff82cdd1f1f6..017def63a43b2e132208adcda3877122a3c80e92 100644 (file)
--- a/src/cursor_slice.h
+++ b/src/cursor_slice.h
@@ -28,13 +28,12 @@ class MathInset;
 class MathArray;
 class LyXText;
 class Paragraph;
-class UpdatableInset;
 
 
 /// This encapsulates a single slice of a document iterator as used e.g.
 /// for cursors.
 
-// After IU, the distinction of MathInset and UpdatableInset as well as
+// After IU, the distinction of MathInset and InsetOld as well as
 // that of MathArray and LyXText should vanish. They are conceptually the
 // same (now...)
 
@@ -70,7 +69,7 @@ public:
        pit_type & pit() { return pit_; }
        /// increments the paragraph this cursor is in
        void incrementPar();
-       /// increments the paragraph this cursor is in
+       /// decrements the paragraph this cursor is in
        void decrementPar();
        /// return the position within the paragraph
        pos_type pos() const { return pos_; }
@@ -80,31 +79,37 @@ public:
        pos_type lastpos() const;
        /// return the number of embedded cells
        size_t nargs() const;
-       /// return the number of embedded cells
+       /*!
+        * \return the number of columns.
+        * This does only make sense in grid like insets.
+        */
        size_t ncols() const;
-       /// return the number of embedded cells
+       /*!
+        * \return the number of rows.
+        * This does only make sense in grid like insets.
+        */
        size_t nrows() const;
-       /// return the grid row of the current cell
+       /*!
+        * \return the grid row of the current cell.
+        * This does only make sense in grid like insets.
+        */
        row_type row() const;
-       /// return the grid row of the current cell
+       /*!
+        * \return the grid column of the current cell.
+        * This does only make sense in grid like insets.
+        */
        col_type col() const;
 
        ///
        /// texted specific stuff
        ///
-       /// see comment for the member
-       bool boundary() const { return boundary_; }
-       /// see comment for the member
-       bool & boundary() { return boundary_; }
-       ///
+       /// returns text corresponding to this position
        LyXText * text();
-       ///
+       /// returns text corresponding to this position
        LyXText const * text() const;
-       ///
-       UpdatableInset * asUpdatableInset() const;
-       ///
+       /// paragraph in this cell
        Paragraph & paragraph();
-       ///
+       /// paragraph in this cell
        Paragraph const & paragraph() const;
 
        ///
@@ -112,39 +117,38 @@ public:
        ///
        /// returns cell corresponding to this position
        MathArray & cell() const;
-       ///
+       /// returns the owning inset if it is a MathInset, else 0
        MathInset * asMathInset() const;
 
-       ///
+       /// write some debug information to \p os
        friend std::ostream & operator<<(std::ostream &, CursorSlice const &);
 public:
        /// pointer to 'owning' inset. This is some kind of cache.
        InsetBase * inset_;
 private:
-       /// cell index of a position in this inset
+       /*!
+        * Cell index of a position in this inset.
+        * This is the primary cell information also for grid like insets,
+        * although we have the convenience functions row() and col() for
+        * those.
+        * This means that the corresponding idx_ of a cell in a given row
+        * and column changes every time the number of columns or number of
+        * rows changes. Normally the cursor should stay in the same cell,
+        * so these changes should typically be performed like the following:
+        * \code
+        * row_type const r = cur.row();
+        * col_type const c = cur.col();
+        * // change nrows() and/or ncols()
+        * cur.idx = index(r, c);
+        * \endcode
+        */
        idx_type idx_;
        /// paragraph in this cell (used by texted)
        pit_type pit_;
-       /// true of 'pit' was properly initialized
+       /// true if 'pit' was properly initialized
        bool pit_valid_;
        /// position in this cell
        pos_type pos_;
-       /**
-        * When the cursor position is i, is the cursor is after the i-th char
-        * or before the i+1-th char ? Normally, these two interpretations are
-        * equivalent, except when the fonts of the i-th and i+1-th char
-        * differ.
-        * We use boundary_ to distinguish between the two options:
-        * If boundary_=true, then the cursor is after the i-th char
-        * and if boundary_=false, then the cursor is before the i+1-th char.
-        *
-        * We currently use the boundary only when the language direction of
-        * the i-th char is different than the one of the i+1-th char.
-        * In this case it is important to distinguish between the two
-        * cursor interpretations, in order to give a reasonable behavior to
-        * the user.
-        */
-       bool boundary_;
 };
 
 /// test for equality