1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
|
/* 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 <qvaluelist.h>
#include <qstring.h>
#include <qpair.h>
#include <qobject.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 QObject
{
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 QValueList<KoTextObject *> & lstObjects, KoTextView* textView, int options ) {
init( lstObjects, textView, options );
}
void init( const QValueList<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
*/
QString 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.
*/
QPair<int, QString> 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 QValueList of pointers instead of QPtrList
// is that having a QPtrListIterator member var can't work, one can't
// initialize it afterwards.
QValueList<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
QValueList<KoTextObject *>::Iterator m_currentTextObj;
KoTextParag* m_currentParag;
};
#endif
|
