4 * This file is part of LyX, the document processor.
5 * Licence details can be found in the file COPYING.
7 * \author Lars Gullik Bjønnes
8 * \author Matthias Ettrich
10 * \author André Pönitz
12 * \author Jürgen Vigna
14 * Full author contact details are available in file CREDITS.
23 #include "support/types.h"
34 /// This encapsulates a single slice of a document iterator as used e.g.
37 // After IU, the distinction of MathInset and UpdatableInset as well as
38 // that of MathArray and LyXText should vanish. They are conceptually the
43 /// type for cell number in inset
44 typedef size_t idx_type;
45 /// type for paragraph numbers positions within a cell
46 typedef lyx::paroffset_type par_type;
47 /// type for cursor positions within a cell
48 typedef lyx::pos_type pos_type;
49 /// type for row indices
50 typedef size_t row_type;
51 /// type for col indices
52 typedef size_t col_type;
57 explicit CursorSlice(InsetBase &);
60 InsetBase & inset() const { return *inset_; }
61 /// return the cell this cursor is in
63 /// return the cell this cursor is in
65 /// return the last cell in this inset
66 idx_type lastidx() const { return nargs() - 1; }
67 /// return the paragraph this cursor is in
69 /// return the paragraph this cursor is in
71 /// return the position within the paragraph
73 /// return the position within the paragraph
75 /// return the last position within the paragraph
76 pos_type lastpos() const;
77 /// return the number of embedded cells
79 /// return the number of embedded cells
81 /// return the number of embedded cells
83 /// return the grid row of the current cell
85 /// return the grid row of the current cell
89 /// texted specific stuff
91 /// see comment for the member
92 bool boundary() const;
93 /// see comment for the member
96 LyXText * text() const;
98 UpdatableInset * asUpdatableInset() const;
100 Paragraph & paragraph();
102 Paragraph const & paragraph() const;
105 /// mathed specific stuff
107 /// returns cell corresponding to this position
108 MathArray & cell() const;
110 MathInset * asMathInset() const;
113 friend std::ostream & operator<<(std::ostream &, CursorSlice const &);
115 /// pointer to 'owning' inset
117 /// cell index of a position in this inset
119 /// paragraph in this cell (used by texted)
121 /// position in this cell
124 * When the cursor position is i, is the cursor is after the i-th char
125 * or before the i+1-th char ? Normally, these two interpretations are
126 * equivalent, except when the fonts of the i-th and i+1-th char
128 * We use boundary_ to distinguish between the two options:
129 * If boundary_=true, then the cursor is after the i-th char
130 * and if boundary_=false, then the cursor is before the i+1-th char.
132 * We currently use the boundary only when the language direction of
133 * the i-th char is different than the one of the i+1-th char.
134 * In this case it is important to distinguish between the two
135 * cursor interpretations, in order to give a reasonable behavior to
141 /// test for equality
142 bool operator==(CursorSlice const &, CursorSlice const &);
143 /// test for inequality
144 bool operator!=(CursorSlice const &, CursorSlice const &);
146 bool operator<(CursorSlice const &, CursorSlice const &);
148 bool operator>(CursorSlice const &, CursorSlice const &);