KoTextIterator.h

/* This file is part of the KDE project
   Copyright (C) 2002 David Faure <faure@kde.org>
 
   This library is free software; you can redistribute it and/or
   modify it under the terms of the GNU Library General Public
   License version 2 as published by the Free Software Foundation.
 
   This library is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
   Library General Public License for more details.
 
   You should have received a copy of the GNU Library General Public License
   along with this library; see the file COPYING.LIB.  If not, write to
   the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
 * Boston, MA 02110-1301, USA.
*/
 
#ifndef KOTEXTITERATOR_H
#define KOTEXTITERATOR_H
 
#include <tqvaluelist.h>
#include <tqstring.h>
#include <tqpair.h>
#include <tqobject.h>
#include <koffice_export.h>
class KoTextParag;
class KoTextObject;
class KoTextView;

class KOTEXT_EXPORT KoTextIterator : public TQObject
{
    TQ_OBJECT
  
public:
    KoTextIterator( const TQValueList<KoTextObject *> & lstObjects, KoTextView* textView, int options ) {
        init( lstObjects, textView, options );
    }
    void init( const TQValueList<KoTextObject *> & lstObjects, KoTextView* textView, int options );

    void restart();

    void setOptions( int options );

    int options() const { return m_options; }

    void operator++();

    bool atEnd() const;

    bool hasText() const;

    TQString currentText() const;

    KoTextParag* currentParag() const { return m_currentParag; }

    KoTextObject* currentTextObject() const { return *m_currentTextObj; }

    int currentStartIndex() const;

    TQPair<int, TQString> currentTextAndIndex() const;
 
signals:
    void currentParagraphModified( int modifyType, int pos, int length );

    void currentParagraphDeleted();
 
protected:
    void connectTextObjects();
    void nextTextObject();
 
protected slots:
    void slotParagraphDeleted( KoTextParag* parag );
    void slotParagraphModified( KoTextParag* parag, int /*ParagModifyType*/, int pos, int length );
 
private:
    // The reason we use a TQValueList of pointers instead of TQPtrList
    // is that having a TQPtrListIterator member var can't work, one can't
    // initialize it afterwards.
    TQValueList<KoTextObject *> m_lstObjects;
    int m_options;
 
    // This is relative to the first textobject in m_lstObjects
    // We always start from this paragraph (even when going backwards)
    KoTextParag* m_firstParag;
    int m_firstIndex;
 
    // This is relative to the last textobject in m_lstObjects
    // We're done when we hit this paragraph
    KoTextParag* m_lastParag;
    int m_lastIndex;
 
    // Our current position
    TQValueList<KoTextObject *>::Iterator m_currentTextObj;
    KoTextParag* m_currentParag;
};
 
#endif