Remove hardcoded values

[lyx.git] / src / Cursor.h

diff --git a/src/Cursor.h b/src/Cursor.h
index de2405692a9f70065dcadcaf04ef3ed50e1dd2b1..462c31caa24a31b6c9c1303f6bdc6685818856c6 100644 (file)
--- a/src/Cursor.h
+++ b/src/Cursor.h
@@ -10,17 +10,19 @@
  */
 
 /*
-First some explanation about what a Cursor really is. I try to go from
-more local to general.
+First some explanation about what a Cursor really is, from local to
+global.
 
 * a CursorSlice indicates the position of the cursor at local level.
-It contains in particular:
+  It contains in particular:
   * idx(): the cell that contains the cursor (for Tabular or math
            arrays). Always 0 for 'plain' insets
-  * pit(): the index of the current paragraph (only for Texted)
+  * pit(): the index of the current paragraph (only for text)
   * pos(): the position in the current paragraph (or in the math
-           equation in Mathed).
-  * inset(): the inset in which the cursor is.
+           equation in mathed).
+  * inset(): the inset in which the cursor is. For a InsetTabular,
+    this is the tabular itself, not the cell inset (which is an
+    InsetTableCell).
 
 * a DocIterator indicated the position of the cursor in the document.
   It knows about the current buffer (buffer() method) and contains a
@@ -35,19 +37,18 @@ It contains in particular:
   * innerTextSlice() returns the deepest slice that is text (useful
     when one is in a math equation and looks for the enclosing text)
 
-* A CursorData is a descendent of Dociterator that contains
+* A CursorData is a descendant of Dociterator that contains
   * a second DocIterator object, the anchor, that is useful when
     selecting.
-  * some other data not interesting here
-This class is used only for undo and contains the Cursor element that
-are not GUI-related. In LyX 2.0, Cursor was directly deriving from
-DocIterator
+  * some other data that describes current selection, cursor font, etc.
+
+  This class is mostly used only for undo and contains the Cursor
+  elements that are not GUI-related. In LyX 2.0, Cursor was directly
+  deriving from DocIterator
 
 * A Cursor is a descendant of CursorData that contains interesting
   display-related information, in particular targetX(), the horizontal
   position of the cursor in pixels.
-  * one interesting method for what you want to do is textRow(), that
-    returns the inner Row object that contains the cursor
 */
 
 #ifndef LCURSOR_H
@@ -101,11 +102,6 @@ protected:
        bool mark_;
        /// are we in word-selection mode? This is set when double clicking.
        bool word_selection_;
-       /// If true, we are behind the previous char, otherwise we are in front
-       // of the next char. This only make a difference when we are in front
-       // of a big inset spanning a whole row and computing coordinates for
-       // displaying the cursor.
-       bool logicalpos_;
 
 // FIXME: make them protected.
 public:
@@ -154,7 +150,10 @@ public:
        /// set the cursor data
        void setCursorData(CursorData const & data);
        /// sets cursor part
+       /// this (intentionally) does neither touch anchor nor selection status
        void setCursor(DocIterator const & it);
+       /// set the cursor to dit normalised against the anchor, and set selection.
+       void setCursorSelectionTo(DocIterator dit);
        /// sets the cursor to the normalized selection anchor
        void setCursorToAnchor();
 
@@ -166,8 +165,8 @@ public:
        //
        /// selection active?
        bool selection() const { return selection_; }
-       /// set selection;
-       void setSelection(bool sel) { selection_ = sel; }
+       /// set selection; this is lower level than (set|clear)Selection
+       void selection(bool sel) { selection_ = sel; }
        /// do we have a multicell selection?
        bool selIsMultiCell() const 
                { return selection_ && selBegin().idx() != selEnd().idx(); }