"Inter-word Space"

[lyx.git] / src / lyxcursor.h

diff --git a/src/lyxcursor.h b/src/lyxcursor.h
index 7e21d4e2c4571529c10ab140a50a142e6a930d40..f19915e0657ff7e37cb6611978c536942321910e 100644 (file)
--- a/src/lyxcursor.h
+++ b/src/lyxcursor.h
@@ -10,16 +10,11 @@
 #ifndef LYXCURSOR_H
 #define LYXCURSOR_H
 
-#ifdef __GNUG__
-#pragma interface
-#endif
-
+#include "RowList.h"
+#include "ParagraphList.h"
 #include "support/types.h"
 
-class Paragraph;
-class Row;
-
-/** 
+/**
  * The cursor class describes the position of a cursor within a document.
  * Several cursors exist within LyX; for example, when locking an inset,
  * the position of the cursor in the containing inset is stored.
@@ -30,9 +25,9 @@ class LyXCursor {
 public:
        LyXCursor();
        /// set the paragraph that contains this cursor
-       void par(Paragraph * p);
+       void par(ParagraphList::iterator pit);
        /// return the paragraph this cursor is in
-       Paragraph * par() const;
+       ParagraphList::iterator par() const;
        /// set the position within the paragraph
        void pos(lyx::pos_type p);
        /// return the position within the paragraph
@@ -66,7 +61,7 @@ public:
         * blah blah blah blah blah blah
         *
         * When we move onto row 3, we would like to be vertically aligned
-        * with where we were in row 1, despite the fact that row 2 is 
+        * with where we were in row 1, despite the fact that row 2 is
         * shorter than x()
         */
        int x_fix() const;
@@ -85,11 +80,11 @@ public:
         */
        int iy() const;
        /// set the row of the paragraph the cursor is in
-       void row(Row * r);
+       void row(RowList::iterator r);
        /// return the row of the paragraph this cursor is in
-       Row * row() const;
+       RowList::iterator row() const;
        /// set the stored next row
-       void irow(Row * r);
+       void irow(RowList::iterator r);
        /**
         * Return the next row, when this
         * cursor is at the end of the previous row, for insets that take
@@ -97,17 +92,31 @@ public:
         *
         * FIXME: explain why we need this ? especially for y...
         */
-       Row * irow() const;
+       RowList::iterator irow() const;
 private:
        /// The paragraph the cursor is in.
-       Paragraph * par_;
+       ParagraphList::iterator par_;
        /// The position inside the paragraph
        lyx::pos_type pos_;
-       /// FIXME
+       /**
+        * 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_;
        /// the pixel x position
        int x_;
-       /// the stored next-row x position 
+       /// the stored next-row x position
        int ix_;
        /// the cached x position
        int x_fix_;
@@ -116,9 +125,9 @@ private:
        /// the stored next-row y position
        int iy_;
        /// the containing row
-       Row * row_;
-       /// the containing row for the next line 
-       Row * irow_;
+       RowList::iterator row_;
+       /// the containing row for the next line
+       RowList::iterator irow_;
 };
 
 /// these three dictate the others