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.
* 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;
Paragraph * 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_;
int iy_;
/// the containing row
Row * row_;
- /// the containing row for the next line
+ /// the containing row for the next line
Row * irow_;
};