sw/source/core/layout/newfrm.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: newfrm.cxx,v $
  10  * $Revision: 1.33 $
  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 #include <svx/svdmodel.hxx>
  34 #include <svx/svdpage.hxx>
  35 #include <fmtfordr.hxx>
  36 #include <fmtpdsc.hxx>
  37 #include <frmfmt.hxx>
  38 #include <swtable.hxx>
  39 #include <rootfrm.hxx>
  40 #include <pagefrm.hxx>
  41 #include <cntfrm.hxx>
  42 #include <viewsh.hxx>
  43 #include <doc.hxx>
  44 #include <node.hxx>
  45 #include <dflyobj.hxx>
  46 #include <frmtool.hxx>
  47 #include <virtoutp.hxx>
  48 #include <blink.hxx>
  49 #include <ndindex.hxx>
  50 #include <sectfrm.hxx>
  51 #include <notxtfrm.hxx>
  52 #include <pagedesc.hxx>
  53 #include "viewimp.hxx"
  54 #include "IDocumentTimerAccess.hxx"
  55 #include "IDocumentLayoutAccess.hxx"
  56 #include "IDocumentFieldsAccess.hxx"
  57 #include "IDocumentSettingAccess.hxx"
  58 #include "IDocumentDrawModelAccess.hxx"
  59 #include <hints.hxx>
  60 #include <viewopt.hxx>
  61
  62 SwLayVout     *SwRootFrm::pVout = 0;
  63 BOOL               SwRootFrm::bInPaint = FALSE;
  64 BOOL               SwRootFrm::bNoVirDev = FALSE;
  65
  66 SwCache *SwFrm::pCache = 0;
  67
  68 long FirstMinusSecond( long nFirst, long nSecond )
  69     { return nFirst - nSecond; }
  70 long SecondMinusFirst( long nFirst, long nSecond )
  71     { return nSecond - nFirst; }
  72 long SwIncrement( long nA, long nAdd )
  73     { return nA + nAdd; }
  74 long SwDecrement( long nA, long nSub )
  75     { return nA - nSub; }
  76
  77 static SwRectFnCollection aHorizontal = {
  78     /* fnRectGet      */
  79     &SwRect::_Top,
  80     &SwRect::_Bottom,
  81     &SwRect::_Left,
  82     &SwRect::_Right,
  83     &SwRect::_Width,
  84     &SwRect::_Height,
  85     &SwRect::TopLeft,
  86     &SwRect::_Size,
  87     /* fnRectSet      */
  88     &SwRect::_Top,
  89     &SwRect::_Bottom,
  90     &SwRect::_Left,
  91     &SwRect::_Right,
  92     &SwRect::_Width,
  93     &SwRect::_Height,
  94
  95     &SwRect::SubTop,
  96     &SwRect::AddBottom,
  97     &SwRect::SubLeft,
  98     &SwRect::AddRight,
  99     &SwRect::AddWidth,
 100     &SwRect::AddHeight,
 101
 102     &SwRect::SetPosX,
 103     &SwRect::SetPosY,
 104
 105     &SwFrm::GetTopMargin,
 106     &SwFrm::GetBottomMargin,
 107     &SwFrm::GetLeftMargin,
 108     &SwFrm::GetRightMargin,
 109     &SwFrm::SetLeftRightMargins,
 110     &SwFrm::SetTopBottomMargins,
 111     &SwFrm::GetPrtTop,
 112     &SwFrm::GetPrtBottom,
 113     &SwFrm::GetPrtLeft,
 114     &SwFrm::GetPrtRight,
 115     &SwRect::GetTopDistance,
 116     &SwRect::GetBottomDistance,
 117     &SwRect::GetLeftDistance,
 118     &SwRect::GetRightDistance,
 119     &SwFrm::SetMaxBottom,
 120     &SwRect::OverStepBottom,
 121
 122     &SwRect::SetUpperLeftCorner,
 123     &SwFrm::MakeBelowPos,
 124     &FirstMinusSecond,
 125     &FirstMinusSecond,
 126     &SwIncrement,
 127     &SwIncrement,
 128     &SwRect::SetLeftAndWidth,
 129     &SwRect::SetTopAndHeight
 130 };
 131
 132 static SwRectFnCollection aVertical = {
 133     /* fnRectGet      */
 134     &SwRect::_Right,
 135     &SwRect::_Left,
 136     &SwRect::_Top,
 137     &SwRect::_Bottom,
 138     &SwRect::_Height,
 139     &SwRect::_Width,
 140     &SwRect::TopRight,
 141     &SwRect::SwappedSize,
 142     /* fnRectSet      */
 143     &SwRect::_Right,
 144     &SwRect::_Left,
 145     &SwRect::_Top,
 146     &SwRect::_Bottom,
 147     &SwRect::_Height,
 148     &SwRect::_Width,
 149
 150     &SwRect::AddRight,
 151     &SwRect::SubLeft,
 152     &SwRect::SubTop,
 153     &SwRect::AddBottom,
 154     &SwRect::AddHeight,
 155     &SwRect::AddWidth,
 156
 157     &SwRect::SetPosY,
 158     &SwRect::SetPosX,
 159
 160     &SwFrm::GetRightMargin,
 161     &SwFrm::GetLeftMargin,
 162     &SwFrm::GetTopMargin,
 163     &SwFrm::GetBottomMargin,
 164     &SwFrm::SetTopBottomMargins,
 165     &SwFrm::SetRightLeftMargins,
 166     &SwFrm::GetPrtRight,
 167     &SwFrm::GetPrtLeft,
 168     &SwFrm::GetPrtTop,
 169     &SwFrm::GetPrtBottom,
 170     &SwRect::GetRightDistance,
 171     &SwRect::GetLeftDistance,
 172     &SwRect::GetTopDistance,
 173     &SwRect::GetBottomDistance,
 174     &SwFrm::SetMinLeft,
 175     &SwRect::OverStepLeft,
 176
 177     &SwRect::SetUpperRightCorner,
 178     &SwFrm::MakeLeftPos,
 179     &FirstMinusSecond,
 180     &SecondMinusFirst,
 181     &SwIncrement,
 182     &SwDecrement,
 183     &SwRect::SetTopAndHeight,
 184     &SwRect::SetRightAndWidth
 185 };
 186
 187 static SwRectFnCollection aBottomToTop = {
 188     /* fnRectGet      */
 189     &SwRect::_Bottom,
 190     &SwRect::_Top,
 191     &SwRect::_Left,
 192     &SwRect::_Right,
 193     &SwRect::_Width,
 194     &SwRect::_Height,
 195     &SwRect::BottomLeft,
 196     &SwRect::_Size,
 197     /* fnRectSet      */
 198     &SwRect::_Bottom,
 199     &SwRect::_Top,
 200     &SwRect::_Left,
 201     &SwRect::_Right,
 202     &SwRect::_Width,
 203     &SwRect::_Height,
 204
 205     &SwRect::AddBottom,
 206     &SwRect::SubTop,
 207     &SwRect::SubLeft,
 208     &SwRect::AddRight,
 209     &SwRect::AddWidth,
 210     &SwRect::AddHeight,
 211
 212     &SwRect::SetPosX,
 213     &SwRect::SetPosY,
 214
 215     &SwFrm::GetBottomMargin,
 216     &SwFrm::GetTopMargin,
 217     &SwFrm::GetLeftMargin,
 218     &SwFrm::GetRightMargin,
 219     &SwFrm::SetLeftRightMargins,
 220     &SwFrm::SetBottomTopMargins,
 221     &SwFrm::GetPrtBottom,
 222     &SwFrm::GetPrtTop,
 223     &SwFrm::GetPrtLeft,
 224     &SwFrm::GetPrtRight,
 225     &SwRect::GetBottomDistance,
 226     &SwRect::GetTopDistance,
 227     &SwRect::GetLeftDistance,
 228     &SwRect::GetRightDistance,
 229     &SwFrm::SetMinTop,
 230     &SwRect::OverStepTop,
 231
 232     &SwRect::SetLowerLeftCorner,
 233     &SwFrm::MakeUpperPos,
 234     &FirstMinusSecond,
 235     &SecondMinusFirst,
 236     &SwIncrement,
 237     &SwDecrement,
 238     &SwRect::SetLeftAndWidth,
 239     &SwRect::SetBottomAndHeight
 240 };
 241
 242 static SwRectFnCollection aVerticalRightToLeft = {
 243     /* fnRectGet      */
 244     &SwRect::_Left,
 245     &SwRect::_Right,
 246     &SwRect::_Top,
 247     &SwRect::_Bottom,
 248     &SwRect::_Height,
 249     &SwRect::_Width,
 250     &SwRect::BottomRight,
 251     &SwRect::SwappedSize,
 252     /* fnRectSet      */
 253     &SwRect::_Left,
 254     &SwRect::_Right,
 255     &SwRect::_Top,
 256     &SwRect::_Bottom,
 257     &SwRect::_Height,
 258     &SwRect::_Width,
 259
 260     &SwRect::SubLeft,
 261     &SwRect::AddRight,
 262     &SwRect::SubTop,
 263     &SwRect::AddBottom,
 264     &SwRect::AddHeight,
 265     &SwRect::AddWidth,
 266
 267     &SwRect::SetPosY,
 268     &SwRect::SetPosX,
 269
 270     &SwFrm::GetLeftMargin,
 271     &SwFrm::GetRightMargin,
 272     &SwFrm::GetTopMargin,
 273     &SwFrm::GetBottomMargin,
 274     &SwFrm::SetTopBottomMargins,
 275     &SwFrm::SetLeftRightMargins,
 276     &SwFrm::GetPrtLeft,
 277     &SwFrm::GetPrtRight,
 278     &SwFrm::GetPrtBottom,
 279     &SwFrm::GetPrtTop,
 280     &SwRect::GetLeftDistance,
 281     &SwRect::GetRightDistance,
 282     &SwRect::GetBottomDistance,
 283     &SwRect::GetTopDistance,
 284     &SwFrm::SetMaxRight,
 285     &SwRect::OverStepRight,
 286
 287     &SwRect::SetLowerLeftCorner,
 288     &SwFrm::MakeRightPos,
 289     &FirstMinusSecond,
 290     &FirstMinusSecond,
 291     &SwDecrement,
 292     &SwIncrement,
 293     &SwRect::SetBottomAndHeight,
 294     &SwRect::SetLeftAndWidth
 295 };
 296
 297 SwRectFn fnRectHori = &aHorizontal;
 298 SwRectFn fnRectVert = &aVertical;
 299 SwRectFn fnRectB2T = &aBottomToTop;
 300 SwRectFn fnRectVL2R = &aVerticalRightToLeft;
 301
 302 // --> OD 2006-05-10 #i65250#
 303 sal_uInt32 SwFrm::mnLastFrmId=0;
 304 // <--
 305
 306 TYPEINIT1(SwFrm,SwClient);              //rtti fuer SwFrm
 307 TYPEINIT1(SwCntntFrm,SwFrm);    //rtti fuer SwCntntFrm
 308
 309
 310 void _FrmInit()
 311 {
 312     SwRootFrm::pVout = new SwLayVout();
 313     SwCache *pNew = new SwCache( 100, 100
 314 #ifndef PRODUCT
 315     , "static SwBorderAttrs::pCache"
 316 #endif
 317     );
 318     SwFrm::SetCache( pNew );
 319 }
 320
 321
 322
 323 void _FrmFinit()
 324 {
 325 #ifndef PRODUCT
 326     // im Chache duerfen nur noch 0-Pointer stehen
 327     for( USHORT n = SwFrm::GetCachePtr()->Count(); n; )
 328         if( (*SwFrm::GetCachePtr())[ --n ] )
 329         {
 330             SwCacheObj* pObj = (*SwFrm::GetCachePtr())[ n ];
 331             ASSERT( !pObj, "Wer hat sich nicht ausgetragen?")
 332         }
 333 #endif
 334     delete SwRootFrm::pVout;
 335     delete SwFrm::GetCachePtr();
 336 }
 337
 338 /*************************************************************************
 339 |*
 340 |*      RootFrm::Alles was so zur CurrShell gehoert
 341 |*
 342 |*      Ersterstellung          MA 09. Sep. 98
 343 |*      Letzte Aenderung        MA 18. Feb. 99
 344 |*
 345 |*************************************************************************/
 346
 347 typedef CurrShell* CurrShellPtr;
 348 SV_DECL_PTRARR_SORT(SwCurrShells,CurrShellPtr,4,4)
 349 SV_IMPL_PTRARR_SORT(SwCurrShells,CurrShellPtr)
 350
 351 CurrShell::CurrShell( ViewShell *pNew )
 352 {
 353     ASSERT( pNew, "0-Shell einsetzen?" );
 354     pRoot = pNew->GetLayout();
 355     if ( pRoot )
 356     {
 357         pPrev = pRoot->pCurrShell;
 358         pRoot->pCurrShell = pNew;
 359         pRoot->pCurrShells->Insert( this );
 360     }
 361     else
 362         pPrev = 0;
 363 }
 364
 365 CurrShell::~CurrShell()
 366 {
 367     if ( pRoot )
 368     {
 369         pRoot->pCurrShells->Remove( this );
 370         if ( pPrev )
 371             pRoot->pCurrShell = pPrev;
 372         if ( !pRoot->pCurrShells->Count() && pRoot->pWaitingCurrShell )
 373         {
 374             pRoot->pCurrShell = pRoot->pWaitingCurrShell;
 375             pRoot->pWaitingCurrShell = 0;
 376         }
 377     }
 378 }
 379
 380 void SetShell( ViewShell *pSh )
 381 {
 382     SwRootFrm *pRoot = pSh->GetLayout();
 383     if ( !pRoot->pCurrShells->Count() )
 384         pRoot->pCurrShell = pSh;
 385     else
 386         pRoot->pWaitingCurrShell = pSh;
 387 }
 388
 389 void SwRootFrm::DeRegisterShell( ViewShell *pSh )
 390 {
 391     //Wenn moeglich irgendeine Shell aktivieren
 392     if ( pCurrShell == pSh )
 393         pCurrShell = pSh->GetNext() != pSh ? (ViewShell*)pSh->GetNext() : 0;
 394
 395     //Das hat sich eruebrigt
 396     if ( pWaitingCurrShell == pSh )
 397         pWaitingCurrShell = 0;
 398
 399     //Referenzen entfernen.
 400     for ( USHORT i = 0; i < pCurrShells->Count(); ++i )
 401     {
 402         CurrShell *pC = (*pCurrShells)[i];
 403         if (pC->pPrev == pSh)
 404             pC->pPrev = 0;
 405     }
 406 }
 407
 408 void InitCurrShells( SwRootFrm *pRoot )
 409 {
 410     pRoot->pCurrShells = new SwCurrShells;
 411 }
 412
 413
 414 /*************************************************************************
 415 |*
 416 |*      SwRootFrm::SwRootFrm()
 417 |*
 418 |*      Beschreibung:
 419 |*              Der RootFrm laesst sich grundsaetzlich vom Dokument ein eigenes
 420 |*              FrmFmt geben. Dieses loescht er dann selbst im DTor.
 421 |*              Das eigene FrmFmt wird vom uebergebenen Format abgeleitet.
 422 |*      Ersterstellung          SS 05-Apr-1991
 423 |*      Letzte Aenderung        MA 12. Dec. 94
 424 |*
 425 |*************************************************************************/
 426
 427
 428 SwRootFrm::SwRootFrm( SwFrmFmt *pFmt, ViewShell * pSh ) :
 429     SwLayoutFrm( pFmt->GetDoc()->MakeFrmFmt(
 430         XubString( "Root", RTL_TEXTENCODING_MS_1252 ), pFmt ) ),
 431     // --> PAGES01
 432     maPagesArea(),
 433     mnViewWidth( -1 ),
 434     mnColumns( 0 ),
 435     mbBookMode( false ),
 436     mbSidebarChanged( false ),
 437     mbNeedGrammarCheck( false ),
 438     // <--
 439     nBrowseWidth( MM50*4 ), //2cm Minimum
 440     pTurbo( 0 ),
 441     pLastPage( 0 ),
 442     pCurrShell( pSh ),
 443     pWaitingCurrShell( 0 ),
 444     pDrawPage( 0 ),
 445     pDestroy( 0 ),
 446     nPhyPageNums( 0 ),
 447     nAccessibleShells( 0 )
 448 {
 449     nType = FRMC_ROOT;
 450     bIdleFormat = bTurboAllowed = bAssertFlyPages = bIsNewLayout = TRUE;
 451     bCheckSuperfluous = bBrowseWidthValid = FALSE;
 452
 453     InitCurrShells( this );
 454
 455     IDocumentTimerAccess *pTimerAccess = pFmt->getIDocumentTimerAccess();
 456     IDocumentLayoutAccess *pLayoutAccess = pFmt->getIDocumentLayoutAccess();
 457     IDocumentFieldsAccess *pFieldsAccess = pFmt->getIDocumentFieldsAccess();
 458     const IDocumentSettingAccess *pSettingAccess = pFmt->getIDocumentSettingAccess();
 459     pTimerAccess->StopIdling();
 460     pLayoutAccess->SetRootFrm( this );          //Fuer das Erzeugen der Flys durch MakeFrms()
 461     bCallbackActionEnabled = FALSE;     //vor Verlassen auf TRUE setzen!
 462
 463     SdrModel *pMd = pFmt->getIDocumentDrawModelAccess()->GetDrawModel();
 464
 465     if ( pMd )
 466     {
 467         pDrawPage = pMd->GetPage( 0 );
 468         pDrawPage->SetSize( Frm().SSize() );
 469     }
 470
 471     //Initialisierung des Layouts: Seiten erzeugen. Inhalt mit cntnt verbinden
 472     //usw.
 473     //Zuerst einiges initialiseren und den ersten Node besorgen (der wird
 474     //fuer den PageDesc benoetigt).
 475
 476     SwDoc* pDoc = pFmt->GetDoc();
 477     SwNodeIndex aIndex( *pDoc->GetNodes().GetEndOfContent().StartOfSectionNode() );
 478     SwCntntNode *pNode = pDoc->GetNodes().GoNextSection( &aIndex, TRUE, FALSE );
 479     // --> FME 2005-05-25 #123067# pNode = 0 can really happen:
 480     SwTableNode *pTblNd= pNode ? pNode->FindTableNode() : 0;
 481     // <--
 482
 483     //PageDesc besorgen (entweder vom FrmFmt des ersten Node oder den
 484     //initialen.)
 485     SwPageDesc *pDesc = 0;
 486     USHORT nPgNum = 1;
 487
 488     if ( pTblNd )
 489     {
 490         const SwFmtPageDesc &rDesc = pTblNd->GetTable().GetFrmFmt()->GetPageDesc();
 491         pDesc = (SwPageDesc*)rDesc.GetPageDesc();
 492         //#19104# Seitennummeroffset beruecksictigen!!
 493         bIsVirtPageNum = 0 != ( nPgNum = rDesc.GetNumOffset() );
 494     }
 495     else if ( pNode )
 496     {
 497         const SwFmtPageDesc &rDesc = pNode->GetSwAttrSet().GetPageDesc();
 498         pDesc = (SwPageDesc*)rDesc.GetPageDesc();
 499         //#19104# Seitennummeroffset beruecksictigen!!
 500         bIsVirtPageNum = 0 != ( nPgNum = rDesc.GetNumOffset() );
 501     }
 502     else
 503         bIsVirtPageNum = FALSE;
 504     if ( !pDesc )
 505         pDesc = (SwPageDesc*)
 506             &const_cast<const SwDoc *>(pDoc)->GetPageDesc( 0 );
 507     const BOOL bOdd = !nPgNum || 0 != ( nPgNum % 2 );
 508
 509     //Eine Seite erzeugen und in das Layout stellen
 510     SwPageFrm *pPage = ::InsertNewPage( *pDesc, this, bOdd, FALSE, FALSE, 0 );
 511
 512     //Erstes Blatt im Bodytext-Bereich suchen.
 513     SwLayoutFrm *pLay = pPage->FindBodyCont();
 514     while( pLay->Lower() )
 515         pLay = (SwLayoutFrm*)pLay->Lower();
 516
 517     SwNodeIndex aTmp( *pDoc->GetNodes().GetEndOfContent().StartOfSectionNode(), 1 );
 518     ::_InsertCnt( pLay, pDoc, aTmp.GetIndex(), TRUE );
 519     //Noch nicht ersetzte Master aus der Liste entfernen.
 520     RemoveMasterObjs( pDrawPage );
 521     if( pSettingAccess->get(IDocumentSettingAccess::GLOBAL_DOCUMENT) )
 522         pFieldsAccess->UpdateRefFlds( NULL );
 523     //b6433357: Update page fields after loading
 524     // --->
 525     if ( !pCurrShell || !pCurrShell->Imp()->IsUpdateExpFlds() )
 526     {
 527         SwDocPosUpdate aMsgHnt( pPage->Frm().Top() );
 528         pFieldsAccess->UpdatePageFlds( &aMsgHnt );
 529     }
 530     // <---
 531
 532     pTimerAccess->StartIdling();
 533     bCallbackActionEnabled = TRUE;
 534
 535     ViewShell *pViewSh  = GetCurrShell();
 536     if (pViewSh)
 537         mbNeedGrammarCheck = pViewSh->GetViewOptions()->IsOnlineSpell();
 538 }
 539
 540 /*************************************************************************
 541 |*
 542 |*      SwRootFrm::~SwRootFrm()
 543 |*
 544 |*      Ersterstellung          SS 05-Apr-1991
 545 |*      Letzte Aenderung        MA 12. Dec. 94
 546 |*
 547 |*************************************************************************/
 548
 549
 550
 551 SwRootFrm::~SwRootFrm()
 552 {
 553     bTurboAllowed = FALSE;
 554     pTurbo = 0;
 555     if(pBlink)
 556         pBlink->FrmDelete( this );
 557     ((SwFrmFmt*)pRegisteredIn)->GetDoc()->DelFrmFmt( (SwFrmFmt*)pRegisteredIn );
 558     delete pDestroy;
 559
 560     //Referenzen entfernen.
 561     for ( USHORT i = 0; i < pCurrShells->Count(); ++i )
 562         (*pCurrShells)[i]->pRoot = 0;
 563
 564     delete pCurrShells;
 565
 566     ASSERT( 0==nAccessibleShells, "Some accessible shells are left" );
 567 }
 568
 569 /*************************************************************************
 570 |*
 571 |*      SwRootFrm::RemoveMasterObjs()
 572 |*
 573 |*      Ersterstellung          MA 19.10.95
 574 |*      Letzte Aenderung        MA 19.10.95
 575 |*
 576 |*************************************************************************/
 577
 578
 579 void SwRootFrm::RemoveMasterObjs( SdrPage *pPg )
 580 {
 581     //Alle Masterobjekte aus der Page entfernen. Nicht loeschen!!
 582     for( ULONG i = pPg ? pPg->GetObjCount() : 0; i; )
 583     {
 584         SdrObject* pObj = pPg->GetObj( --i );
 585         if( pObj->ISA(SwFlyDrawObj ) )
 586             pPg->RemoveObject( i );
 587     }
 588 }
 589
 590
 591
 592