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
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* 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 .
*/
#ifndef _SVTREELIST_HXX
#define _SVTREELIST_HXX
#include "svtools/svtdllapi.h"
#include "svtools/treelistentries.hxx"
#include "svtools/viewdataentry.hxx"
#include <tools/solar.h>
#include <tools/link.hxx>
#include <tools/string.hxx>
#include <tools/debug.hxx>
#include <limits.h>
#include <vector>
#include <boost/ptr_container/ptr_map.hpp>
#define LISTACTION_INSERTED 1
#define LISTACTION_REMOVING 2
#define LISTACTION_REMOVED 3
#define LISTACTION_MOVING 4
#define LISTACTION_MOVED 5
#define LISTACTION_CLEARING 6
#define LISTACTION_INSERTED_TREE 7
#define LISTACTION_INVALIDATE_ENTRY 8
#define LISTACTION_RESORTING 9
#define LISTACTION_RESORTED 10
#define LISTACTION_CLEARED 11
class SvTreeListEntry;
class SvListView;
enum SvSortMode { SortAscending, SortDescending, SortNone };
// For the return values of Sortlink:
// See International::Compare( pLeft, pRight )
// ( Compare(a,b) ==> b.Compare(a) ==> strcmp(a,b) )
struct SvSortData
{
const SvTreeListEntry* pLeft;
const SvTreeListEntry* pRight;
};
class SVT_DLLPUBLIC SvTreeList
{
typedef std::vector<SvListView*> ListViewsType;
friend class SvListView;
ListViewsType aViewList;
sal_uLong nEntryCount;
Link aCloneLink;
Link aCompareLink;
SvSortMode eSortMode;
sal_uInt16 nRefCount;
sal_Bool bAbsPositionsValid;
SvTreeListEntry* FirstVisible() const { return First(); }
SvTreeListEntry* NextVisible( const SvListView*,SvTreeListEntry* pEntry, sal_uInt16* pDepth=0 ) const;
SvTreeListEntry* PrevVisible( const SvListView*,SvTreeListEntry* pEntry, sal_uInt16* pDepth=0 ) const;
SvTreeListEntry* LastVisible( const SvListView*,sal_uInt16* pDepth=0 ) const;
SvTreeListEntry* NextVisible( const SvListView*,SvTreeListEntry* pEntry, sal_uInt16& rDelta ) const;
SvTreeListEntry* PrevVisible( const SvListView*,SvTreeListEntry* pEntry, sal_uInt16& rDelta ) const;
sal_Bool IsEntryVisible( const SvListView*,SvTreeListEntry* pEntry ) const;
SvTreeListEntry* GetEntryAtVisPos( const SvListView*,sal_uLong nVisPos ) const;
sal_uLong GetVisiblePos( const SvListView*,SvTreeListEntry* pEntry ) const;
sal_uLong GetVisibleCount( SvListView* ) const;
sal_uLong GetVisibleChildCount( const SvListView*,SvTreeListEntry* pParent ) const;
SvTreeListEntry* FirstSelected( const SvListView*) const;
SvTreeListEntry* NextSelected( const SvListView*,SvTreeListEntry* pEntry ) const;
SvTreeListEntry* PrevSelected( const SvListView*,SvTreeListEntry* pEntry ) const;
SvTreeListEntry* LastSelected( const SvListView*) const;
sal_Bool Select( SvListView*,SvTreeListEntry* pEntry, sal_Bool bSelect=sal_True );
void SelectAll( SvListView*,sal_Bool bSelect ); // Does not call Select Handler
sal_uLong GetChildSelectionCount( const SvListView*,SvTreeListEntry* pParent ) const;
void Expand( SvListView*,SvTreeListEntry* pParent );
void Collapse( SvListView*,SvTreeListEntry* pParent );
SVT_DLLPRIVATE void SetAbsolutePositions();
SVT_DLLPRIVATE void CloneChildren(
SvTreeListEntries& rDst, sal_uLong& rCloneCount, SvTreeListEntries& rSrc, SvTreeListEntry* pNewParent) const;
/**
* Invalidate the cached position data to have them re-generated before
* the next access.
*/
SVT_DLLPRIVATE void SetListPositions( SvTreeListEntries& rEntries );
// rPos is not changed for SortModeNone
SVT_DLLPRIVATE void GetInsertionPos(
SvTreeListEntry* pEntry,
SvTreeListEntry* pParent,
sal_uLong& rPos
);
SVT_DLLPRIVATE void ResortChildren( SvTreeListEntry* pParent );
SvTreeList(const SvTreeList&); // disabled
SvTreeList& operator= (const SvTreeList&); // disabled
protected:
SvTreeListEntry* pRootItem;
public:
SvTreeList();
virtual ~SvTreeList();
void InsertView( SvListView* );
void RemoveView( SvListView* );
sal_uLong GetViewCount() const
{ return aViewList.size(); }
SvListView* GetView( sal_uLong nPos ) const
{ return ( nPos < aViewList.size() ) ? aViewList[ nPos ] : NULL; }
void Broadcast(
sal_uInt16 nActionId,
SvTreeListEntry* pEntry1=0,
SvTreeListEntry* pEntry2=0,
sal_uLong nPos=0
);
// Notify all Listeners
void InvalidateEntry( SvTreeListEntry* );
sal_uLong GetEntryCount() const { return nEntryCount; }
SvTreeListEntry* First() const;
SvTreeListEntry* Next( SvTreeListEntry* pEntry, sal_uInt16* pDepth=0 ) const;
SvTreeListEntry* Prev( SvTreeListEntry* pEntry, sal_uInt16* pDepth=0 ) const;
SvTreeListEntry* Last() const;
SvTreeListEntry* FirstChild( SvTreeListEntry* pParent ) const;
SvTreeListEntry* NextSibling( SvTreeListEntry* pEntry ) const;
SvTreeListEntry* PrevSibling( SvTreeListEntry* pEntry ) const;
SvTreeListEntry* LastSibling( SvTreeListEntry* pEntry ) const;
sal_uLong Insert( SvTreeListEntry* pEntry,SvTreeListEntry* pPar,sal_uLong nPos=ULONG_MAX);
sal_uLong Insert( SvTreeListEntry* pEntry,sal_uLong nRootPos = ULONG_MAX )
{ return Insert(pEntry, pRootItem, nRootPos ); }
void InsertTree( SvTreeListEntry* pTree, SvTreeListEntry* pTargetParent, sal_uLong nListPos );
// Entries need to be in the same Model!
void Move( SvTreeListEntry* pSource, SvTreeListEntry* pTarget );
// Creates ChildList if needed
sal_uLong Move( SvTreeListEntry* pSource, SvTreeListEntry* pTargetParent, sal_uLong nListPos);
void Copy( SvTreeListEntry* pSource, SvTreeListEntry* pTarget );
sal_uLong Copy( SvTreeListEntry* pSource, SvTreeListEntry* pTargetParent, sal_uLong nListPos);
bool Remove( const SvTreeListEntry* pEntry );
void Clear();
bool HasChildren( const SvTreeListEntry* pEntry ) const;
bool HasParent( const SvTreeListEntry* pEntry ) const;
bool IsChild(const SvTreeListEntry* pParent, const SvTreeListEntry* pChild) const;
SvTreeListEntry* GetEntry( SvTreeListEntry* pParent, sal_uLong nPos ) const;
SvTreeListEntry* GetEntry( sal_uLong nRootPos ) const;
SvTreeListEntry* GetEntryAtAbsPos( sal_uLong nAbsPos ) const;
const SvTreeListEntry* GetParent( const SvTreeListEntry* pEntry ) const;
SvTreeListEntry* GetParent( SvTreeListEntry* pEntry );
SvTreeListEntry* GetRootLevelParent( SvTreeListEntry* pEntry ) const;
const SvTreeListEntries& GetChildList( SvTreeListEntry* pParent ) const;
SvTreeListEntries& GetChildList( SvTreeListEntry* pParent );
std::pair<SvTreeListEntries::iterator, SvTreeListEntries::iterator>
GetChildIterators(SvTreeListEntry* pParent);
sal_uLong GetAbsPos( const SvTreeListEntry* pEntry ) const;
sal_uLong GetRelPos( const SvTreeListEntry* pChild ) const;
sal_uLong GetChildCount( const SvTreeListEntry* pParent ) const;
sal_uInt16 GetDepth( const SvTreeListEntry* pEntry ) const;
bool IsAtRootDepth( const SvTreeListEntry* pEntry ) const;
// The Model calls the Clone Link to clone Entries.
// Thus we do not need to derive from the Model if we derive from SvTreeListEntry.
// Declaration of the Clone Handler:
// DECL_LINK(CloneHdl,SvTreeListEntry*);
// The Handler needs to return a SvTreeListEntry*
SvTreeListEntry* Clone( SvTreeListEntry* pEntry, sal_uLong& nCloneCount ) const;
void SetCloneLink( const Link& rLink )
{ aCloneLink=rLink; }
const Link& GetCloneLink() const
{ return aCloneLink; }
virtual SvTreeListEntry* CloneEntry( SvTreeListEntry* pSource ) const; // Calls the Clone Link
virtual SvTreeListEntry* CreateEntry() const; // To create Entries
sal_uInt16 GetRefCount() const { return nRefCount; }
void SetRefCount( sal_uInt16 nRef ) { nRefCount = nRef; }
void SetSortMode( SvSortMode eMode ) { eSortMode = eMode; }
SvSortMode GetSortMode() const { return eSortMode; }
StringCompare Compare(const SvTreeListEntry* pLeft, const SvTreeListEntry* pRight) const;
void SetCompareHdl( const Link& rLink ) { aCompareLink = rLink; }
const Link& GetCompareHdl() const { return aCompareLink; }
void Resort();
};
class SVT_DLLPUBLIC SvListView
{
friend class SvTreeList;
typedef boost::ptr_map<SvTreeListEntry*, SvViewDataEntry> SvDataTable;
sal_uLong nVisibleCount;
sal_uLong nSelectionCount;
sal_Bool bVisPositionsValid;
SVT_DLLPRIVATE void InitTable();
SVT_DLLPRIVATE void RemoveViewData( SvTreeListEntry* pParent );
SvDataTable maDataTable; // Mapping SvTreeListEntry -> ViewData
void ActionMoving( SvTreeListEntry* pEntry,SvTreeListEntry* pTargetPrnt,sal_uLong nChildPos);
void ActionMoved( SvTreeListEntry* pEntry,SvTreeListEntry* pTargetPrnt,sal_uLong nChildPos);
void ActionInserted( SvTreeListEntry* pEntry );
void ActionInsertedTree( SvTreeListEntry* pEntry );
void ActionRemoving( SvTreeListEntry* pEntry );
void ActionRemoved( SvTreeListEntry* pEntry );
void ActionClear();
protected:
SvTreeList* pModel;
public:
SvListView(); // Sets the Model to 0
virtual ~SvListView();
void Clear();
virtual void SetModel( SvTreeList* );
virtual void ModelNotification(
sal_uInt16 nActionId,
SvTreeListEntry* pEntry1,
SvTreeListEntry* pEntry2,
sal_uLong nPos
);
sal_uLong GetVisibleCount() const
{ return pModel->GetVisibleCount( (SvListView*)this ); }
SvTreeListEntry* FirstVisible() const
{ return pModel->FirstVisible(); }
SvTreeListEntry* NextVisible( SvTreeListEntry* pEntry, sal_uInt16* pDepth=0 ) const
{ return pModel->NextVisible(this,pEntry,pDepth); }
SvTreeListEntry* PrevVisible( SvTreeListEntry* pEntry, sal_uInt16* pDepth=0 ) const
{ return pModel->PrevVisible(this,pEntry,pDepth); }
SvTreeListEntry* LastVisible( sal_uInt16* pDepth=0 ) const
{ return pModel->LastVisible(this,pDepth); }
SvTreeListEntry* NextVisible( SvTreeListEntry* pEntry, sal_uInt16& rDelta ) const
{ return pModel->NextVisible(this,pEntry,rDelta); }
SvTreeListEntry* PrevVisible( SvTreeListEntry* pEntry, sal_uInt16& rDelta ) const
{ return pModel->PrevVisible(this,pEntry,rDelta); }
sal_uLong GetSelectionCount() const
{ return nSelectionCount; }
SvTreeListEntry* FirstSelected() const
{ return pModel->FirstSelected(this); }
SvTreeListEntry* NextSelected( SvTreeListEntry* pEntry ) const
{ return pModel->NextSelected(this,pEntry); }
SvTreeListEntry* PrevSelected( SvTreeListEntry* pEntry ) const
{ return pModel->PrevSelected(this,pEntry); }
SvTreeListEntry* LastSelected() const
{ return pModel->LastSelected(this); }
SvTreeListEntry* GetEntryAtAbsPos( sal_uLong nAbsPos ) const
{ return pModel->GetEntryAtAbsPos(nAbsPos); }
SvTreeListEntry* GetEntryAtVisPos( sal_uLong nVisPos ) const
{ return pModel->GetEntryAtVisPos((SvListView*)this,nVisPos); }
sal_uLong GetAbsPos( SvTreeListEntry* pEntry ) const
{ return pModel->GetAbsPos(pEntry); }
sal_uLong GetVisiblePos( SvTreeListEntry* pEntry ) const
{ return pModel->GetVisiblePos((SvListView*)this,pEntry); }
sal_uLong GetVisibleChildCount(SvTreeListEntry* pParent ) const
{ return pModel->GetVisibleChildCount((SvListView*)this,pParent); }
sal_uLong GetChildSelectionCount( SvTreeListEntry* pParent ) const
{ return pModel->GetChildSelectionCount((SvListView*)this,pParent); }
void Expand( SvTreeListEntry* pParent )
{ pModel->Expand((SvListView*)this,pParent); }
void Collapse( SvTreeListEntry* pParent )
{ pModel->Collapse((SvListView*)this,pParent); }
sal_Bool Select( SvTreeListEntry* pEntry, sal_Bool bSelect=sal_True )
{ return pModel->Select((SvListView*)this,pEntry,bSelect); }
// Does not call the Select Handler
virtual void SelectAll( sal_Bool bSelect, sal_Bool )
{ pModel->SelectAll((SvListView*)this, bSelect); }
sal_Bool IsEntryVisible( SvTreeListEntry* pEntry ) const
{ return pModel->IsEntryVisible((SvListView*)this,pEntry); }
sal_Bool IsExpanded( SvTreeListEntry* pEntry ) const;
sal_Bool IsSelected( SvTreeListEntry* pEntry ) const;
void SetEntryFocus( SvTreeListEntry* pEntry, sal_Bool bFocus );
const SvViewDataEntry* GetViewData( const SvTreeListEntry* pEntry ) const;
SvViewDataEntry* GetViewData( SvTreeListEntry* pEntry );
sal_Bool HasViewData() const
{ return maDataTable.size() > 1; } // There's always a ROOT
virtual SvViewDataEntry* CreateViewData( SvTreeListEntry* pEntry );
virtual void InitViewData( SvViewDataEntry*, SvTreeListEntry* pEntry );
virtual void ModelHasCleared();
virtual void ModelHasInserted( SvTreeListEntry* pEntry );
virtual void ModelHasInsertedTree( SvTreeListEntry* pEntry );
virtual void ModelIsMoving(
SvTreeListEntry* pSource,
SvTreeListEntry* pTargetParent,
sal_uLong nPos
);
virtual void ModelHasMoved( SvTreeListEntry* pSource );
virtual void ModelIsRemoving( SvTreeListEntry* pEntry );
virtual void ModelHasRemoved( SvTreeListEntry* pEntry );
virtual void ModelHasEntryInvalidated( SvTreeListEntry* pEntry );
};
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
