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
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
|
/**************************************************************
*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*
*************************************************************/
#ifndef SD_OUTLINER_ITERATOR_IMPL_HXX
#define SD_OUTLINER_ITERATOR_IMPL_HXX
#include <svx/svdobj.hxx>
#include "OutlinerIterator.hxx"
#include <boost/weak_ptr.hpp>
class SdDrawDocument;
class SdPage;
class SdrObjListIter;
namespace sd {
class ViewShell;
namespace outliner {
class IteratorImplBase;
/** Base class for the polymorphic implementation class of the
<type>Iterator</type> class. The iterators based on this class are
basically uni directional iterators. Their direction can, however, be
reversed at any point of their life time.
*/
class IteratorImplBase
{
public:
/** The constructor stores the given arguments to be used by the derived
classes.
@param pDocument
The document provides the information to be iterated on.
@param pViewShellWeak
Some information has to be taken from the view shell.
@param bDirectionIsForward
This flag defines the iteration direction. When <TRUE/> then
the direction is forwards otherwise it is backwards.
*/
IteratorImplBase (SdDrawDocument* pDocument,
const ::boost::weak_ptr<ViewShell>& rpViewShellWeak,
bool bDirectionIsForward);
IteratorImplBase (SdDrawDocument* pDocument,
const ::boost::weak_ptr<ViewShell>& rpViewShellWeak,
bool bDirectionIsForward, PageKind ePageKind, EditMode eEditMode);
virtual ~IteratorImplBase (void);
/** Advance to the next text of the current object or to the next object.
This takes the iteration direction into
account. The new object pointed to can be retrieved (among other
information) by calling the <member>GetPosition</member> method.
*/
virtual void GotoNextText (void) = 0;
/** Return an object that describes the current object.
@return
The returned object describes the current object pointed to by
the iterator. See the description of
<type>IteratorPosition</type> for details on the available
information.
*/
virtual const IteratorPosition& GetPosition (void);
/** Create an exact copy of this object. No argument should be
specified when called from the outside. It then creates an object
first and passes that to the inherited <member>Clone()</member>
methods to fill in class specific information.
@return
Returns a copy of this object. When this method is called with
an argument then this value will be returned.
*/
virtual IteratorImplBase* Clone (IteratorImplBase* pObject=NULL) const;
/** Test the equality of the this object and the given iterator. Two
iterators are taken to be equal when they point to the same object.
Iteration direction is not taken into account.
@param rIterator
The iterator to compare to.
@return
When both iterators ar equal <TRUE/> is returned, <FALSE/> otherwise.
*/
virtual bool operator== (const IteratorImplBase& rIterator) const;
/** This method is used by the equality operator. Additionaly to the
iterator it takes a type information which is taken into account on
comparison. It is part of a "multimethod" pattern.
@param rIterator
The iterator to compare to.
@param aType
The type of the iterator.
@return
Returns <TRUE/> when both iterators point to the same object.
*/
virtual bool IsEqual (const IteratorImplBase& rIterator, IteratorType aType) const;
/** Reverse the direction of iteration. The current object stays the same.
*/
virtual void Reverse (void);
protected:
/// The current position as returned by <member>GetPosition()</member>.
IteratorPosition maPosition;
/// The document on whose data the iterator operates.
SdDrawDocument* mpDocument;
/// Necessary secondary source of information.
::boost::weak_ptr<ViewShell> mpViewShellWeak;
/// Specifies the search direction.
bool mbDirectionIsForward;
};
/** Iterator all objects that belong to the current mark list
a.k.a. selection. It is assumed that all marked objects belong to the
same page. It is further assumed that the mark list does not change
while an iterator is alive. It is therefore the responsibility of an
iterator's owner to handle the case of a changed mark list.
<p>For documentation of the methods please refere to the base class
<type>IteratorImplBase</type>.</p>
*/
class SelectionIteratorImpl
: public IteratorImplBase
{
public:
SelectionIteratorImpl (
const ::std::vector< SdrObjectWeakRef >& rObjectList,
sal_Int32 nObjectIndex,
SdDrawDocument* pDocument,
const ::boost::weak_ptr<ViewShell>& rpViewShellWeak,
bool bDirectionIsForward);
SelectionIteratorImpl (const SelectionIteratorImpl& rObject);
virtual ~SelectionIteratorImpl (void);
virtual void GotoNextText (void);
virtual const IteratorPosition& GetPosition (void);
virtual IteratorImplBase* Clone (IteratorImplBase* pObject) const;
virtual bool operator== (const IteratorImplBase& rIterator) const;
private:
const ::std::vector<SdrObjectWeakRef>& mrObjectList;
sal_Int32 mnObjectIndex;
/** Compare the given iterator with this object. This method handles
only the case that the given iterator is an instance of this class.
@param rIterator
The iterator to compare to.
@param aType
The type of the iterator.
@return
Returns <TRUE/> when both iterators point to the same object.
*/
virtual bool IsEqual (const IteratorImplBase& rIterator, IteratorType aType) const;
IteratorImplBase& operator= (const IteratorImplBase& rIterator);
};
/** Iterator for iteration over all objects in a single view. On reaching
the last object on the last page (or the first object on the first page)
the view is *not* switched. Further calls to the
<member>GotoNextObject()</member> method will be ignored.
<p>For documentation of the methods please refere to the base class
<type>IteratorImplBase</type>.</p>
*/
class ViewIteratorImpl : public IteratorImplBase
{
public:
ViewIteratorImpl (
sal_Int32 nPageIndex,
SdDrawDocument* pDocument,
const ::boost::weak_ptr<ViewShell>& rpViewShellWeak,
bool bDirectionIsForward);
ViewIteratorImpl (
sal_Int32 nPageIndex,
SdDrawDocument* pDocument,
const ::boost::weak_ptr<ViewShell>& rpViewShellWeak,
bool bDirectionIsForward,
PageKind ePageKind,
EditMode eEditMode);
virtual ~ViewIteratorImpl (void);
virtual void GotoNextText (void);
virtual IteratorImplBase* Clone (IteratorImplBase* pObject) const;
virtual void Reverse (void);
protected:
/// Number of pages in the view that is specified by <member>maPosition</member>.
sal_Int32 mnPageCount;
/** Initialize this iterator with respect to the given location. After
this call the object looks like newly constructed.
*/
void Init (IteratorLocation aLocation);
/** Set up page pointer and object list iterator for the specified
page.
@param nPageIndex
Index of the new page. It may lie outside the valid range for
page indices.
*/
void SetPage (sal_Int32 nPageIndex);
private:
/// Indicates whether a page changed occured on switching to current page.
bool mbPageChangeOccured;
/// Pointer to the page associated with the current page index. May be NULL.
SdPage* mpPage;
/// Iterator of all objects on the current page.
SdrObjListIter* mpObjectIterator;
// Don't use this operator.
ViewIteratorImpl& operator= (const ViewIteratorImpl&){return *this;};
};
/** Iterator for iteration over all objects in all views. It automatically
switches views when reaching the end/beginning of a view.
<p>For documentation of the methods please refere to the base class
<type>IteratorImplBase</type>.</p>
*/
class DocumentIteratorImpl : public ViewIteratorImpl
{
public:
DocumentIteratorImpl (
sal_Int32 nPageIndex,
PageKind ePageKind,
EditMode eEditMode,
SdDrawDocument* pDocument,
const ::boost::weak_ptr<ViewShell>& rpViewShellWeak,
bool bDirectionIsForward);
virtual ~DocumentIteratorImpl (void);
virtual void GotoNextText (void);
virtual IteratorImplBase* Clone (IteratorImplBase* pObject) const;
private:
sal_Int32 mnPageCount;
// Don't use this operator.
DocumentIteratorImpl& operator= (const DocumentIteratorImpl& ){return *this;};
};
} } // end of namespace ::sd::outliner
#endif
|
