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"
21 #include "insets/Inset.h"
34 /// This encapsulates a single slice of a document iterator as used e.g.
37 // After IU, the distinction of MathInset and InsetOld as well as
38 // that of MathData and Text should vanish. They are conceptually the
43 /// Those needs inset_ access.
45 friend class DocIterator;
46 friend class StableDocIterator;
49 /// type for cell number in inset
50 typedef size_t idx_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(Inset &);
62 Inset & inset() const { return *inset_; }
63 /// return the cell this cursor is in
64 idx_type idx() const { return idx_; }
65 /// return the cell this cursor is in
66 idx_type & idx() { return idx_; }
67 /// return the last cell in this inset
68 idx_type lastidx() const { return nargs() - 1; }
69 /// return the offset of the paragraph this cursor is in
70 pit_type pit() const { return pit_; }
71 /// set the offset of the paragraph this cursor is in
72 pit_type & pit() { return pit_; }
73 /// return the last paragraph offset within the ParagraphList
74 pit_type lastpit() const;
75 /// increments the paragraph this cursor is in
77 /// decrements the paragraph this cursor is in
79 /// return the position within the paragraph
80 pos_type pos() const { return pos_; }
81 /// return the position within the paragraph
82 pos_type & pos() { return pos_; }
83 /// return the last position within the paragraph
84 pos_type lastpos() const;
85 /// return the number of embedded cells
86 size_t nargs() const { return inset_->nargs(); }
87 /// return the number of columns (1 in non-grid-like insets)
88 size_t ncols() const { return inset_->ncols(); }
89 /// return the number of rows (1 in non-grid-like insets)
90 size_t nrows() const { return inset_->nrows(); }
92 * \return the grid row of the current cell.
93 * This does only make sense in grid like insets.
97 * \return the grid column of the current cell.
98 * This does only make sense in grid like insets.
100 col_type col() const;
103 /// texted specific stuff
105 /// returns text corresponding to this position
106 Text * text() const { return inset_->getText(idx_); }
107 /// paragraph in this cell
108 Paragraph & paragraph() const;
111 /// mathed specific stuff
113 /// returns the owning inset if it is a InsetMath, else 0
114 InsetMath * asInsetMath() const { return inset_->asInsetMath(); }
115 /// returns cell corresponding to this position
116 MathData & cell() const;
118 /// write some debug information to \p os
119 friend std::ostream & operator<<(std::ostream &, CursorSlice const &);
120 /// move to next position
122 /// move to previous position
124 /// move to next cell
126 /// move to previous cell
128 /// are we at the end of this slice
130 /// are we at the start of this slice
131 bool at_begin() const;
135 /// pointer to 'owning' inset. This is some kind of cache.
139 * Cell index of a position in this inset.
140 * This is the primary cell information also for grid like insets,
141 * although we have the convenience functions row() and col() for
142 * those * and column changes every time the number of columns ornumber
143 * of rows changes. Normally the cursor should stay in the same cell,
144 * so these changes should typically be performed like the following:
146 * row_type const r = cur.row();
147 * col_type const c = cur.col();
148 * // change nrows() and/or ncols()
149 * cur.idx = index(r, c);
153 /// paragraph in this cell (used by texted)
155 /// position in this cell
159 /// test for equality
160 bool operator==(CursorSlice const &, CursorSlice const &);
161 /// test for inequality
162 bool operator!=(CursorSlice const &, CursorSlice const &);
164 bool operator<(CursorSlice const &, CursorSlice const &);
166 bool operator>(CursorSlice const &, CursorSlice const &);
168 bool operator<=(CursorSlice const &, CursorSlice const &);