lyx_mirror/src/ParIterator.h
Abdelrazak Younes 0a64dfa594 * ParConstIterator::push_back(): new method for easier iterative construction.
* InsetCaption::addToToc(): use that.



git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@23014 a592a061-630c-0410-9148-cb99ea01b6c8
2008-02-15 08:32:27 +00:00

130 lines
2.9 KiB
C++

// -*- C++ -*-
/* \file ParIterator.h
* This file is part of LyX, the document processor.
* Licence details can be found in the file COPYING.
*
* \author unknown
* \author Lars Gullik Bjønnes
*
* Full author contact details are available in file CREDITS.
*/
#ifndef PARITERATOR_H
#define PARITERATOR_H
#include "DocIterator.h"
#include "support/types.h"
#include <vector>
namespace lyx {
class Inset;
class Text;
class ParagraphList;
class ParIterator : public std::iterator<std::forward_iterator_tag, Paragraph>,
public DocIterator
{
public:
typedef std::iterator<std::forward_iterator_tag, Paragraph> StdIt;
typedef StdIt::value_type value_type;
typedef StdIt::difference_type difference_type;
typedef StdIt::pointer pointer;
typedef StdIt::reference reference;
///
ParIterator() : DocIterator() {}
///
ParIterator(Inset &, pit_type pit);
///
ParIterator(ParIterator const &);
///
explicit ParIterator(DocIterator const &);
/// This really should be implemented...
//ParIterator & operator=(ParIterator const &);
///
ParIterator & operator++();
///
ParIterator operator++(int);
/// See comment in ParIterator.cpp
//ParIterator & operator--();
///
Paragraph & operator*() const;
///
Paragraph * operator->() const;
/// This gives us the top-most parent paragraph
pit_type outerPar() const;
///
pit_type pit() const;
///
/// return the paragraph this cursor is in
pit_type & pit() { return DocIterator::pit(); }
ParagraphList & plist() const;
};
ParIterator par_iterator_begin(Inset & inset);
ParIterator par_iterator_end(Inset & inset);
///
//bool operator==(ParIterator const & it1, ParIterator const & it2);
// FIXME: Unfortunately operator!=(ParIterator &, ParIterator &) is
// implemented with operator!=(DocIterator &, DocIterator &) that gives
// false if the positions are different, even if the pars are the same.
// So ultimately it's a bug in operator!=(ParIterator &, ParIterator &)
// I'd say (nevertheless, I would be reluctant to change it, because I
// fear that some part of the code could rely on this "bug". --Alfredo
//bool operator!=(ParIterator const & it1, ParIterator const & it2);
class ParConstIterator : public std::iterator<std::forward_iterator_tag,
Paragraph>,
public DocIterator
{
public:
///
ParConstIterator() : DocIterator() {}
///
ParConstIterator(ParConstIterator const &);
///
explicit ParConstIterator(DocIterator const &);
///
void push_back(Inset const &);
ParConstIterator & operator++();
///
ParConstIterator & operator--();
///
Paragraph const & operator*() const;
///
Paragraph const * operator->() const;
///
ParagraphList const & plist() const;
};
//bool operator==(ParConstIterator const & it1, ParConstIterator const & it2);
//bool operator!=(ParConstIterator const & it1, ParConstIterator const & it2);
ParConstIterator par_const_iterator_begin(Inset const & inset);
ParConstIterator par_const_iterator_end(Inset const & inset);
} // namespace lyx
#endif