* This file is part of LyX, the document processor.
* Licence details can be found in the file COPYING.
*
- * \author Lars Gullik Bjønnes
+ * \author Lars Gullik Bjønnes
* \author Matthias Ettrich
* \author John Levon
- * \author André Pönitz
+ * \author André Pönitz
* \author Dekel Tsur
- * \author Jürgen Vigna
+ * \author Jürgen Vigna
*
* Full author contact details are available in file CREDITS.
*/
#ifndef CURSORSLICE_H
#define CURSORSLICE_H
-#include "insets/InsetBase.h"
#include "support/types.h"
-
-#include <cstddef>
-#include <iosfwd>
+#include "support/strfwd.h"
+#include "insets/Inset.h"
namespace lyx {
-class InsetBase;
-class MathArray;
-class LyXText;
+class Inset;
+class MathData;
+class Text;
class Paragraph;
/// This encapsulates a single slice of a document iterator as used e.g.
/// for cursors.
// After IU, the distinction of MathInset and InsetOld as well as
-// that of MathArray and LyXText should vanish. They are conceptually the
+// that of MathData and Text should vanish. They are conceptually the
// same (now...)
class CursorSlice {
public:
+ /// Those needs inset_ access.
+ ///@{
+ friend class DocIterator;
+ friend class StableDocIterator;
+ ///@}
+
/// type for cell number in inset
typedef size_t idx_type;
/// type for row indices
///
CursorSlice();
///
- explicit CursorSlice(InsetBase &);
+ explicit CursorSlice(Inset &);
+
+ /// comparison operators.
+ //@{
+ friend bool operator==(CursorSlice const &, CursorSlice const &);
+ friend bool operator!=(CursorSlice const &, CursorSlice const &);
+ friend bool operator<(CursorSlice const &, CursorSlice const &);
+ friend bool operator>(CursorSlice const &, CursorSlice const &);
+ friend bool operator<=(CursorSlice const &, CursorSlice const &);
+ //@}
/// the current inset
- InsetBase & inset() const { return *inset_; }
+ Inset & inset() const { return *inset_; }
/// return the cell this cursor is in
idx_type idx() const { return idx_; }
/// return the cell this cursor is in
pit_type pit() const { return pit_; }
/// set the offset of the paragraph this cursor is in
pit_type & pit() { return pit_; }
+ /// return the last paragraph offset within the ParagraphList
+ pit_type lastpit() const;
/// increments the paragraph this cursor is in
void incrementPar();
/// decrements the paragraph this cursor is in
/// texted specific stuff
///
/// returns text corresponding to this position
- LyXText * text() { return inset_->getText(idx_); }
- /// returns text corresponding to this position
- LyXText const * text() const { return inset_->getText(idx_); }
- /// paragraph in this cell
- Paragraph & paragraph();
+ Text * text() const { return inset_->getText(idx_); }
/// paragraph in this cell
- Paragraph const & paragraph() const;
+ Paragraph & paragraph() const;
///
/// mathed specific stuff
/// returns the owning inset if it is a InsetMath, else 0
InsetMath * asInsetMath() const { return inset_->asInsetMath(); }
/// returns cell corresponding to this position
- MathArray & cell() const;
+ MathData & cell() const;
/// write some debug information to \p os
friend std::ostream & operator<<(std::ostream &, CursorSlice const &);
-public:
- /// pointer to 'owning' inset. This is some kind of cache.
- InsetBase * inset_;
+ /// move to next position
+ void forwardPos();
+ /// move to previous position
+ void backwardPos();
+ /// move to next cell
+ void forwardIdx();
+ /// move to previous cell
+ void backwardIdx();
+ /// are we at the end of this slice
+ bool at_end() const;
+ /// are we at the start of this slice
+ bool at_begin() const;
+
private:
+
+ /// pointer to 'owning' inset. This is some kind of cache.
+ Inset * inset_;
+
/*!
* Cell index of a position in this inset.
* This is the primary cell information also for grid like insets,
idx_type idx_;
/// paragraph in this cell (used by texted)
pit_type pit_;
- /// true if 'pit' was properly initialized
- bool pit_valid_;
/// position in this cell
pos_type pos_;
};
-/// test for equality
-bool operator==(CursorSlice const &, CursorSlice const &);
-/// test for inequality
-bool operator!=(CursorSlice const &, CursorSlice const &);
-/// test for order
-bool operator<(CursorSlice const &, CursorSlice const &);
-/// test for order
-bool operator>(CursorSlice const &, CursorSlice const &);
-/// test for order
-bool operator<=(CursorSlice const &, CursorSlice const &);
-
} // namespace lyx