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 "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::pit_type pit_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
62 idx_type idx() const { return idx_; }
63 /// return the cell this cursor is in
64 idx_type & idx() { return idx_; }
65 /// return the last cell in this inset
66 idx_type lastidx() const { return nargs() - 1; }
67 /// return the offset of the paragraph this cursor is in
68 pit_type pit() const { return pit_; }
69 /// set the offset of the paragraph this cursor is in
70 pit_type & pit() { return pit_; }
71 /// increments the paragraph this cursor is in
73 /// decrements the paragraph this cursor is in
75 /// return the position within the paragraph
76 pos_type pos() const { return pos_; }
77 /// return the position within the paragraph
78 pos_type & pos() { return pos_; }
79 /// return the last position within the paragraph
80 pos_type lastpos() const;
81 /// return the number of embedded cells
84 * \return the number of columns.
85 * This does only make sense in grid like insets.
89 * \return the number of rows.
90 * This does only make sense in grid like insets.
94 * \return the grid row of the current cell.
95 * This does only make sense in grid like insets.
99 * \return the grid column of the current cell.
100 * This does only make sense in grid like insets.
102 col_type col() const;
105 /// texted specific stuff
107 /// returns text corresponding to this position
109 /// returns text corresponding to this position
110 LyXText const * text() const;
111 /// returns the owning inset if it is an UpdatableInset, else 0
112 UpdatableInset * asUpdatableInset() const;
113 /// paragraph in this cell
114 Paragraph & paragraph();
115 /// paragraph in this cell
116 Paragraph const & paragraph() const;
119 /// mathed specific stuff
121 /// returns cell corresponding to this position
122 MathArray & cell() const;
123 /// returns the owning inset if it is a MathInset, else 0
124 MathInset * asMathInset() const;
126 /// write some debug information to \p os
127 friend std::ostream & operator<<(std::ostream &, CursorSlice const &);
129 /// pointer to 'owning' inset. This is some kind of cache.
133 * Cell index of a position in this inset.
134 * This is the primary cell information also for grid like insets,
135 * although we have the convenience functions row() and col() for
137 * This means that the corresponding idx_ of a cell in a given row
138 * and column changes every time the number of columns or number of
139 * rows changes. Normally the cursor should stay in the same cell,
140 * so these changes should typically be performed like the following:
142 * row_type const r = cur.row();
143 * col_type const c = cur.col();
144 * // change nrows() and/or ncols()
145 * cur.idx = index(r, c);
149 /// paragraph in this cell (used by texted)
151 /// true if 'pit' was properly initialized
153 /// position in this cell
157 /// test for equality
158 bool operator==(CursorSlice const &, CursorSlice const &);
159 /// test for inequality
160 bool operator!=(CursorSlice const &, CursorSlice const &);
162 bool operator<(CursorSlice const &, CursorSlice const &);
164 bool operator>(CursorSlice const &, CursorSlice const &);
166 bool operator<=(CursorSlice const &, CursorSlice const &);