sw/inc/frmfmt.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27 #ifndef _FRMFMT_HXX
  28 #define _FRMFMT_HXX
  29
  30 // --> OD 2004-08-06 #i28749#
  31 #include <com/sun/star/text/PositionLayoutDir.hpp>
  32 // <--
  33
  34 #include <cppuhelper/weakref.hxx>
  35
  36 #include <format.hxx>
  37
  38 #include "swdllapi.h"
  39
  40 class SwFlyFrm;
  41 class SwAnchoredObject;
  42 class Graphic;
  43 class Point;
  44 class ImageMap;
  45 class IMapObject;
  46 class SwRect;
  47 class SwContact;
  48 class SdrObject;
  49
  50 class SW_DLLPUBLIC SwFrmFmt: public SwFmt
  51 {
  52     friend class SwDoc;
  53     friend class SwPageDesc;    //darf den protected CTor rufen.
  54
  55     ::com::sun::star::uno::WeakReference<
  56         ::com::sun::star::uno::XInterface> m_wXObject;
  57
  58 protected:
  59     SwFrmFmt( SwAttrPool& rPool, const sal_Char* pFmtNm,
  60                 SwFrmFmt *pDrvdFrm, USHORT nFmtWhich = RES_FRMFMT,
  61                 const USHORT* pWhichRange = 0 )
  62           : SwFmt( rPool, pFmtNm, (pWhichRange ? pWhichRange : aFrmFmtSetRange),
  63                 pDrvdFrm, nFmtWhich )
  64     {}
  65
  66     SwFrmFmt( SwAttrPool& rPool, const String &rFmtNm,
  67                 SwFrmFmt *pDrvdFrm, USHORT nFmtWhich = RES_FRMFMT,
  68                 const USHORT* pWhichRange = 0 )
  69           : SwFmt( rPool, rFmtNm, (pWhichRange ? pWhichRange : aFrmFmtSetRange),
  70                 pDrvdFrm, nFmtWhich )
  71     {}
  72
  73 public:
  74     TYPEINFO();     //Bereits in Basisklasse Client drin.
  75
  76     //Vernichtet alle Frms in aDepend (Frms werden per PTR_CAST erkannt).
  77     virtual void DelFrms();
  78
  79     //Erzeugt die Ansichten
  80     virtual void MakeFrms();
  81
  82     virtual Graphic MakeGraphic( ImageMap* pMap = NULL );
  83
  84     virtual void Modify( SfxPoolItem* pOldValue, SfxPoolItem* pNewValue );
  85
  86     // returnt das IMapObject, das an dem Format (Fly), in der ImageMap
  87     // an der Point Position definiert ist.
  88     //  rPoint - teste auf der DocPosition
  89     //  pFly - optionaler FlyFrame, falls der schon bekannt ist.
  90     IMapObject* GetIMapObject( const Point& rPoint,
  91                                 const SwFlyFrm *pFly = 0 ) const;
  92
  93     // Gibt die tatsaechlche Groesse des Frames zurueck bzw. ein leeres
  94     // Rechteck, wenn kein Layout existiert. Wird pPoint angegeben, dann
  95     // wird der am dichtesten liegende Frame gesucht.
  96     SwRect FindLayoutRect( const BOOL bPrtArea = FALSE,
  97                             const Point* pPoint = 0,
  98                             const BOOL bCalcFrm = FALSE ) const;
  99
 100     // Sucht das SdrObject. Der SdrObjUserCall ist Client vom Format.
 101     // Der UserCall kennt sein SdrObject.
 102           SwContact *FindContactObj();
 103     const SwContact *FindContactObj() const
 104         { return ((SwFrmFmt*)this)->FindContactObj(); }
 105
 106     // returns the SdrObject, that ist connected to the ContactObject.
 107     // Only DrawFrmFmts are connected to the "real SdrObject". FlyFrmFmts
 108     // are connected to a Master and all FlyFrms has the "real SdrObject".
 109     // "Real SdrObject" has position and a Z-order.
 110           SdrObject *FindSdrObject();
 111     const SdrObject *FindSdrObject() const
 112         { return ((SwFrmFmt*)this)->FindSdrObject(); }
 113
 114           SdrObject *FindRealSdrObject();
 115     const SdrObject *FindRealSdrObject() const
 116         { return ((SwFrmFmt*)this)->FindRealSdrObject(); }
 117
 118     BOOL IsLowerOf( const SwFrmFmt& rFmt ) const;
 119
 120     // --> OD 2004-07-27 #i31698#
 121     enum tLayoutDir
 122     {
 123         HORI_L2R,
 124         HORI_R2L,
 125         VERT_R2L,
 126         VERT_L2R    // not supported yet
 127     };
 128
 129     virtual SwFrmFmt::tLayoutDir GetLayoutDir() const;
 130     virtual void SetLayoutDir( const SwFrmFmt::tLayoutDir _eLayoutDir );
 131     // <--
 132
 133     // --> OD 2004-08-06 #i28749#
 134     virtual sal_Int16 GetPositionLayoutDir() const;
 135     virtual void SetPositionLayoutDir( const sal_Int16 _nPositionLayoutDir );
 136     // <--
 137
 138     virtual String GetDescription() const;
 139
 140     SW_DLLPRIVATE ::com::sun::star::uno::WeakReference<
 141         ::com::sun::star::uno::XInterface> const& GetXObject() const
 142             { return m_wXObject; }
 143     SW_DLLPRIVATE void SetXObject(::com::sun::star::uno::Reference<
 144                     ::com::sun::star::uno::XInterface> const& xObject)
 145             { m_wXObject = xObject; }
 146
 147     DECL_FIXEDMEMPOOL_NEWDEL_DLL(SwFrmFmt)
 148 };
 149
 150 //Das FlyFrame-Format ------------------------------
 151
 152 class SW_DLLPUBLIC SwFlyFrmFmt: public SwFrmFmt
 153 {
 154     friend class SwDoc;
 155
 156     //Beide nicht vorhanden.
 157     SwFlyFrmFmt( const SwFlyFrmFmt &rCpy );
 158     SwFlyFrmFmt &operator=( const SwFlyFrmFmt &rCpy );
 159
 160 protected:
 161     SwFlyFrmFmt( SwAttrPool& rPool, const sal_Char* pFmtNm,
 162                     SwFrmFmt *pDrvdFrm )
 163         : SwFrmFmt( rPool, pFmtNm, pDrvdFrm, RES_FLYFRMFMT )
 164     {}
 165     SwFlyFrmFmt( SwAttrPool& rPool, const String &rFmtNm,
 166                     SwFrmFmt *pDrvdFrm )
 167         : SwFrmFmt( rPool, rFmtNm, pDrvdFrm, RES_FLYFRMFMT )
 168     {}
 169
 170 public:
 171     TYPEINFO();
 172     ~SwFlyFrmFmt();
 173
 174     //Erzeugt die Ansichten
 175     virtual void MakeFrms();
 176
 177     SwFlyFrm* GetFrm( const Point* pDocPos = 0,
 178                         const BOOL bCalcFrm = FALSE ) const;
 179
 180     SwAnchoredObject* GetAnchoredObj( const Point* pDocPos = 0,
 181                                       const BOOL bCalcFrm = FALSE ) const;
 182
 183     virtual Graphic MakeGraphic( ImageMap* pMap = NULL );
 184
 185     virtual BOOL GetInfo( SfxPoolItem& rInfo ) const;
 186
 187     // --> OD 2009-07-14 #i73249#
 188     const String GetObjTitle() const;
 189     void SetObjTitle( const String& rTitle,
 190                       bool bBroadcast = false );
 191     const String GetObjDescription() const;
 192     void SetObjDescription( const String& rDescription,
 193                             bool bBroadcast = false );
 194     // <--
 195
 196     /** SwFlyFrmFmt::IsBackgroundTransparent - for #99657#
 197
 198         OD 22.08.2002 - overloading virtual method and its default implementation,
 199         because format of fly frame provides transparent backgrounds.
 200         Method determines, if background of fly frame is transparent.
 201
 202         @author OD
 203
 204         @return true, if background color is transparent, but not "no fill"
 205         or a existing background graphic is transparent.
 206     */
 207     virtual sal_Bool IsBackgroundTransparent() const;
 208
 209     /** SwFlyFrmFmt::IsBackgroundBrushInherited - for #103898#
 210
 211         OD 08.10.2002 - method to determine, if the brush for drawing the
 212         background is "inherited" from its parent/grandparent.
 213         This is the case, if no background graphic is set and the background
 214         color is "no fill"/"auto fill"
 215
 216         @author OD
 217
 218         @return true, if background brush is "inherited" from parent/grandparent
 219     */
 220     sal_Bool IsBackgroundBrushInherited() const;
 221
 222     DECL_FIXEDMEMPOOL_NEWDEL(SwFlyFrmFmt)
 223 };
 224
 225 //Das DrawFrame-Format -----------------------------
 226
 227 class SW_DLLPUBLIC SwDrawFrmFmt: public SwFrmFmt
 228 {
 229     friend class SwDoc;
 230
 231     mutable const SdrObject * pSdrObjCached;
 232     mutable String sSdrObjCachedComment;
 233
 234     //Beide nicht vorhanden.
 235     SwDrawFrmFmt( const SwDrawFrmFmt &rCpy );
 236     SwDrawFrmFmt &operator=( const SwDrawFrmFmt &rCpy );
 237
 238     // --> OD 2004-07-27 #i31698#
 239     SwFrmFmt::tLayoutDir meLayoutDir;
 240     // <--
 241     // --> OD 2004-08-06 #i28749#
 242     sal_Int16 mnPositionLayoutDir;
 243     // <--
 244     // --> OD 2005-03-11 #i44334#, #i44681#
 245     bool mbPosAttrSet;
 246     // <--
 247 protected:
 248     SwDrawFrmFmt( SwAttrPool& rPool, const sal_Char* pFmtNm,
 249                     SwFrmFmt *pDrvdFrm )
 250         : SwFrmFmt( rPool, pFmtNm, pDrvdFrm, RES_DRAWFRMFMT ),
 251           pSdrObjCached(NULL),
 252           // --> OD 2004-07-28 #i31698#
 253           meLayoutDir( SwFrmFmt::HORI_L2R ),
 254           // <--
 255           // --> OD 2004-08-06 #i28749#
 256           // --> OD 2005-03-10 #i44344#, #i44681# - undo change of issue #i36010#
 257           mnPositionLayoutDir( com::sun::star::text::PositionLayoutDir::PositionInLayoutDirOfAnchor ),
 258           // <--
 259           // --> OD 2005-03-11 #i44334#, #i44681#
 260           mbPosAttrSet( false )
 261           // <--
 262
 263     {}
 264     SwDrawFrmFmt( SwAttrPool& rPool, const String &rFmtNm,
 265                     SwFrmFmt *pDrvdFrm )
 266         : SwFrmFmt( rPool, rFmtNm, pDrvdFrm, RES_DRAWFRMFMT ),
 267           pSdrObjCached(NULL),
 268           // --> OD 2004-07-28 #i31698#
 269           meLayoutDir( SwFrmFmt::HORI_L2R ),
 270           // <--
 271           // --> OD 2004-08-06 #i28749#
 272           // --> OD 2005-03-10 #i44344#, #i44681# - undo change of issue #i36010#
 273           mnPositionLayoutDir( com::sun::star::text::PositionLayoutDir::PositionInLayoutDirOfAnchor ),
 274           // <--
 275           // --> OD 2005-03-11 #i44334#, #i44681#
 276           mbPosAttrSet( false )
 277           // <--
 278     {}
 279
 280 public:
 281     TYPEINFO();
 282     ~SwDrawFrmFmt();
 283
 284     //DrawObjecte werden aus den Arrays am Layout entfernt. Die DrawObjecte
 285     //werden als geloescht gekennzeichnet.
 286     virtual void DelFrms();
 287
 288     //Anmelden der DrawObjecte in den Arrays am Layout. Loeschkennzeichen
 289     //werden zurueckgesetzt.
 290     virtual void MakeFrms();
 291
 292     virtual Graphic MakeGraphic( ImageMap* pMap = NULL );
 293
 294     // --> OD 2004-07-27 #i31698#
 295     virtual SwFrmFmt::tLayoutDir GetLayoutDir() const;
 296     virtual void SetLayoutDir( const SwFrmFmt::tLayoutDir _eLayoutDir );
 297     // <--
 298
 299     // --> OD 2004-08-06 #i28749#
 300     virtual sal_Int16 GetPositionLayoutDir() const;
 301     virtual void SetPositionLayoutDir( const sal_Int16 _nPositionLayoutDir );
 302     // <--
 303
 304     // --> OD 2005-03-11 #i44334#, #i44681#
 305     inline bool IsPosAttrSet() const { return mbPosAttrSet; }
 306     inline void PosAttrSet() { mbPosAttrSet = true; }
 307     // <--
 308
 309     // --> OD 2005-08-16 #i53320#
 310     inline void ResetPosAttr()
 311     {
 312         mbPosAttrSet = false;
 313     }
 314     // <--
 315
 316     virtual String GetDescription() const;
 317
 318     DECL_FIXEDMEMPOOL_NEWDEL(SwDrawFrmFmt);
 319 };
 320
 321
 322 #endif
 323