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
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
|
/* -*- 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 _ANCHOREDOBJECTPOSITION_HXX
#define _ANCHOREDOBJECTPOSITION_HXX
#include <swtypes.hxx>
// #i11860#
#include <frame.hxx>
class SdrObject;
class SwFrm;
class SwFlyFrm;
class SwContact;
class SwFrmFmt;
class SwRect;
class SvxLRSpaceItem;
class SvxULSpaceItem;
class SwFmtHoriOrient;
// #i26701#
class SwAnchoredObject;
namespace objectpositioning
{
class SwEnvironmentOfAnchoredObject;
class SwAnchoredObjectPosition
{
private:
// object to be positioned
SdrObject& mrDrawObj;
// information about object
// does the object represents a Writer fly frame
bool mbIsObjFly;
// #i26791# - anchored object the object belongs to;
SwAnchoredObject* mpAnchoredObj;
// frame the object is anchored at
SwFrm* mpAnchorFrm;
// contact object
SwContact* mpContact;
// frame format
const SwFrmFmt* mpFrmFmt;
// #i62875#
bool mbFollowTextFlow;
// #i62875#
// for compatibility option <DoNotCaptureDrawObjsOnPage>
bool mbDoNotCaptureAnchoredObj;
/** determine information about object
member <mbIsObjFly>, <mpAnchoredObj>, <mpAnchorFrm>, <mpContact>
and <mpFrmFmt> are set
*/
void _GetInfoAboutObj();
// #i62875#
// --> OD 2009-09-01 #mongolianlayout# - add parameter <bVertL2R>
SwTwips _ImplAdjustVertRelPos( const SwTwips nTopOfAnch,
const bool bVert,
const bool bVertL2R,
const SwFrm& rPageAlignLayFrm,
const SwTwips nProposedRelPosY,
const bool bFollowTextFlow,
const bool bCheckBottom = true ) const;
SwTwips _ImplAdjustHoriRelPos( const SwFrm& _rPageAlignLayFrm,
const SwTwips _nProposedRelPosX ) const;
protected:
SwAnchoredObjectPosition( SdrObject& _rDrawObj );
virtual ~SwAnchoredObjectPosition();
// accessors for object and its corresponding data/information
inline SdrObject& GetObject() const
{
return mrDrawObj;
}
inline bool IsObjFly() const
{
return mbIsObjFly;
}
inline SwAnchoredObject& GetAnchoredObj() const
{
return *mpAnchoredObj;
}
inline SwFrm& GetAnchorFrm() const
{
return *mpAnchorFrm;
}
inline SwContact& GetContact() const
{
return *mpContact;
}
inline const SwFrmFmt& GetFrmFmt() const
{
return *mpFrmFmt;
}
// #i62875#
inline bool DoesObjFollowsTextFlow() const
{
return mbFollowTextFlow;
}
// virtual methods providing data for to character anchored objects.
virtual bool IsAnchoredToChar() const;
virtual const SwFrm* ToCharOrientFrm() const;
virtual const SwRect* ToCharRect() const;
// #i22341#
virtual SwTwips ToCharTopOfLine() const;
// *********************************************************************
/** helper method to determine top of a frame for the vertical
object positioning
#i11860#
*/
SwTwips _GetTopForObjPos( const SwFrm& _rFrm,
const SwRectFn& _fnRect,
const bool _bVert ) const;
// *********************************************************************
void _GetVertAlignmentValues( const SwFrm& _rVertOrientFrm,
const SwFrm& _rPageAlignLayFrm,
const sal_Int16 _eRelOrient,
SwTwips& _orAlignAreaHeight,
SwTwips& _orAlignAreaOffset ) const;
// *********************************************************************
// #i26791# - add output parameter <_roVertOffsetToFrmAnchorPos>
SwTwips _GetVertRelPos( const SwFrm& _rVertOrientFrm,
const SwFrm& _rPageAlignLayFrm,
const sal_Int16 _eVertOrient,
const sal_Int16 _eRelOrient,
const SwTwips _nVertPos,
const SvxLRSpaceItem& _rLRSpacing,
const SvxULSpaceItem& _rULSpacing,
SwTwips& _roVertOffsetToFrmAnchorPos ) const;
// *********************************************************************
/** adjust calculated vertical in order to keep object inside
'page' alignment layout frame.
#i31805# - add parameter <_bCheckBottom>
#i26945# - add parameter <_bFollowTextFlow>
#i62875# - made inline, intrinsic actions moved
to private method <_ImplAdjustVertRelPos>, which is only
called, if <mbDoNotCaptureAnchoredObj> not set.
OD 2009-09-01 #mongolianlayout# - add parameter <bVertL2R>
@param nTopOfAnch
input parameter - 'vertical' position, at which the relative
position of the object is calculated from.
@param bVert
input parameter - boolean, indicating, if object is in vertical
layout.
@param bVertL2R
input parameter - boolean, indicating, if object is in mongolian
layout (vertical left-to-right layout).
@param rPageAlignLayFrm
input parameter - layout frame, which determines the 'page area'
the object has to be vertical positioned in.
@param nProposedRelPosY
input parameter - proposed relative vertical position, which
will be adjusted.
@param bFollowTextFlow
input parameter - value of attribute 'Follow text flow' of the
anchored object.
@param bCheckBottom
input parameter - boolean indicating, if bottom of anchored
object has to be checked and thus, (if needed) the proposed
relative position has to be adjusted. default value <true>
*/
inline SwTwips _AdjustVertRelPos( const SwTwips nTopOfAnch,
const bool bVert,
const bool bVertL2R,
const SwFrm& rPageAlignLayFrm,
const SwTwips nProposedRelPosY,
const bool bFollowTextFlow,
const bool bCheckBottom = true ) const
{
return !mbDoNotCaptureAnchoredObj
? _ImplAdjustVertRelPos( nTopOfAnch, bVert, bVertL2R,
rPageAlignLayFrm,
nProposedRelPosY,
bFollowTextFlow,
bCheckBottom )
: nProposedRelPosY;
}
// *********************************************************************
/** calculate relative horizontal position
#i26791# - add output parameter
<_roHoriOffsetToFrmAnchorPos>
@param _rHoriOrientFrm
input parameter - frame the horizontal position of the object
is oriented at.
@param _rEnvOfObj
input parameter - object instance to retrieve environment
information about the object
@param _rHoriOrient
input parameter - horizontal positioning and alignment, for which
the relative position is calculated.
@param _rLRSpacing
input parameter - left and right spacing of the object to the text
@param _rULSpacing
input parameter - upper and lower spacing of the object to the text
@param _bObjWrapThrough
input parameter - boolean indicating, if object has wrap mode
'wrap through'.
@param _nRelPosY
input parameter - relative vertical position
@param _roHoriOffsetToFrmAnchorPos
output parameter - 'horizontal' offset to frame anchor position
according to the alignment
@return relative horizontal position in SwTwips
*/
SwTwips _CalcRelPosX( const SwFrm& _rHoriOrientFrm,
const SwEnvironmentOfAnchoredObject& _rEnvOfObj,
const SwFmtHoriOrient& _rHoriOrient,
const SvxLRSpaceItem& _rLRSpacing,
const SvxULSpaceItem& _rULSpacing,
const bool _bObjWrapThrough,
const SwTwips _nRelPosY,
SwTwips& _roHoriOffsetToFrmAnchorPos
) const;
// *********************************************************************
/** adjust calculated horizontal in order to keep object inside
'page' alignment layout frame for object type position TO_CNTNT
#i62875# - made inline, intrinsic actions moved
to private method <_ImplAdjustHoriRelPos>, which is only
called, if <mbDoNotCaptureAnchoredObj> not set.
@param _rPageAlignLayFrm
input paramter - layout frame, which determines the 'page area'
the object has to be horizontal positioned in.
@param _nProposedRelPosX
input parameter - proposed relative horizontal position, which
will be adjusted.
@return adjusted relative horizontal position in SwTwips.
*/
inline SwTwips _AdjustHoriRelPos( const SwFrm& _rPageAlignLayFrm,
const SwTwips _nProposedRelPosX ) const
{
return !mbDoNotCaptureAnchoredObj
? _ImplAdjustHoriRelPos( _rPageAlignLayFrm, _nProposedRelPosX )
: _nProposedRelPosX;
}
// *********************************************************************
/** toggle given horizontal orientation and relative alignment
@param _bToggleLeftRight
input parameter - boolean indicating, if horizontal orientation
and relative alignment has to be toggled.
@param _ioeHoriOrient
input/output parameter - horizontal orientation, that is toggled,
if needed.
@param _iopeRelOrient
optional input/output parameter (default value NULL)
- if set, relative alignment, that is toggled, if needed.
*/
void _ToggleHoriOrientAndAlign( const bool _bToggleLeftRight,
sal_Int16& _ioeHoriOrient,
sal_Int16& _iopeRelOrient
) const;
// *********************************************************************
/** determine alignment values for horizontal position of object
@param _rHoriOrientFrm
input parameter - frame the horizontal position of the object
is oriented at.
@param _rPageAlignLayFrm
input paramter - layout frame, which determines the 'page area'
the object has to be horizontal positioned in.
@param _eRelOrient
input parameter - horizontal relative alignment, for which
the relative position is calculated.
@param _bToggleLeftRight
input parameter - boolean indicating, if left/right alignments
have to be toggled.
@param _bObjWrapThrough
input parameter - boolean indicating, if object has wrap mode
'wrap through'.
important note: value is only relevant, if _rHoriOrientFrm is
a text frame.
@param _orAlignAreaWidth
output parameter - width in SwTwips of the area the horizontal
position is aligned to.
@param _orAlignAreaOffset
output parameter - offset in SwTwips of the area the horizontal
position is aligned to. offset is given to the 'left' of the
anchor position.
@param _obAlignedRelToPage
output parameter - boolean indicating, that object is aligned
to 'page area'.
*/
void _GetHoriAlignmentValues( const SwFrm& _rHoriOrientFrm,
const SwFrm& _rPageAlignLayFrm,
const sal_Int16 _eRelOrient,
const bool _bObjWrapThrough,
SwTwips& _orAlignAreaWidth,
SwTwips& _orAlignAreaOffset,
bool& _obAlignedRelToPage ) const;
// *********************************************************************
/** adjust calculated horizontal position in order to draw object
aside other objects with same positioning
@param _rHoriOrientFrm
input parameter - frame the horizontal position of the object
is oriented at.
@param _nProposedRelPosX
input parameter - proposed relative horizontal position, which
will be adjusted.
@param _nRelPosY
input parameter - relative vertical position
@param _eHoriOrient
input parameter - horizontal position of object
@param _eRelOrient
inpt parameter - alignment of object
@param _rLRSpacing
input parameter - left and right spacing of the object to the text
@param _rULSpacing
input parameter - upper and lower spacing of the object to the text
@param _bEvenPage
input parameter - boolean indicating, if object is on an even page.
@return adjusted relative horizontal position in SwTwips
*/
SwTwips _AdjustHoriRelPosForDrawAside( const SwFrm& _rHoriOrientFrm,
const SwTwips _nProposedRelPosX,
const SwTwips _nRelPosY,
const sal_Int16 _eHoriOrient,
const sal_Int16 _eRelOrient,
const SvxLRSpaceItem& _rLRSpacing,
const SvxULSpaceItem& _rULSpacing,
const bool _bEvenPage
) const;
// *********************************************************************
/** detemine, if object has to draw aside given fly frame
method used by <_AdjustHoriRelPosForDrawAside(..)>
@param _pFly
input parameter - fly frame the draw aside check is done for.
@param _rObjRect
input parameter - proposed object rectangle
@param _pObjContext
input parameter - context of the object
@param _nObjIndex
input parameter - index of the anchor frame of the object
@param _bEvenPage
input parameter - boolean indicating, if object is on an even page.
@param _eHoriOrient
input parameter - horizontal position of object
@param _eRelOrient
inpt parameter - alignment of object
@return boolean indicating, if object has to be drawn aside
given fly frame.
*/
bool _DrawAsideFly( const SwFlyFrm* _pFly,
const SwRect& _rObjRect,
const SwFrm* _pObjContext,
const sal_uLong _nObjIndex,
const bool _bEvenPage,
const sal_Int16 _eHoriOrient,
const sal_Int16 _eRelOrient
) const;
// *********************************************************************
/** determine, if object has to draw aside another object
the different alignments of the objects determines, if one has
to draw aside another one. Thus, the given alignment are checked
against each other, which one has to be drawn aside the other one.
depending on parameter _bLeft check is done for left or right
positioning.
method used by <_DrawAsideFly(..)>
@param _eRelOrient1
input parameter - alignment 1
@param _eRelOrient2
input parameter - alignment 2
@param _bLeft
input parameter - boolean indicating, if check is done for left
or for right positioning.
@return boolean indicating, if an object with an alignment
<_eRelOrient1> has to be drawn aside an object with an
alignment <_eRelOrient2>
*/
bool _Minor( sal_Int16 _eRelOrient1,
sal_Int16 _eRelOrient2,
bool _bLeft ) const;
public:
virtual void CalcPosition() = 0;
};
} // namespace objectpositioning
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
