sw/source/core/inc/ascharanchoredobjectposition.hxx

   1  /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: ascharanchoredobjectposition.hxx,v $
  10  * $Revision: 1.7 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef _ASCHARANCHOREDOBJECTPOSITION_HXX
  31 #define _ASCHARANCHOREDOBJECTPOSITION_HXX
  32 #include <anchoredobjectposition.hxx>
  33 #include <sal/types.h>
  34 #include <swtypes.hxx>
  35 #include <swrect.hxx>
  36
  37 class SwTxtFrm;
  38 class SwFmtVertOrient;
  39
  40 namespace objectpositioning
  41 {
  42     // flags for positioning algorithm of as-character-anchored objects
  43     typedef sal_uInt8 AsCharFlags;
  44     #define AS_CHAR_NOFLAG  0
  45     #define AS_CHAR_QUICK   1
  46     #define AS_CHAR_ULSPACE 2
  47     #define AS_CHAR_INIT    4
  48     #define AS_CHAR_ROTATE  8
  49     #define AS_CHAR_REVERSE 16
  50     #define AS_CHAR_BIDI    32
  51
  52     class SwAsCharAnchoredObjectPosition : public SwAnchoredObjectPosition
  53     {
  54         private:
  55          // data to calculate object position
  56             // proposed anchor position, starting point for the calculation
  57             // of the object position
  58             const Point& mrProposedAnchorPos;
  59             // flags that influences the calculation of the anchor position
  60             // AS_CHAR_QUICK   : quick formatting - calculated position not set at object
  61             // AS_CHAR_ULSPACE : consider upper/lower spacing - adjustment of anchor position
  62             // AS_CHAR_INIT    : initial calculation
  63             // AS_CHAR_ROTATE  : object is rotated by 90 degrees
  64             // AS_CHAR_REVERSE : object is reversed (rotated by 270 degrees)
  65             // AS_CHAR_BIDI    : object belongs to a BIDI-multi-portion
  66             const AsCharFlags mnFlags;
  67             // needed line values for the different alignments.
  68             const SwTwips mnLineAscent;
  69             const SwTwips mnLineDescent;
  70             const SwTwips mnLineAscentInclObjs;
  71             const SwTwips mnLineDescentInclObjs;
  72
  73          // calculated data for object position
  74             Point       maAnchorPos;
  75             SwTwips     mnRelPos;
  76             SwRect      maObjBoundRect;
  77             // line alignment relative to line height; gives feedback for line formatting
  78             // 0 - no line alignment, 1 - at top, 2 - at center, 3 - at bottom
  79             sal_uInt8   mnLineAlignment;
  80
  81             // method to cast <SwAnchoredObjectPosition::GetAnchorFrm()>
  82             const SwTxtFrm& GetAnchorTxtFrm() const;
  83
  84             /** determine the relative position to base line for object position
  85
  86                 @author OD
  87
  88                 @param _ObjBoundHeight
  89                 height including corresponding spacing of the object, for which
  90                 the Y-position has to be calculated.
  91
  92                 @param _rVert
  93                 given vertical positioning and alignment
  94
  95                 @return relative position to the base line
  96             */
  97             SwTwips _GetRelPosToBase( const SwTwips          _nObjBoundHeight,
  98                                       const SwFmtVertOrient& _rVert );
  99
 100         // *********************************************************************
 101         public:
 102             /** construtor; provided object to be positioned and needed data
 103                 for calculation of the object position
 104
 105                 OD 28.10.2003 #110978#
 106
 107                 @param _rDrawObj
 108                 input parameter - object, that is be positioned.
 109
 110                 @param _rProposedAnchorPos
 111                 proposed anchor position; starting point for the calculation
 112                 of the anchor position
 113
 114                 @param _nFlags
 115                 flags that influences the calculation of the anchor position
 116                 AS_CHAR_QUICK   : quick formatting - calculated position not set at object
 117                 AS_CHAR_ULSPACE : consider upper/lower spacing - adjustment of anchor position
 118                 AS_CHAR_INIT    : initial calculation
 119                 AS_CHAR_ROTATE  : object is rotated by 90 degrees
 120                 AS_CHAR_REVERSE : object is reversed (rotated by 270 degrees)
 121                 AS_CHAR_BIDI    : object belongs to a BIDI-multi-portion
 122
 123                 @param _nLineAscent, _nLineDescent, _nLineAscentInclObjs,
 124                 _nLineDescentInclObjs - needed line values for the different
 125                 alignments.
 126
 127                 @author OD
 128             */
 129             SwAsCharAnchoredObjectPosition( SdrObject&      _rDrawObj,
 130                                             const Point&    _rProposedAnchorPos,
 131                                             const AsCharFlags _nFlags,
 132                                             const SwTwips     _nLineAscent,
 133                                             const SwTwips     _nLineDescent,
 134                                             const SwTwips     _nLineAscentInclObjs,
 135                                             const SwTwips     _nLineDescentInclObjs );
 136             virtual ~SwAsCharAnchoredObjectPosition();
 137
 138             /** calculate position for object position
 139
 140                 members <maAnchorPos>, <mnRelPos>, <maObjBoundRect> and
 141                 <mnLineAlignment> are calculated.
 142                 calculated position is set at the given object.
 143
 144                 @author OD
 145             */
 146             virtual void CalcPosition();
 147
 148             /** calculated anchored position for object position type AS_CHAR
 149
 150                 @author OD
 151             */
 152             Point GetAnchorPos() const;
 153
 154             /** calculated relative position to base line for object position type AS_CHAR
 155
 156                 @author OD
 157             */
 158             SwTwips GetRelPosY() const;
 159
 160             /** determined object rectangle including spacing for object position type AS_CHAR
 161
 162                 @author OD
 163             */
 164             SwRect GetObjBoundRectInclSpacing() const;
 165
 166             /** determined line alignment relative to line height
 167
 168                 @author OD
 169             */
 170             sal_uInt8 GetLineAlignment() const;
 171     };
 172 } // namespace objectpositioning
 173
 174 #endif