3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
7 * \author Lars Gullik Bjønnes
9 * Full author contact details are available in file CREDITS.
15 #include "dociterator.h"
16 #include "ParagraphList_fwd.h"
18 #include "support/types.h"
20 #include <boost/optional.hpp>
33 class ParIterator : public std::iterator<std::forward_iterator_tag, Paragraph>,
37 typedef std::iterator<std::forward_iterator_tag, Paragraph> StdIt;
39 typedef StdIt::value_type value_type;
40 typedef StdIt::difference_type difference_type;
41 typedef StdIt::pointer pointer;
42 typedef StdIt::reference reference;
45 ParIterator() : DocIterator() {}
49 ParIterator(InsetBase &, pit_type pit);
51 ParIterator(ParIterator const &);
53 ParIterator(DocIterator const &);
55 /// This really should be implemented...
56 //ParIterator & operator=(ParIterator const &);
58 ParIterator & operator++();
60 ParIterator operator++(int);
61 /// See comment in pariterator.C
62 //ParIterator & operator--();
64 Paragraph & operator*() const;
66 Paragraph * operator->() const;
67 /// This gives us the top-most parent paragraph
68 pit_type outerPar() const;
72 /// return the paragraph this cursor is in
73 pit_type & pit() { return DocIterator::pit(); }
75 ParagraphList & plist() const;
79 DocIterator makeDocIterator(ParIterator const &, pos_type);
81 ParIterator par_iterator_begin(InsetBase & inset);
83 ParIterator par_iterator_end(InsetBase & inset);
87 bool operator==(ParIterator const & iter1, ParIterator const & iter2);
90 bool operator!=(ParIterator const & iter1, ParIterator const & iter2);
93 class ParConstIterator : public std::iterator<std::forward_iterator_tag,
99 ParConstIterator(): DocIterator() {}
101 ParConstIterator(ParConstIterator const &);
103 ParConstIterator(DocIterator const &);
106 ParConstIterator & operator++();
108 ParConstIterator & operator--();
110 Paragraph const & operator*() const;
112 Paragraph const * operator->() const;
114 ParagraphList const & plist() const;
117 bool operator==(ParConstIterator const & iter1,
118 ParConstIterator const & iter2);
120 bool operator!=(ParConstIterator const & iter1,
121 ParConstIterator const & iter2);
124 ParConstIterator par_const_iterator_begin(InsetBase const & inset);
126 ParConstIterator par_const_iterator_end(InsetBase const & inset);