binfilter/inc/bf_sw/frmfmt.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: frmfmt.hxx,v $
  10  * $Revision: 1.8 $
  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 _FRMFMT_HXX
  31 #define _FRMFMT_HXX
  32
  33 #ifndef _FORMAT_HXX
  34 #include <format.hxx>
  35 #endif
  36 class Graphic;
  37 class Point;
  38
  39 namespace binfilter {
  40
  41 class ImageMap;
  42 class SwDrawContact;
  43 class SwFlyFrm;
  44 class IMapObject;
  45 class SwRect;
  46 class SwContact;
  47 class SdrObject;
  48
  49 class SwFrmFmt: public SwFmt
  50 {
  51     friend class SwDoc;
  52     friend class SwPageDesc;    //darf den protected CTor rufen.
  53     friend class SwSwgReader;   // der SW2-Reader auch!
  54     friend class Sw3IoImp;              // der SW3-Reader auch!
  55
  56 protected:
  57     SwFrmFmt( SwAttrPool& rPool, const sal_Char* pFmtNm,
  58                 SwFrmFmt *pDrvdFrm, USHORT nFmtWhich = RES_FRMFMT,
  59                 const USHORT* pWhichRange = 0 )
  60           : SwFmt( rPool, pFmtNm, (pWhichRange ? pWhichRange : aFrmFmtSetRange),
  61                 pDrvdFrm, nFmtWhich )
  62     {}
  63
  64     SwFrmFmt( SwAttrPool& rPool, const String &rFmtNm,
  65                 SwFrmFmt *pDrvdFrm, USHORT nFmtWhich = RES_FRMFMT,
  66                 const USHORT* pWhichRange = 0 )
  67           : SwFmt( rPool, rFmtNm, (pWhichRange ? pWhichRange : aFrmFmtSetRange),
  68                 pDrvdFrm, nFmtWhich )
  69     {}
  70
  71 public:
  72     TYPEINFO();         //Bereits in Basisklasse Client drin.
  73
  74     //Vernichtet alle Frms in aDepend (Frms werden per PTR_CAST erkannt).
  75     virtual void DelFrms();
  76
  77     //Erzeugt die Ansichten
  78     virtual void MakeFrms();
  79
  80
  81     virtual void Modify( SfxPoolItem* pOldValue, SfxPoolItem* pNewValue );
  82
  83     // returnt das IMapObject, das an dem Format (Fly), in der ImageMap
  84     // an der Point Position definiert ist.
  85     //  rPoint - teste auf der DocPosition
  86     //  pFly - optionaler FlyFrame, falls der schon bekannt ist.
  87
  88     // Gibt die tatsaechlche Groesse des Frames zurueck bzw. ein leeres
  89     // Rechteck, wenn kein Layout existiert. Wird pPoint angegeben, dann
  90     // wird der am dichtesten liegende Frame gesucht.
  91     SwRect FindLayoutRect( const BOOL bPrtArea = FALSE,
  92                             const Point* pPoint = 0,
  93                             const BOOL bCalcFrm = FALSE ) const;
  94
  95     // Sucht das SdrObject. Der SdrObjUserCall ist Client vom Format.
  96     // Der UserCall kennt sein SdrObject.
  97           SwContact *FindContactObj();
  98     const SwContact *FindContactObj() const
  99         { return ((SwFrmFmt*)this)->FindContactObj(); }
 100
 101     // returns the SdrObject, that ist connected to the ContactObject.
 102     // Only DrawFrmFmts are connected to the "real SdrObject". FlyFrmFmts
 103     // are connected to a Master and all FlyFrms has the "real SdrObject".
 104     // "Real SdrObject" has position and a Z-order.
 105           SdrObject *FindSdrObject();
 106     const SdrObject *FindSdrObject() const
 107         { return ((SwFrmFmt*)this)->FindSdrObject(); }
 108
 109           SdrObject *FindRealSdrObject();
 110     const SdrObject *FindRealSdrObject() const
 111         { return ((SwFrmFmt*)this)->FindRealSdrObject(); }
 112
 113
 114     DECL_FIXEDMEMPOOL_NEWDEL(SwFrmFmt)
 115 };
 116
 117 //Das FlyFrame-Format ------------------------------
 118
 119 class SwFlyFrmFmt: public SwFrmFmt
 120 {
 121     friend class SwDoc;
 122
 123     //Beide nicht vorhanden.
 124     SwFlyFrmFmt( const SwFlyFrmFmt &rCpy );
 125     SwFlyFrmFmt &operator=( const SwFlyFrmFmt &rCpy );
 126
 127 protected:
 128     SwFlyFrmFmt( SwAttrPool& rPool, const sal_Char* pFmtNm,
 129                     SwFrmFmt *pDrvdFrm )
 130         : SwFrmFmt( rPool, pFmtNm, pDrvdFrm, RES_FLYFRMFMT )
 131     {}
 132     SwFlyFrmFmt( SwAttrPool& rPool, const String &rFmtNm,
 133                     SwFrmFmt *pDrvdFrm )
 134         : SwFrmFmt( rPool, rFmtNm, pDrvdFrm, RES_FLYFRMFMT )
 135     {}
 136
 137 public:
 138     TYPEINFO();
 139     ~SwFlyFrmFmt();
 140
 141     //Erzeugt die Ansichten
 142     virtual void MakeFrms();
 143
 144     SwFlyFrm* GetFrm( const Point* pDocPos = 0,
 145                         const BOOL bCalcFrm = FALSE ) const;
 146
 147
 148     virtual BOOL GetInfo( SfxPoolItem& rInfo ) const;
 149
 150     /** SwFlyFrmFmt::IsBackgroundTransparent - for #99657#
 151
 152         OD 22.08.2002 - overloading virtual method and its default implementation,
 153         because format of fly frame provides transparent backgrounds.
 154         Method determines, if background of fly frame is transparent.
 155
 156         @author OD
 157
 158         @return true, if background color is transparent, but not "no fill"
 159         or a existing background graphic is transparent.
 160     */
 161     virtual const sal_Bool IsBackgroundTransparent() const;
 162
 163     /** SwFlyFrmFmt::IsBackgroundBrushInherited - for #103898#
 164
 165         OD 08.10.2002 - method to determine, if the brush for drawing the
 166         background is "inherited" from its parent/grandparent.
 167         This is the case, if no background graphic is set and the background
 168         color is "no fill"/"auto fill"
 169
 170         @author OD
 171
 172         @return true, if background brush is "inherited" from parent/grandparent
 173     */
 174     const sal_Bool IsBackgroundBrushInherited() const;
 175
 176     DECL_FIXEDMEMPOOL_NEWDEL(SwFlyFrmFmt)
 177 };
 178
 179 //Das DrawFrame-Format -----------------------------
 180
 181 class SwDrawFrmFmt: public SwFrmFmt
 182 {
 183     friend class SwDoc;
 184
 185     //Beide nicht vorhanden.
 186     SwDrawFrmFmt( const SwDrawFrmFmt &rCpy );
 187     SwDrawFrmFmt &operator=( const SwDrawFrmFmt &rCpy );
 188
 189 protected:
 190     SwDrawFrmFmt( SwAttrPool& rPool, const sal_Char* pFmtNm,
 191                     SwFrmFmt *pDrvdFrm )
 192         : SwFrmFmt( rPool, pFmtNm, pDrvdFrm, RES_DRAWFRMFMT )
 193     {}
 194     SwDrawFrmFmt( SwAttrPool& rPool, const String &rFmtNm,
 195                     SwFrmFmt *pDrvdFrm )
 196         : SwFrmFmt( rPool, rFmtNm, pDrvdFrm, RES_DRAWFRMFMT )
 197     {}
 198
 199 public:
 200     TYPEINFO();
 201     ~SwDrawFrmFmt();
 202
 203     //DrawObjecte werden aus den Arrays am Layout entfernt. Die DrawObjecte
 204     //werden als geloescht gekennzeichnet.
 205     virtual void DelFrms();
 206
 207     //Anmelden der DrawObjecte in den Arrays am Layout. Loeschkennzeichen
 208     //werden zurueckgesetzt.
 209     virtual void MakeFrms();
 210
 211
 212
 213     DECL_FIXEDMEMPOOL_NEWDEL(SwDrawFrmFmt);
 214 };
 215
 216
 217 } //namespace binfilter
 218 #endif
 219