sw/source/core/layout/pagedesc.cxx

   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: pagedesc.cxx,v $
  10  * $Revision: 1.19 $
  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
  31 // MARKER(update_precomp.py): autogen include statement, do not remove
  32 #include "precompiled_sw.hxx"
  33
  34
  35
  36 #include <hintids.hxx>
  37 #include <svx/pbinitem.hxx>
  38 #include <svx/ulspitem.hxx>
  39 #include <svx/boxitem.hxx>
  40 #include <svx/brshitem.hxx>
  41 #include <svx/shaditem.hxx>
  42 #include <svx/lrspitem.hxx>
  43 #include "svx/frmdiritem.hxx"
  44 #include <fmtclds.hxx>
  45 #include <fmtfsize.hxx>
  46 #include <frmatr.hxx>
  47 #include <pagefrm.hxx>
  48 #include <pagedesc.hxx>
  49 #include <frmfmt.hxx>
  50 #include <fmtcol.hxx>   // SwTxtFmtColl
  51 #include <node.hxx>
  52 #include <swtable.hxx>
  53 #include <frmtool.hxx>
  54 #include <doc.hxx>                      // fuer GetAttrPool
  55 #include <poolfmt.hxx>
  56
  57 /*************************************************************************
  58 |*
  59 |*      SwPageDesc::SwPageDesc()
  60 |*
  61 |*      Ersterstellung          MA 25. Jan. 93
  62 |*      Letzte Aenderung        MA 16. Feb. 94
  63 |*
  64 |*************************************************************************/
  65
  66
  67
  68 SwPageDesc::SwPageDesc( const String& rName, SwFrmFmt *pFmt, SwDoc *pDc ) :
  69     SwModify( 0 ),
  70     aDescName( rName ),
  71     aMaster( pDc->GetAttrPool(), rName, pFmt ),
  72     aLeft( pDc->GetAttrPool(), rName, pFmt ),
  73     aDepend( this, 0 ),
  74     pFollow( this ),
  75     nRegHeight( 0 ),
  76     nRegAscent( 0 ),
  77     eUse( (UseOnPage)(nsUseOnPage::PD_ALL | nsUseOnPage::PD_HEADERSHARE | nsUseOnPage::PD_FOOTERSHARE) ),
  78     bLandscape( FALSE ),
  79     aFtnInfo()
  80 {
  81 }
  82
  83 SwPageDesc::SwPageDesc( const SwPageDesc &rCpy ) :
  84     SwModify( 0 ),
  85     aDescName( rCpy.GetName() ),
  86     aNumType( rCpy.GetNumType() ),
  87     aMaster( rCpy.GetMaster() ),
  88     aLeft( rCpy.GetLeft() ),
  89     aDepend( this, (SwModify*)rCpy.aDepend.GetRegisteredIn() ),
  90     pFollow( rCpy.pFollow ),
  91     nRegHeight( rCpy.GetRegHeight() ),
  92     nRegAscent( rCpy.GetRegAscent() ),
  93     eUse( rCpy.ReadUseOn() ),
  94     bLandscape( rCpy.GetLandscape() ),
  95     aFtnInfo( rCpy.GetFtnInfo() )
  96 {
  97 }
  98
  99 SwPageDesc & SwPageDesc::operator = (const SwPageDesc & rSrc)
 100 {
 101     aDescName = rSrc.aDescName;
 102     aNumType = rSrc.aNumType;
 103     aMaster = rSrc.aMaster;
 104     aLeft = rSrc.aLeft;
 105
 106     if (rSrc.pFollow == &rSrc)
 107         pFollow = this;
 108     else
 109         pFollow = rSrc.pFollow;
 110
 111     nRegHeight = rSrc.nRegHeight;
 112     nRegAscent = rSrc.nRegAscent;
 113     eUse = rSrc.eUse;
 114     bLandscape = rSrc.bLandscape;
 115     return *this;
 116 }
 117
 118 SwPageDesc::~SwPageDesc()
 119 {
 120 }
 121
 122 /*************************************************************************
 123 |*
 124 |*      SwPageDesc::Mirror()
 125 |*
 126 |*      Beschreibung            Gespiegelt werden nur die Raender.
 127 |*              Attribute wie Umrandung und dergleichen werden 1:1 kopiert.
 128 |*      Ersterstellung          MA 25. Jan. 93
 129 |*      Letzte Aenderung        01. Nov. 94
 130 |*
 131 |*************************************************************************/
 132
 133
 134
 135 void SwPageDesc::Mirror()
 136 {
 137     //Das Spiegeln findet nur beim RandAttribut statt, alle anderen Werte
 138     //werden schlicht uebertragen.
 139     SvxLRSpaceItem aLR( RES_LR_SPACE );
 140     const SvxLRSpaceItem &rLR = aMaster.GetLRSpace();
 141     aLR.SetLeft(  rLR.GetRight() );
 142     aLR.SetRight( rLR.GetLeft() );
 143
 144     SfxItemSet aSet( *aMaster.GetAttrSet().GetPool(),
 145                      aMaster.GetAttrSet().GetRanges() );
 146     aSet.Put( aLR );
 147     aSet.Put( aMaster.GetFrmSize() );
 148     aSet.Put( aMaster.GetPaperBin() );
 149     aSet.Put( aMaster.GetULSpace() );
 150     aSet.Put( aMaster.GetBox() );
 151     aSet.Put( aMaster.GetBackground() );
 152     aSet.Put( aMaster.GetShadow() );
 153     aSet.Put( aMaster.GetCol() );
 154     aSet.Put( aMaster.GetFrmDir() );    // #112217#
 155     aLeft.SetFmtAttr( aSet );
 156 }
 157
 158 void SwPageDesc::ResetAllAttr( sal_Bool bLeft )
 159 {
 160     SwFrmFmt& rFmt = bLeft ? GetLeft() : GetMaster();
 161
 162     // --> OD 2007-01-25 #i73790# - method renamed
 163     rFmt.ResetAllFmtAttr();
 164     // <--
 165     rFmt.SetFmtAttr( SvxFrameDirectionItem(FRMDIR_HORI_LEFT_TOP, RES_FRAMEDIR) );
 166 }
 167
 168 /*************************************************************************
 169 |*
 170 |*                SwPageDesc::GetInfo()
 171 |*
 172 |*    Beschreibung      erfragt Informationen
 173 |*    Ersterstellung    JP 31.03.94
 174 |*    Letzte Aenderung  JP 31.03.94
 175 |*
 176 *************************************************************************/
 177
 178
 179     // erfrage vom Modify Informationen
 180 BOOL SwPageDesc::GetInfo( SfxPoolItem & rInfo ) const
 181 {
 182 //    if( RES_AUTOFMT_DOCNODE == rInfo.Which() )
 183 //    {
 184         // dann weiter zum Format
 185         if( !aMaster.GetInfo( rInfo ) )
 186             return FALSE;               // gefunden
 187         return aLeft.GetInfo( rInfo );
 188 //    }
 189 //    return TRUE;        // weiter suchen
 190 }
 191
 192 /*************************************************************************
 193 |*
 194 |*                SwPageDesc::SetRegisterFmtColl()
 195 |*
 196 |*    Beschreibung      setzt die Vorlage fuer die Registerhaltigkeit
 197 |*    Ersterstellung    AMA 22.07.96
 198 |*    Letzte Aenderung  AMA 22.07.96
 199 |*
 200 *************************************************************************/
 201
 202
 203 void SwPageDesc::SetRegisterFmtColl( const SwTxtFmtColl* pFmt )
 204 {
 205     if( pFmt != GetRegisterFmtColl() )
 206     {
 207         if( pFmt )
 208             ((SwTxtFmtColl*)pFmt)->Add( &aDepend );
 209         else
 210             ((SwTxtFmtColl*)GetRegisterFmtColl())->Remove( &aDepend );
 211
 212         RegisterChange();
 213     }
 214 }
 215
 216 /*************************************************************************
 217 |*
 218 |*                SwPageDesc::GetRegisterFmtColl()
 219 |*
 220 |*    Beschreibung      holt die Vorlage fuer die Registerhaltigkeit
 221 |*    Ersterstellung    AMA 22.07.96
 222 |*    Letzte Aenderung  AMA 22.07.96
 223 |*
 224 *************************************************************************/
 225
 226
 227 const SwTxtFmtColl* SwPageDesc::GetRegisterFmtColl() const
 228 {
 229     const SwModify* pReg = aDepend.GetRegisteredIn();
 230     return (SwTxtFmtColl*)pReg;
 231 }
 232
 233 /*************************************************************************
 234 |*
 235 |*                SwPageDesc::RegisterChange()
 236 |*
 237 |*    Beschreibung      benachrichtigt alle betroffenen PageFrames
 238 |*    Ersterstellung    AMA 22.07.96
 239 |*    Letzte Aenderung  AMA 22.07.96
 240 |*
 241 *************************************************************************/
 242
 243
 244 void SwPageDesc::RegisterChange()
 245 {
 246     // --> OD 2004-06-15 #117072# - During destruction of the document <SwDoc>
 247     // the page description is modified. Thus, do nothing, if the document
 248     // is in destruction respectively if no viewshell exists.
 249     SwDoc* pDoc = GetMaster().GetDoc();
 250     if ( !pDoc || pDoc->IsInDtor() )
 251     {
 252         return;
 253     }
 254     ViewShell* pSh = 0L;
 255     pDoc->GetEditShell( &pSh );
 256     if ( !pSh )
 257     {
 258         return;
 259     }
 260
 261     nRegHeight = 0;
 262     {
 263         SwClientIter aIter( GetMaster() );
 264         for( SwClient* pLast = aIter.First(TYPE(SwFrm)); pLast;
 265                 pLast = aIter.Next() )
 266         {
 267             if( ((SwFrm*)pLast)->IsPageFrm() )
 268                 ((SwPageFrm*)pLast)->PrepareRegisterChg();
 269         }
 270     }
 271     {
 272         SwClientIter aIter( GetLeft() );
 273         for( SwClient* pLast = aIter.First(TYPE(SwFrm)); pLast;
 274                 pLast = aIter.Next() )
 275         {
 276             if( ((SwFrm*)pLast)->IsPageFrm() )
 277                 ((SwPageFrm*)pLast)->PrepareRegisterChg();
 278         }
 279     }
 280 }
 281
 282 /*************************************************************************
 283 |*
 284 |*                SwPageDesc::Modify()
 285 |*
 286 |*    Beschreibung      reagiert insbesondere auf Aenderungen
 287 |*                          der Vorlage fuer die Registerhaltigkeit
 288 |*    Ersterstellung    AMA 22.07.96
 289 |*    Letzte Aenderung  AMA 22.07.96
 290 |*
 291 *************************************************************************/
 292
 293
 294 void SwPageDesc::Modify( SfxPoolItem *pOld, SfxPoolItem *pNew )
 295 {
 296     const USHORT nWhich = pOld ? pOld->Which() : pNew ? pNew->Which() : 0;
 297     SwModify::Modify( pOld, pNew );
 298
 299     if ( (RES_ATTRSET_CHG == nWhich) || (RES_FMT_CHG == nWhich)
 300         || isCHRATR(nWhich) || (RES_PARATR_LINESPACING == nWhich) )
 301     {
 302         RegisterChange();
 303     }
 304 }
 305
 306 static const SwFrm* lcl_GetFrmOfNode( const SwNode& rNd )
 307 {
 308     SwModify* pMod;
 309     USHORT nFrmType = FRM_CNTNT;
 310
 311     if( rNd.IsCntntNode() )
 312     {
 313         pMod = &(SwCntntNode&)rNd;
 314     }
 315     else if( rNd.IsTableNode() )
 316     {
 317         pMod = ((SwTableNode&)rNd).GetTable().GetFrmFmt();
 318         nFrmType = FRM_TAB;
 319     }
 320     else
 321         pMod = 0;
 322
 323     Point aNullPt;
 324     return pMod ? ::GetFrmOfModify( *pMod, nFrmType, &aNullPt, 0, FALSE )
 325                 : 0;
 326 }
 327
 328 const SwPageDesc* SwPageDesc::GetPageDescOfNode(const SwNode& rNd)
 329 {
 330     const SwPageDesc* pRet = 0;
 331     const SwFrm* pChkFrm = lcl_GetFrmOfNode( rNd );
 332     if (pChkFrm && 0 != (pChkFrm = pChkFrm->FindPageFrm()))
 333         pRet = ((const SwPageFrm*)pChkFrm)->GetPageDesc();
 334     return pRet;
 335 }
 336
 337 const SwFrmFmt* SwPageDesc::GetPageFmtOfNode( const SwNode& rNd,
 338                                               BOOL bCheckForThisPgDc ) const
 339 {
 340     // welches PageDescFormat ist fuer diesen Node gueltig?
 341     const SwFrmFmt* pRet;
 342     const SwFrm* pChkFrm = lcl_GetFrmOfNode( rNd );
 343
 344     if( pChkFrm && 0 != ( pChkFrm = pChkFrm->FindPageFrm() ))
 345     {
 346         const SwPageDesc* pPd = bCheckForThisPgDc ? this :
 347                                 ((SwPageFrm*)pChkFrm)->GetPageDesc();
 348         pRet = &pPd->GetMaster();
 349         ASSERT( ((SwPageFrm*)pChkFrm)->GetPageDesc() == pPd,
 350                 "Falcher Node fuers erkennen des Seitenformats" );
 351         // an welchem Format haengt diese Seite?
 352         if( pRet != pChkFrm->GetRegisteredIn() )
 353         {
 354             pRet = &pPd->GetLeft();
 355             ASSERT( pRet == pChkFrm->GetRegisteredIn(),
 356                     "Falcher Node fuers erkennen des Seitenformats" );
 357         }
 358     }
 359     else
 360         pRet = &GetMaster();
 361     return pRet;
 362 }
 363
 364 BOOL SwPageDesc::IsFollowNextPageOfNode( const SwNode& rNd ) const
 365 {
 366     BOOL bRet = FALSE;
 367     if( GetFollow() && this != GetFollow() )
 368     {
 369         const SwFrm* pChkFrm = lcl_GetFrmOfNode( rNd );
 370         if( pChkFrm && 0 != ( pChkFrm = pChkFrm->FindPageFrm() ) &&
 371             pChkFrm->IsPageFrm() &&
 372             ( !pChkFrm->GetNext() || GetFollow() ==
 373                         ((SwPageFrm*)pChkFrm->GetNext())->GetPageDesc() ))
 374             // die Seite gefunden, auf die der Follow verweist
 375             bRet = TRUE;
 376     }
 377     return bRet;
 378 }
 379
 380 /*************************************************************************
 381 |*
 382 |*      SwPageFtnInfo::SwPageFtnInfo()
 383 |*
 384 |*      Ersterstellung          MA 24. Feb. 93
 385 |*      Letzte Aenderung        MA 24. Feb. 93
 386 |*
 387 |*************************************************************************/
 388
 389
 390
 391 SwPageFtnInfo::SwPageFtnInfo() :
 392     nMaxHeight( 0 ),
 393 //      aPen( PEN_SOLID ),
 394     nLineWidth(10),
 395     aWidth( 25, 100 ),
 396     nTopDist( 57 ),         //1mm
 397     nBottomDist( 57 )
 398 {
 399     eAdj = FRMDIR_HORI_RIGHT_TOP == GetDefaultFrameDirection(GetAppLanguage()) ?
 400            FTNADJ_RIGHT :
 401            FTNADJ_LEFT;
 402 //      aPen.SetWidth( 10 );
 403 }
 404
 405
 406
 407 SwPageFtnInfo::SwPageFtnInfo( const SwPageFtnInfo &rCpy ) :
 408     nMaxHeight( rCpy.GetHeight() ),
 409     nLineWidth(rCpy.nLineWidth),
 410     aLineColor(rCpy.aLineColor),
 411     aWidth( rCpy.GetWidth() ),
 412     eAdj( rCpy.GetAdj() ),
 413     nTopDist( rCpy.GetTopDist() ),
 414     nBottomDist( rCpy.GetBottomDist() )
 415 {
 416 }
 417
 418 /*************************************************************************
 419 |*
 420 |*      SwPageFtnInfo::operator=
 421 |*
 422 |*      Ersterstellung          MA 24. Feb. 93
 423 |*      Letzte Aenderung        MA 24. Feb. 93
 424 |*
 425 |*************************************************************************/
 426
 427
 428
 429 SwPageFtnInfo &SwPageFtnInfo::operator=( const SwPageFtnInfo& rCpy )
 430 {
 431     nMaxHeight  = rCpy.GetHeight();
 432     nLineWidth  = rCpy.nLineWidth;
 433     aLineColor  = rCpy.aLineColor;
 434     aWidth              = rCpy.GetWidth();
 435     eAdj                = rCpy.GetAdj();
 436     nTopDist    = rCpy.GetTopDist();
 437     nBottomDist = rCpy.GetBottomDist();
 438     return *this;
 439 }
 440 /*************************************************************************
 441 |*
 442 |*      SwPageFtnInfo::operator==
 443 |*
 444 |*      Ersterstellung          MA 01. Mar. 93
 445 |*      Letzte Aenderung        MA 01. Mar. 93
 446 |*
 447 |*************************************************************************/
 448
 449
 450
 451 BOOL SwPageFtnInfo::operator==( const SwPageFtnInfo& rCmp ) const
 452 {
 453     return ( nMaxHeight == rCmp.GetHeight() &&
 454              nLineWidth == rCmp.nLineWidth &&
 455              aLineColor == rCmp.aLineColor &&
 456              aWidth     == rCmp.GetWidth() &&
 457              eAdj       == rCmp.GetAdj() &&
 458              nTopDist   == rCmp.GetTopDist() &&
 459              nBottomDist== rCmp.GetBottomDist() );
 460 }
 461
 462 SwPageDescExt::SwPageDescExt(const SwPageDesc & rPageDesc, SwDoc * _pDoc)
 463     : aPageDesc(rPageDesc), pDoc(_pDoc)
 464 {
 465     SetPageDesc(rPageDesc);
 466 }
 467
 468 SwPageDescExt::SwPageDescExt(const SwPageDescExt & rSrc)
 469     : aPageDesc(rSrc.aPageDesc), pDoc(rSrc.pDoc)
 470 {
 471     SetPageDesc(rSrc.aPageDesc);
 472 }
 473
 474 SwPageDescExt::~SwPageDescExt()
 475 {
 476 }
 477
 478 const String & SwPageDescExt::GetName() const
 479 {
 480     return aPageDesc.GetName();
 481 }
 482
 483 void SwPageDescExt::SetPageDesc(const SwPageDesc & _aPageDesc)
 484 {
 485     aPageDesc = _aPageDesc;
 486
 487     if (aPageDesc.GetFollow())
 488         sFollow = aPageDesc.GetFollow()->GetName();
 489 }
 490
 491 SwPageDescExt & SwPageDescExt::operator = (const SwPageDesc & rSrc)
 492 {
 493     SetPageDesc(rSrc);
 494
 495     return *this;
 496 }
 497
 498 SwPageDescExt & SwPageDescExt::operator = (const SwPageDescExt & rSrc)
 499 {
 500     SetPageDesc(rSrc.aPageDesc);
 501
 502     return *this;
 503 }
 504
 505 SwPageDescExt::operator SwPageDesc() const
 506 {
 507     SwPageDesc aResult(aPageDesc);
 508
 509     SwPageDesc * pPageDesc = pDoc->GetPageDesc(sFollow);
 510
 511     if ( 0 != pPageDesc )
 512         aResult.SetFollow(pPageDesc);
 513
 514     return aResult;
 515 }