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
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2000, 2010 Oracle and/or its affiliates.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* 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 _OBJECTFORMATTER_HXX
#define _OBJECTFORMATTER_HXX
#include <sal/types.h>
class SwFrm;
// --> OD 2004-10-08 #i26945#
class SwTxtFrm;
// <--
class SwLayoutFrm;
class SwPageFrm;
class SwAnchoredObject;
class SwLayAction;
// --> OD 2004-10-04 #i26945#
class SwPageNumAndTypeOfAnchors;
// <--
// -----------------------------------------------------------------------------
// OD 2004-06-25 #i28701#
// Format floating screen objects, which are anchored at the given anchor frame
// and registered at the given page frame.
// -----------------------------------------------------------------------------
class SwObjectFormatter
{
private:
// page frame, at which the floating screen objects are registered.
const SwPageFrm& mrPageFrm;
// boolean, indicating that only as-character anchored objects have to
// be formatted.
bool mbFormatOnlyAsCharAnchored;
// value of document compatibility option 'Consider wrapping style on
// object positioning'
const bool mbConsiderWrapOnObjPos;
// layout action calling the format of the floating screen objects
SwLayAction* mpLayAction;
// data structure to collect page number of object's 'anchor'
// --> OD 2004-10-04 #i26945#
SwPageNumAndTypeOfAnchors* mpPgNumAndTypeOfAnchors;
// <--
/** helper method for method <_FormatObj(..)> - performs the intrinsic
format of the layout of the given layout frame and all its lower
layout frames.
OD 2004-06-28 #i28701#
IMPORTANT NOTE:
Method corresponds to methods <SwLayAction::FormatLayoutFly(..)> and
<SwLayAction::FormatLayout(..)>. Thus, its code for the formatting have
to be synchronised.
@author OD
*/
void _FormatLayout( SwLayoutFrm& _rLayoutFrm );
/** helper method for method <_FormatObj(..)> - performs the intrinsic
format of the content of the given floating screen object.
OD 2004-06-28 #i28701#
@author OD
*/
void _FormatObjCntnt( SwAnchoredObject& _rAnchoredObj );
protected:
SwObjectFormatter( const SwPageFrm& _rPageFrm,
SwLayAction* _pLayAction = 0L,
const bool _bCollectPgNumOfAnchors = false );
static SwObjectFormatter* CreateObjFormatter( SwFrm& _rAnchorFrm,
const SwPageFrm& _rPageFrm,
SwLayAction* _pLayAction );
virtual SwFrm& GetAnchorFrm() = 0;
inline const SwPageFrm& GetPageFrm() const
{
return mrPageFrm;
}
inline bool ConsiderWrapOnObjPos() const
{
return mbConsiderWrapOnObjPos;
}
inline SwLayAction* GetLayAction()
{
return mpLayAction;
}
/** method to restrict the format of floating screen objects to
as-character anchored ones
@author OD
*/
inline void SetFormatOnlyAsCharAnchored()
{
mbFormatOnlyAsCharAnchored = true;
}
inline bool FormatOnlyAsCharAnchored() const
{
return mbFormatOnlyAsCharAnchored;
}
/** performs the intrinsic format of a given floating screen object and its content.
OD 2004-06-28 #i28701#
@author OD
*/
void _FormatObj( SwAnchoredObject& _rAnchoredObj );
/** invokes the intrinsic format method for all floating screen objects,
anchored at anchor frame on the given page frame
OD 2004-06-28 #i28701#
OD 2004-10-08 #i26945# - for format of floating screen objects for
follow text frames, the 'master' text frame is passed to the method.
Thus, the objects, whose anchor character is inside the follow text
frame can be formatted.
@author OD
@param _pMasterTxtFrm
input parameter - pointer to 'master' text frame. default value: NULL
*/
bool _FormatObjsAtFrm( SwTxtFrm* _pMasterTxtFrm = 0L );
/** accessor to collected anchored object
OD 2004-07-05 #i28701#
@author OD
*/
SwAnchoredObject* GetCollectedObj( const sal_uInt32 _nIndex );
/** accessor to 'anchor' page number of collected anchored object
OD 2004-07-05 #i28701#
@author OD
*/
sal_uInt32 GetPgNumOfCollected( const sal_uInt32 _nIndex );
/** accessor to 'anchor' type of collected anchored object
OD 2004-10-04 #i26945#
@author OD
*/
bool IsCollectedAnchoredAtMaster( const sal_uInt32 _nIndex );
/** accessor to total number of collected anchored objects
OD 2004-07-05 #i28701#
@author OD
*/
sal_uInt32 CountOfCollected();
public:
virtual ~SwObjectFormatter();
/** intrinsic method to format a certain floating screen object
OD 2005-01-10 #i40147# - add parameter <_bCheckForMovedFwd>
@author OD
@param _rAnchoredObj
input parameter - anchored object, which have to be formatted.
@param _bCheckForMovedFwd
input parameter - boolean indicating, that after a successful
format of the anchored object the anchor frame has to be checked,
if it would moved forward due to the positioning of the anchored object.
default value: false
value only considered, if wrapping style influence has to be
considered for the positioning of the anchored object.
*/
virtual bool DoFormatObj( SwAnchoredObject& _rAnchoredObj,
const bool _bCheckForMovedFwd = false ) = 0;
/** intrinsic method to format all floating screen objects
@author OD
*/
virtual bool DoFormatObjs() = 0;
/** method to format all floating screen objects at the given anchor frame
@author OD
*/
static bool FormatObjsAtFrm( SwFrm& _rAnchorFrm,
const SwPageFrm& _rPageFrm,
SwLayAction* _pLayAction = 0L );
/** method to format a given floating screen object
@author OD
*/
static bool FormatObj( SwAnchoredObject& _rAnchoredObj,
SwFrm* _pAnchorFrm = 0L,
const SwPageFrm* _pPageFrm = 0L,
SwLayAction* _pLayAction = 0L );
};
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
