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.
20 #include "ParagraphList_fwd.h"
22 #include "support/types.h"
36 /// This encapsulates a single slice of a document iterator as used e.g.
39 // After IU, the distinction of MathInset and UpdatableInset as well as
40 // that of MathArray and LyXText should vanish. They are conceptually the
45 /// type for cell number in inset
46 typedef size_t idx_type;
47 /// type for paragraph numbers positions within a cell
48 typedef lyx::paroffset_type par_type;
49 /// type for cursor positions within a cell
50 typedef lyx::pos_type pos_type;
51 /// type for row indices
52 typedef size_t row_type;
53 /// type for col indices
54 typedef size_t col_type;
59 explicit CursorSlice(InsetBase &);
62 InsetBase & inset() const { return *inset_; }
63 /// return the cell this cursor is in
65 /// return the cell this cursor is in
67 /// return the last cell in this inset
68 idx_type lastidx() const { return nargs() - 1; }
69 /// return the paragraph this cursor is in
71 /// set the paragraph this cursor is in
73 /// increments the paragraph this cursor is in
75 /// increments the paragraph this cursor is in
77 /// return the position within the paragraph
79 /// return the position within the paragraph
81 /// return the last position within the paragraph
82 pos_type lastpos() const;
83 /// return the number of embedded cells
85 /// return the number of embedded cells
87 /// return the number of embedded cells
89 /// return the grid row of the current cell
91 /// return the grid row of the current cell
95 /// texted specific stuff
97 /// see comment for the member
98 bool boundary() const;
99 /// see comment for the member
102 LyXText * text() const;
104 UpdatableInset * asUpdatableInset() const;
106 Paragraph & paragraph();
108 Paragraph const & paragraph() const;
111 /// mathed specific stuff
113 /// returns cell corresponding to this position
114 MathArray & cell() const;
116 MathInset * asMathInset() const;
119 friend std::ostream & operator<<(std::ostream &, CursorSlice const &);
121 /// pointer to 'owning' inset. This is some kind of cache.
124 /// cell index of a position in this inset
126 /// paragraph in this cell (used by texted)
128 /// true of 'pit' was properly initialized
130 /// position in this cell
133 * When the cursor position is i, is the cursor is after the i-th char
134 * or before the i+1-th char ? Normally, these two interpretations are
135 * equivalent, except when the fonts of the i-th and i+1-th char
137 * We use boundary_ to distinguish between the two options:
138 * If boundary_=true, then the cursor is after the i-th char
139 * and if boundary_=false, then the cursor is before the i+1-th char.
141 * We currently use the boundary only when the language direction of
142 * the i-th char is different than the one of the i+1-th char.
143 * In this case it is important to distinguish between the two
144 * cursor interpretations, in order to give a reasonable behavior to
150 /// test for equality
151 bool operator==(CursorSlice const &, CursorSlice const &);
152 /// test for inequality
153 bool operator!=(CursorSlice const &, CursorSlice const &);
155 bool operator<(CursorSlice const &, CursorSlice const &);
157 bool operator>(CursorSlice const &, CursorSlice const &);