sw/source/core/inc/pagefrm.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: pagefrm.hxx,v $
  10  * $Revision: 1.25.144.1 $
  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 _PAGEFRM_HXX
  31 #define _PAGEFRM_HXX
  32
  33
  34 #include <svtools/svarray.hxx>
  35
  36 #include "ftnboss.hxx"
  37 #include <tools/mempool.hxx>
  38
  39 class SwFlyFrm;
  40 class SwFlyFrmFmt;
  41 class SwPageDesc;
  42 class SwCntntFrm;
  43 struct SwPosition;
  44 struct SwCrsrMoveState;
  45 class SdrObject;
  46 class SwAttrSetChg;
  47 class Font;
  48
  49 // OD 2004-05-07 #i28701# - replaced by class <SwSortedObjs>
  50 //SV_DECL_PTRARR_SORT(SwSortDrawObjs,SdrObjectPtr,1,2);
  51 class SwSortedObjs;
  52 // --> OD 2004-07-02 #i28701#
  53 class SwAnchoredObject;
  54 // <--
  55
  56 enum SwPageChg
  57 {
  58     CHG_NEWPAGE,
  59     CHG_CUTPAGE,
  60     CHG_CHGPAGE
  61 };
  62
  63 class SwPageFrm: public SwFtnBossFrm
  64 {
  65     friend class SwFrm;
  66
  67     // OD 2004-05-07 #i28701# - use <SwSortedObjs>
  68     SwSortedObjs *pSortedObjs;
  69
  70     SwPageDesc *pDesc;          //PageDesc der die Seite beschreibt.
  71
  72     USHORT      nPhyPageNum;            //Physikalische Seitennummer.
  73
  74     BOOL bInvalidCntnt          :1;
  75     BOOL bInvalidLayout         :1;
  76     BOOL bInvalidFlyCntnt       :1;
  77     BOOL bInvalidFlyLayout      :1;
  78     BOOL bInvalidFlyInCnt       :1;
  79     BOOL bFtnPage                       :1;     //Diese Seite ist fuer Dokumentende-Fussnoten.
  80     BOOL bEmptyPage                     :1; //Dies ist eine explizite Leerseite
  81     BOOL bEndNotePage       :1; //'Fussnotenseite' fuer Endnoten
  82     BOOL bInvalidSpelling   :1; //Das Online-Spelling ist gefordert
  83     BOOL bInvalidSmartTags :1;  //checking for smarttags is needed  // SMARTTAGS
  84     BOOL bInvalidAutoCmplWrds :1; //Auto-Complete Wordliste aktualisieren
  85     BOOL bInvalidWordCount  :1;
  86     BOOL bHasGrid           :1; // Grid for Asian layout
  87
  88     // OD 2004-05-17 #i28701# - boolean, indicating that layout of page frame
  89     // is in progress.
  90     bool mbLayoutInProgress;
  91
  92     // OD 12.02.2003 #i9719#, #105645#
  93     static const sal_Int8 mnBorderPxWidth;
  94     static const sal_Int8 mnShadowPxWidth;
  95
  96     void _UpdateAttr( SfxPoolItem*, SfxPoolItem*, BYTE &,
  97                       SwAttrSetChg *pa = 0, SwAttrSetChg *pb = 0 );
  98
  99     // Anpassen der max. Fussnotenhoehen in den einzelnen Spalten
 100     void SetColMaxFtnHeight();
 101
 102     /** determine rectangle for page border
 103
 104         OD 12.02.2003 for #i9719# and #105645#
 105
 106         @author OD
 107
 108         @param _rPageRect
 109         input parameter - constant instance reference of the page rectangle.
 110         Generally, it's the frame area of the page, but for empty pages in print
 111         preview, this parameter is useful.
 112
 113         @param _pViewShell
 114         input parameter - instance of the view shell, for which the rectangle
 115         has to be generated.
 116
 117         @param _orBorderRect
 118         output parameter - instance reference of the border rectangle for
 119         the given page rectangle
 120     */
 121     static void GetBorderRect( const SwRect& _rPageRect,
 122                                ViewShell*    _pViewShell,
 123                                SwRect& _orBorderRect,
 124                                bool bRightSidebar );
 125
 126     /** determine rectangle for right page shadow
 127
 128         OD 12.02.2003 for #i9719# and #105645#
 129
 130         @author OD
 131
 132         @param _rPageRect
 133         input parameter - constant instance reference of the page rectangle.
 134         Generally, it's the frame area of the page, but for empty pages in print
 135         preview, this parameter is useful.
 136
 137         @param _pViewShell
 138         input parameter - instance of the view shell, for which the rectangle
 139         has to be generated.
 140
 141         @param _orRightShadowRect
 142         output parameter - instance reference of the right shadow rectangle for
 143         the given page rectangle
 144     */
 145     static void GetRightShadowRect( const SwRect& _rPageRect,
 146                                     ViewShell*    _pViewShell,
 147                                     SwRect&       _orRightShadowRect,
 148                                     bool bRightSidebar );
 149
 150     /** determine rectangle for bottom page shadow
 151
 152         OD 12.02.2003 for #i9719# and #105645#
 153
 154         @author OD
 155
 156         @param _rPageRect
 157         input parameter - constant instance reference of the page rectangle.
 158         Generally, it's the frame area of the page, but for empty pages in print
 159         preview, this parameter is useful.
 160
 161         @param _pViewShell
 162         input parameter - instance of the view shell, for which the rectangle
 163         has to be generated.
 164
 165         @param _orBottomShadowRect
 166         output parameter - instance reference of the bottom shadow rectangle for
 167         the given page rectangle
 168     */
 169
 170     static void GetBottomShadowRect( const SwRect& _rPageRect,
 171                                      ViewShell*    _pViewShell,
 172                                      SwRect&       _orBottomShadowRect,
 173                                      bool bRightSidebar );
 174
 175     /** adds the sidebar used for notes to right and left border
 176         mod 20.10.2007 for #i6193#
 177
 178         @author mod
 179
 180         @param aRect
 181         input parameter - current rect, we change borders if we want a sidebar
 182
 183         @param _pViewShell
 184         input parameter - instance of the view shell, for which the rectangle
 185         has to be generated.
 186
 187         @param bPx
 188         input parameter - if set to true, we add in pixel
 189     */
 190     static void AddSidebarBorders( Rectangle& aRect, ViewShell* _pViewShell, bool bRight, bool bPx = false);
 191     static void AddSidebarBorders(       SwRect& aRect, ViewShell* _pViewShell, bool bRight, bool bPx = false);
 192
 193 protected:
 194     virtual void MakeAll();
 195
 196 public:
 197     DECL_FIXEDMEMPOOL_NEWDEL(SwPageFrm)
 198
 199     SwPageFrm( SwFrmFmt*, SwPageDesc* );
 200     ~SwPageFrm();
 201
 202     //public, damit die ViewShell beim Umschalten vom BrowseMode darauf
 203     //zugreifen kann.
 204     void PrepareHeader();       //Kopf-/Fusszeilen anlegen/entfernen.
 205     void PrepareFooter();
 206
 207     const SwSortedObjs  *GetSortedObjs() const  { return pSortedObjs; }
 208           SwSortedObjs  *GetSortedObjs()          { return pSortedObjs; }
 209
 210     // --> OD 2004-07-02 #i28701# - new methods to append/remove drawing objects
 211     void AppendDrawObjToPage( SwAnchoredObject& _rNewObj );
 212     void RemoveDrawObjFromPage( SwAnchoredObject& _rToRemoveObj );
 213     // <--
 214
 215     void AppendFlyToPage( SwFlyFrm *pNew );
 216     void RemoveFlyFromPage( SwFlyFrm *pToRemove );
 217     void MoveFly( SwFlyFrm *pToMove, SwPageFrm *pDest );//optimiertes Remove/Append
 218
 219     void  SetPageDesc( SwPageDesc *, SwFrmFmt * );
 220           SwPageDesc *GetPageDesc() { return pDesc; }
 221     const SwPageDesc *GetPageDesc() const { return pDesc; }
 222           SwPageDesc *FindPageDesc();
 223
 224                  SwCntntFrm  *FindLastBodyCntnt();
 225     inline               SwCntntFrm      *FindFirstBodyCntnt();
 226     inline const SwCntntFrm  *FindFirstBodyCntnt() const;
 227     inline const SwCntntFrm  *FindLastBodyCntnt() const;
 228
 229     //Spezialisiertes GetCntntPos() fuer Felder in Rahmen.
 230     void GetCntntPosition( const Point &rPt, SwPosition &rPos ) const;
 231
 232     BOOL IsEmptyPage() const { return bEmptyPage; } //explizite Leerseite.
 233
 234     void        UpdateFtnNum();
 235
 236     //Immer nach dem Paste rufen. Erzeugt die Seitengeb. Rahmen und Formatiert
 237     //generischen Inhalt.
 238     void PreparePage( BOOL bFtn );
 239
 240     //Schickt an alle ContentFrames ein Prepare wg. geaenderter Registervorlage
 241     void PrepareRegisterChg();
 242
 243     // --> OD 2005-06-09 #i50432# - adjust method description and synopsis.
 244     // Appends a fly frame - the given one or a new one - at the page frame.
 245     // Needed for <Modify> and <MakeFrms>
 246     // - return value not needed any more
 247     // - second parameter is of type <SwFlyFrmFmt*>
 248     // - third parameter only needed for assertion, but calling method assures
 249     //   this assertion. Thus, delete it.
 250     void PlaceFly( SwFlyFrm* pFly, SwFlyFrmFmt* pFmt );
 251     // <--
 252
 253     virtual BOOL GetCrsrOfst( SwPosition *, Point&,
 254                               SwCrsrMoveState* = 0 ) const;
 255     virtual void Modify( SfxPoolItem*, SfxPoolItem* );
 256         // erfrage vom Client Informationen
 257     virtual BOOL GetInfo( SfxPoolItem& ) const;
 258
 259     virtual void Cut();
 260     virtual void Paste( SwFrm* pParent, SwFrm* pSibling = 0 );
 261     virtual void  CheckDirection( BOOL bVert );
 262     void CheckGrid( BOOL bInvalidate );
 263     void PaintGrid( OutputDevice* pOut, SwRect &rRect ) const;
 264     BOOL HasGrid() const { return bHasGrid; }
 265
 266     //Zeilennummern usw malen
 267     void RefreshExtraData( const SwRect & ) const;
 268
 269     //Hilfslinien malen.
 270     void RefreshSubsidiary( const SwRect& ) const;
 271
 272     //Fussnotenschnittstelle
 273     BOOL IsFtnPage() const                                                                      { return bFtnPage; }
 274     BOOL IsEndNotePage() const                                                          { return bEndNotePage; }
 275     void SetFtnPage( BOOL b )                                                           { bFtnPage = b; }
 276     void SetEndNotePage( BOOL b )                                                       { bEndNotePage = b; }
 277
 278     inline      USHORT GetPhyPageNum() const        { return nPhyPageNum;}
 279     inline      void SetPhyPageNum( USHORT nNum )       { nPhyPageNum = nNum;}
 280     inline      void DecrPhyPageNum()                           { --nPhyPageNum;         }
 281     inline      void IncrPhyPageNum()                           { ++nPhyPageNum;         }
 282
 283     //Validieren, invalidieren und abfragen des Status der Seite.
 284     //Layout/Cntnt und jeweils Fly/nicht Fly werden getrennt betrachtet.
 285     inline void InvalidateFlyLayout() const;
 286     inline void InvalidateFlyCntnt() const;
 287     inline void InvalidateFlyInCnt() const;
 288     inline void InvalidateLayout() const;
 289     inline void InvalidateCntnt() const;
 290     inline void InvalidateSpelling() const;
 291     inline void InvalidateSmartTags() const;
 292     inline void InvalidateAutoCompleteWords() const;
 293     inline void InvalidateWordCount() const;
 294     inline void ValidateFlyLayout() const;
 295     inline void ValidateFlyCntnt() const;
 296     inline void ValidateFlyInCnt() const;
 297     inline void ValidateLayout() const;
 298     inline void ValidateCntnt() const;
 299     inline void ValidateSpelling()      const;
 300     inline void ValidateSmartTags() const;        // SMARTTAGS
 301     inline void ValidateAutoCompleteWords() const;
 302     inline void ValidateWordCount() const;
 303     inline BOOL IsInvalid() const;
 304     inline BOOL IsInvalidFly() const;
 305     BOOL IsInvalidFlyLayout() const { return bInvalidFlyLayout; }
 306     BOOL IsInvalidFlyCntnt() const { return bInvalidFlyCntnt; }
 307     BOOL IsInvalidFlyInCnt() const { return bInvalidFlyInCnt; }
 308     BOOL IsInvalidLayout() const { return bInvalidLayout; }
 309     BOOL IsInvalidCntnt() const { return (bInvalidCntnt || bInvalidFlyInCnt); }
 310     BOOL IsInvalidSpelling() const { return bInvalidSpelling; }
 311     BOOL IsInvalidSmartTags() const { return bInvalidSmartTags; }   // SMARTTAGS
 312     BOOL IsInvalidAutoCompleteWords() const { return bInvalidAutoCmplWrds; }
 313     BOOL IsInvalidWordCount() const { return bInvalidWordCount; }
 314
 315     /** SwPageFrm::GetDrawBackgrdColor - for #102450#
 316
 317         29.08.2002:
 318         determine the color, that is respectively will be drawn as background
 319         for the page frame.
 320
 321         @author OD
 322
 323         @return reference to an instance of class Color
 324     */
 325     const Color& GetDrawBackgrdColor() const;
 326
 327     /** paint margin area of a page
 328
 329         OD 20.11.2002 for #104598#:
 330         implement paint of margin area; margin area will be painted for a
 331         view shell with a window and if the document is not in online layout.
 332
 333         @author OD
 334
 335         @param _rOutputRect
 336         input parameter - constant instance reference of the rectangle, for
 337         which an output has to be generated.
 338
 339         @param _pViewShell
 340         input parameter - instance of the view shell, on which the output
 341         has to be generated.
 342     */
 343     void PaintMarginArea( const SwRect& _rOutputRect,
 344                           ViewShell* _pViewShell ) const;
 345
 346     /** paint page border and shadow
 347
 348         OD 12.02.2003 for #i9719# and #105645#
 349         implement paint of page border and shadow
 350
 351         @author OD
 352
 353         @param _rPageRect
 354         input parameter - constant instance reference of the page rectangle.
 355         Generally, it's the frame area of the page, but for empty pages in print
 356         preview, this parameter is useful.
 357
 358         @param _pViewShell
 359         input parameter - instance of the view shell, on which the output
 360         has to be generated.
 361     */
 362     static void PaintBorderAndShadow( const SwRect& _rPageRect,
 363                                       ViewShell*    _pViewShell,
 364                                       bool bPaintRightShadow,
 365                                       bool bRightSidebar );
 366
 367     /** get bound rectangle of border and shadow for repaints
 368
 369         OD 12.02.2003 for #i9719# and #105645#
 370
 371         author OD
 372
 373         @param _rPageRect
 374         input parameter - constant instance reference of the page rectangle.
 375         Generally, it's the frame area of the page, but for empty pages in print
 376         preview, this parameter is useful.
 377
 378         @param _pViewShell
 379         input parameter - instance of the view shell, for which the rectangle
 380         has to be generated.
 381
 382         @param _orBorderAndShadowBoundRect
 383         output parameter - instance reference of the bounded border and shadow
 384         rectangle for the given page rectangle
 385     */
 386     static void GetBorderAndShadowBoundRect( const SwRect& _rPageRect,
 387                                              ViewShell*    _pViewShell,
 388                                              SwRect& _orBorderAndShadowBoundRect,
 389                                              bool bRightSidebar );
 390
 391     static void PaintNotesSidebar(const SwRect& _rPageRect, ViewShell* _pViewShell, USHORT nPageNum, bool bRight);
 392     static void PaintNotesSidebarArrows(const Point &aMiddleFirst, const Point &aMiddleSecond, ViewShell* _pViewShell, const Color aColorUp, const Color aColorDown);
 393     /**
 394         mod #6i193#
 395
 396         asks the page on which side a margin should be shown, e.g for notes
 397         returns true for left side, false for right side
 398     */
 399     bool MarginSide() const;
 400
 401     virtual bool FillSelection( SwSelectionList& rList, const SwRect& rRect ) const;
 402
 403     // OD 12.02.2003 #i9719#, #105645#
 404     inline sal_Int8 BorderPxWidth() const
 405     {
 406         return mnBorderPxWidth;
 407     }
 408     inline sal_Int8 ShadowPxWidth() const
 409     {
 410         return mnShadowPxWidth;
 411     }
 412
 413     // OD 22.09.2003 #110978#
 414     const SwRect PrtWithoutHeaderAndFooter() const;
 415
 416     // OD 2004-05-17 #i28701#
 417     inline bool IsLayoutInProgress() const
 418     {
 419         return mbLayoutInProgress;
 420     }
 421     inline void SetLayoutInProgress( const bool _bLayoutInProgress )
 422     {
 423         mbLayoutInProgress = _bLayoutInProgress;
 424     }
 425
 426     // in case this is am empty page, this function returns the 'reference' page
 427     const SwPageFrm& GetFormatPage() const;
 428
 429     // return font used to paint the "empty page" string
 430     static const Font& GetEmptyPageFont();
 431
 432     static SwTwips GetSidebarBorderWidth( const ViewShell* );
 433 };
 434
 435 inline SwCntntFrm *SwPageFrm::FindFirstBodyCntnt()
 436 {
 437     SwLayoutFrm *pBody = FindBodyCont();
 438     return pBody ? pBody->ContainsCntnt() : 0;
 439 }
 440 inline const SwCntntFrm *SwPageFrm::FindFirstBodyCntnt() const
 441 {
 442     const SwLayoutFrm *pBody = FindBodyCont();
 443     return pBody ? pBody->ContainsCntnt() : 0;
 444 }
 445 inline const SwCntntFrm *SwPageFrm::FindLastBodyCntnt() const
 446 {
 447     return ((SwPageFrm*)this)->FindLastBodyCntnt();
 448 }
 449 inline void     SwPageFrm::InvalidateFlyLayout() const
 450 {
 451     ((SwPageFrm*)this)->bInvalidFlyLayout = TRUE;
 452 }
 453 inline void     SwPageFrm::InvalidateFlyCntnt() const
 454 {
 455     ((SwPageFrm*)this)->bInvalidFlyCntnt = TRUE;
 456 }
 457 inline void SwPageFrm::InvalidateFlyInCnt() const
 458 {
 459     ((SwPageFrm*)this)->bInvalidFlyInCnt = TRUE;
 460 }
 461 inline void     SwPageFrm::InvalidateLayout() const
 462 {
 463     ((SwPageFrm*)this)->bInvalidLayout = TRUE;
 464 }
 465 inline void     SwPageFrm::InvalidateCntnt() const
 466 {
 467     ((SwPageFrm*)this)->bInvalidCntnt = TRUE;
 468 }
 469 inline void     SwPageFrm::InvalidateSpelling() const
 470 {
 471     ((SwPageFrm*)this)->bInvalidSpelling = TRUE;
 472 }
 473 // SMARTTAGS
 474 inline void    SwPageFrm::InvalidateSmartTags() const
 475 {
 476    ((SwPageFrm*)this)->bInvalidSmartTags = TRUE;
 477 }
 478 inline void     SwPageFrm::InvalidateAutoCompleteWords() const
 479 {
 480     ((SwPageFrm*)this)->bInvalidAutoCmplWrds = TRUE;
 481 }
 482 inline void SwPageFrm::InvalidateWordCount() const
 483 {
 484     ((SwPageFrm*)this)->bInvalidWordCount = TRUE;
 485 }
 486 inline void     SwPageFrm::ValidateFlyLayout() const
 487 {
 488     ((SwPageFrm*)this)->bInvalidFlyLayout = FALSE;
 489 }
 490 inline void     SwPageFrm::ValidateFlyCntnt() const
 491 {
 492     ((SwPageFrm*)this)->bInvalidFlyCntnt = FALSE;
 493 }
 494 inline void SwPageFrm::ValidateFlyInCnt() const
 495 {
 496     ((SwPageFrm*)this)->bInvalidFlyInCnt = FALSE;
 497 }
 498 inline void     SwPageFrm::ValidateLayout() const
 499 {
 500     ((SwPageFrm*)this)->bInvalidLayout = FALSE;
 501 }
 502 inline void     SwPageFrm::ValidateCntnt() const
 503 {
 504     ((SwPageFrm*)this)->bInvalidCntnt = FALSE;
 505 }
 506 inline void     SwPageFrm::ValidateSpelling() const
 507 {
 508     ((SwPageFrm*)this)->bInvalidSpelling = FALSE;
 509 }
 510 // SMARTTAGS
 511 inline void    SwPageFrm::ValidateSmartTags() const
 512 {
 513    ((SwPageFrm*)this)->bInvalidSmartTags = FALSE;
 514 }
 515 inline void SwPageFrm::ValidateAutoCompleteWords() const
 516 {
 517     ((SwPageFrm*)this)->bInvalidAutoCmplWrds = FALSE;
 518 }
 519 inline void SwPageFrm::ValidateWordCount() const
 520 {
 521     ((SwPageFrm*)this)->bInvalidWordCount = FALSE;
 522 }
 523
 524 inline BOOL SwPageFrm::IsInvalid() const
 525 {
 526     return (bInvalidCntnt || bInvalidLayout || bInvalidFlyInCnt);
 527 }
 528 inline BOOL SwPageFrm::IsInvalidFly() const
 529 {
 530     return bInvalidFlyLayout || bInvalidFlyCntnt;
 531 }
 532
 533 #define GETGRID( pPage ) const SwTextGridItem *pGrid = NULL; \
 534  {if( pPage && pPage->HasGrid() && GRID_NONE==(pGrid=(SwTextGridItem*)&pPage->\
 535      GetPageDesc()->GetMaster().GetFmtAttr(RES_TEXTGRID))->GetGridType() ) \
 536     pGrid = NULL;}
 537
 538 #define GETGRIDWIDTH( pGrid , pDoc )  pDoc->IsSquaredPageMode() ? \
 539     pGrid->GetBaseHeight(): pGrid->GetBaseWidth()
 540
 541
 542
 543 #endif  //_PAGEFRM_HXX