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
|
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2008 by Sun Microsystems, Inc.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* $RCSfile: sortedobjs.hxx,v $
* $Revision: 1.5 $
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org 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 Lesser General Public License version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
*
************************************************************************/
#ifndef _SORTEDOBJS_HXX
#define _SORTEDOBJS_HXX
class SwSortedObjsImpl;
class SwAnchoredObject;
#include <sal/types.h>
/** class for collecting anchored objects
for #i28701#
Anchored objects can be inserted and deleted. The entries can be directly
accessed via index.
An anchored object is inserted sorted. The sort criteria are:
- anchor type
- order 1: to-page, 2: to-fly, 3: to-paragraph|to-character|as-character
- anchor node
- wrapping style (inclusive layer)
- order 1: wrapping style != SURROUND_THROUGHT and not in hell layer,
2: wrapping style = SURROUND_THROUGHT or in hell layer
- wrapping style influence
- order 1: NONE_SUCCESSIVE_POSITIONED, 2: NONE_CONCURRENT_POSITIONED
- again anchor type
- order 1: to-paragraph, 2: to-character, 3: as-character
- anchor node position
- internal anchor order number
If one of the sort criteria attributes of an anchored object changes,
the sorting has to be updated - use method <Update(..)>
@author OD
*/
class SwSortedObjs
{
private:
SwSortedObjsImpl* mpImpl;
public:
SwSortedObjs();
~SwSortedObjs();
sal_uInt32 Count() const;
/** direct access to the entries
@param _nIndex
input parameter - index of entry, valid value range [0..Count()-1]
@author OD
*/
SwAnchoredObject* operator[]( sal_uInt32 _nIndex ) const;
bool Insert( SwAnchoredObject& _rAnchoredObj );
bool Remove( SwAnchoredObject& _rAnchoredObj );
bool Contains( const SwAnchoredObject& _rAnchoredObj ) const;
/** method to update the position of the given anchored object in the
sorted list
OD 2004-07-01
@author OD
@return boolean, indicating success of the update.
*/
bool Update( SwAnchoredObject& _rAnchoredObj );
/** Position of object <_rAnchoredObj> in sorted list
OD 2004-05-07
Returns the number of the list position of object <_rAnchoredObj>.
Returns <Count()>, if object isn't contained in list.
@author OD
@return sal_uInt32
Number of the list position of object <_rAnchoredObj>
*/
sal_uInt32 ListPosOf( const SwAnchoredObject& _rAnchoredObj ) const;
};
#endif
|
