src/lyxcursor.h

   1 // -*- C++ -*-
   2 /**
   3  * \file lyxcursor.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author Lars Gullik Bjønnes
   8  * \author Matthias Ettrich
   9  * \author John Levon
  10  * \author André Pönitz
  11  * \author Dekel Tsur
  12  * \author Jürgen Vigna
  13  *
  14  * Full author contact details are available in file CREDITS.
  15  */
  16
  17 #ifndef LYXCURSOR_H
  18 #define LYXCURSOR_H
  19
  20 #include "support/types.h"
  21
  22 /**
  23  * The cursor class describes the position of a cursor within a document.
  24  * Several cursors exist within LyX; for example, when locking an inset,
  25  * the position of the cursor in the containing inset is stored.
  26  *
  27  * FIXME: true ?
  28  */
  29 class LyXCursor {
  30 public:
  31         LyXCursor();
  32         /// set the paragraph that contains this cursor
  33         void par(lyx::paroffset_type pit);
  34         /// return the paragraph this cursor is in
  35         lyx::paroffset_type par() const;
  36         /// set the position within the paragraph
  37         void pos(lyx::pos_type p);
  38         /// return the position within the paragraph
  39         lyx::pos_type pos() const;
  40         /// FIXME
  41         void boundary(bool b);
  42         /// FIXME
  43         bool boundary() const;
  44
  45 private:
  46         /// The paragraph the cursor is in.
  47         lyx::paroffset_type par_;
  48         /// The position inside the paragraph
  49         lyx::pos_type pos_;
  50         /**
  51          * When the cursor position is i, is the cursor is after the i-th char
  52          * or before the i+1-th char ? Normally, these two interpretations are
  53          * equivalent, except when the fonts of the i-th and i+1-th char
  54          * differ.
  55          * We use boundary_ to distinguish between the two options:
  56          * If boundary_=true, then the cursor is after the i-th char
  57          * and if boundary_=false, then the cursor is before the i+1-th char.
  58          *
  59          * We currently use the boundary only when the language direction of
  60          * the i-th char is different than the one of the i+1-th char.
  61          * In this case it is important to distinguish between the two
  62          * cursor interpretations, in order to give a reasonable behavior to
  63          * the user.
  64          */
  65         bool boundary_;
  66 };
  67
  68 ///
  69 bool operator==(LyXCursor const & a, LyXCursor const & b);
  70 ///
  71 bool operator!=(LyXCursor const & a, LyXCursor const & b);
  72 ///
  73 bool operator<(LyXCursor const & a, LyXCursor const & b);
  74
  75 #endif // LYXCURSOR_H