|
|
|
/* 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;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* A convenient way to iterate over paragraphs, possibly in multiple textobjects,
|
|
|
|
* with many options (from cursor, backwards, in selection).
|
|
|
|
* @short General purpose paragraph iterator
|
|
|
|
*/
|
|
|
|
class KOTEXT_EXPORT KoTextIterator : public TQObject
|
|
|
|
{
|
|
|
|
Q_OBJECT
|
|
|
|
|
|
|
|
public:
|
|
|
|
/**
|
|
|
|
* @param lstObjects list of text objects to iterate over
|
|
|
|
* @param textView view in which the objects live
|
|
|
|
* @param options see KFindDialog
|
|
|
|
*/
|
|
|
|
KoTextIterator( const TQValueList<KoTextObject *> & lstObjects, KoTextView* textView, int options ) {
|
|
|
|
init( lstObjects, textView, options );
|
|
|
|
}
|
|
|
|
void init( const TQValueList<KoTextObject *> & lstObjects, KoTextView* textView, int options );
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Restart from the beginning - assumes same parameters given to init
|
|
|
|
*/
|
|
|
|
void restart();
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Change options during iteration. ## Not sure how if all cases will be handled :}
|
|
|
|
* At least this is useful for the "Replace All" button during replacing,
|
|
|
|
* and for switching to "FindBackwards" temporarily for "find previous".
|
|
|
|
*/
|
|
|
|
void setOptions( int options );
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Return the options currently used by the iterator.
|
|
|
|
*/
|
|
|
|
int options() const { return m_options; }
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Go to next paragraph that we must iterate over
|
|
|
|
*/
|
|
|
|
void operator++();
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @return true if we have iterated over all paragraphs
|
|
|
|
*/
|
|
|
|
bool atEnd() const;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @return true if currentText() isn't empty. The implementation is
|
|
|
|
* faster than calling currentText().isEmpty() though.
|
|
|
|
*/
|
|
|
|
bool hasText() const;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @return the string at the current position of the iterator
|
|
|
|
*/
|
|
|
|
TQString currentText() const;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @return the string at the current position of the iterator
|
|
|
|
*/
|
|
|
|
KoTextParag* currentParag() const { return m_currentParag; }
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @return the text object in which @ref currentParag() is.
|
|
|
|
*/
|
|
|
|
KoTextObject* currentTextObject() const { return *m_currentTextObj; }
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Where in @ref currentParag() does @ref currentText() start?
|
|
|
|
*/
|
|
|
|
int currentStartIndex() const;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @return the string at the current position of the iterator,
|
|
|
|
* as well as the index in the current paragraph.
|
|
|
|
* Use this instead of separate calls to currentText and currentStartIndex,
|
|
|
|
* for performance reasons.
|
|
|
|
*/
|
|
|
|
TQPair<int, TQString> currentTextAndIndex() const;
|
|
|
|
|
|
|
|
signals:
|
|
|
|
/**
|
|
|
|
* Emitted when the current paragraph has been modified by the user.
|
|
|
|
* Apps will often want to call setData again
|
|
|
|
*/
|
|
|
|
void currentParagraphModified( int modifyType, int pos, int length );
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Emitted when the current paragraph has been deleted by the user.
|
|
|
|
* When this happens, the iterator automatically moves to the next paragraph (if any).
|
|
|
|
*/
|
|
|
|
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
|