sw/source/core/inc/pagefrm.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef INCLUDED_SW_SOURCE_CORE_INC_PAGEFRM_HXX
  20 #define INCLUDED_SW_SOURCE_CORE_INC_PAGEFRM_HXX
  21
  22 #include <viewsh.hxx>
  23 #include "ftnboss.hxx"
  24 #include "hffrm.hxx"
  25
  26 #include <SidebarWindowsTypes.hxx>
  27
  28 class SwFlyFrame;
  29 class SwFlyFrameFormat;
  30 class SwPageDesc;
  31 class SwContentFrame;
  32 struct SwPosition;
  33 struct SwCursorMoveState;
  34 class SwAttrSetChg;
  35 namespace vcl { class Font; }
  36 class SwSortedObjs;
  37 class SwAnchoredObject;
  38
  39 /// A page of the document layout. Upper frame is expected to be an SwRootFrame
  40 /// instance. At least an SwBodyFrame lower is expected.
  41 class SAL_DLLPUBLIC_RTTI SwPageFrame: public SwFootnoteBossFrame
  42 {
  43     friend class SwFrame;
  44
  45     std::unique_ptr<SwSortedObjs> m_pSortedObjs;
  46
  47     SwPageDesc *m_pDesc; //PageDesc that describes the Page
  48
  49     /// Physical page number: index into list of SwRootFrame lowers
  50     sal_uInt16  m_nPhyPageNum;
  51
  52     bool m_bInvalidContent      :1;
  53     bool m_bInvalidLayout       :1;
  54     bool m_bInvalidFlyContent   :1;
  55     bool m_bInvalidFlyLayout    :1;
  56     bool m_bInvalidFlyInCnt     :1;
  57     bool m_bFootnotePage        :1; // This Page is for document end footnotes
  58     bool m_bEmptyPage           :1; // This Page is an explicitly empty page
  59     bool m_bEndNotePage         :1; // 'Footnote page' for end notes
  60     bool m_bInvalidSpelling     :1; // We need online spelling
  61     bool m_bInvalidSmartTags    :1; // We need checking for smarttags
  62     bool m_bInvalidAutoCmplWrds :1; // Update auto complete word list
  63     bool m_bInvalidWordCount    :1;
  64     bool m_bHasGrid             :1; // Grid for Asian layout
  65
  66     static const sal_Int8 mnShadowPxWidth;
  67
  68     void UpdateAttr_( const SfxPoolItem*, const SfxPoolItem*, sal_uInt8 &,
  69                       SwAttrSetChg *pa = nullptr, SwAttrSetChg *pb = nullptr );
  70
  71     /// Adapt the max. footnote height in each single column
  72     void SetColMaxFootnoteHeight();
  73
  74     /** determine rectangle for horizontal page shadow
  75
  76         #i9719#
  77
  78         @param _rPageRect
  79         input parameter - constant instance reference of the page rectangle.
  80         Generally, it's the frame area of the page, but for empty pages in print
  81         preview, this parameter is useful.
  82
  83         @param _pViewShell
  84         input parameter - instance of the view shell, for which the rectangle
  85         has to be generated.
  86
  87         @param _orBottomShadowRect
  88         output parameter - instance reference of the bottom shadow rectangle for
  89         the given page rectangle
  90     */
  91
  92     static void GetHorizontalShadowRect( const SwRect& _rPageRect,
  93                                      const SwViewShell*    _pViewShell,
  94                                      OutputDevice const * pRenderContext,
  95                                      SwRect&       _orBottomShadowRect,
  96                                      bool bPaintLeftShadow,
  97                                      bool bPaintRightShadow,
  98                                      bool bRightSidebar );
  99
 100     virtual void DestroyImpl() override;
 101     virtual ~SwPageFrame() override;
 102
 103 protected:
 104     virtual void MakeAll(vcl::RenderContext* pRenderContext) override;
 105     virtual void Modify( const SfxPoolItem*, const SfxPoolItem* ) override;
 106     virtual void SwClientNotify(const SwModify&, const SfxHint&) override;
 107
 108     /// Calculate the content height of a page (without columns).
 109     size_t GetContentHeight(const tools::Long nTop, const tools::Long nBottom) const;
 110
 111 public:
 112     SwPageFrame( SwFrameFormat*, SwFrame*, SwPageDesc* );
 113
 114     /// Make this public, so that the SwViewShell can access it when switching from browse mode
 115     /// Add/remove header/footer
 116     void PrepareHeader();
 117     void PrepareFooter();
 118
 119     const SwSortedObjs *GetSortedObjs() const { return m_pSortedObjs.get(); }
 120           SwSortedObjs *GetSortedObjs()       { return m_pSortedObjs.get(); }
 121
 122     void AppendDrawObjToPage( SwAnchoredObject& _rNewObj );
 123     void RemoveDrawObjFromPage( SwAnchoredObject& _rToRemoveObj );
 124
 125     void AppendFlyToPage( SwFlyFrame *pNew );
 126     void RemoveFlyFromPage( SwFlyFrame *pToRemove );
 127     void MoveFly( SwFlyFrame *pToMove, SwPageFrame *pDest ); // Optimized Remove/Append
 128
 129     void  SetPageDesc( SwPageDesc *, SwFrameFormat * );
 130           SwPageDesc *GetPageDesc() { return m_pDesc; }
 131     const SwPageDesc *GetPageDesc() const { return m_pDesc; }
 132           SwPageDesc *FindPageDesc();
 133
 134                  SwContentFrame  *FindLastBodyContent();
 135     inline       SwContentFrame  *FindFirstBodyContent();
 136     inline const SwContentFrame  *FindFirstBodyContent() const;
 137     inline const SwContentFrame  *FindLastBodyContent() const;
 138
 139     SwRect GetBoundRect(OutputDevice const * pOutputDevice) const;
 140
 141     // Specialized GetContentPos() for Field in Frames
 142     void GetContentPosition( const Point &rPt, SwPosition &rPos ) const;
 143
 144     bool IsEmptyPage() const { return m_bEmptyPage; } // Explicitly empty page
 145
 146     void    UpdateFootnoteNum();
 147
 148     /// Always call after Paste
 149     /// Creates the page-bound frames and formats the generic content
 150     void PreparePage( bool bFootnote );
 151
 152     // Sends a Prepare() to all ContentFrames caused by a changed register template
 153     void PrepareRegisterChg();
 154
 155     // Appends a fly frame - the given one or a new one - at the page frame.
 156     // Needed for <Modify> and <MakeFrames>
 157     // - return value not needed any more
 158     // - second parameter is of type <SwFlyFrameFormat*>
 159     // - third parameter only needed for assertion, but calling method assures
 160     //   this assertion. Thus, delete it.
 161     void PlaceFly( SwFlyFrame* pFly, SwFlyFrameFormat* pFormat );
 162
 163     virtual bool GetModelPositionForViewPoint( SwPosition *, Point&,
 164                               SwCursorMoveState* = nullptr, bool bTestBackground = false ) const override;
 165     /// Get info from Client
 166     virtual bool GetInfo( SfxPoolItem& ) const override;
 167
 168     virtual void Cut() override;
 169     virtual void Paste( SwFrame* pParent, SwFrame* pSibling = nullptr ) override;
 170     virtual void CheckDirection( bool bVert ) override;
 171     void CheckGrid( bool bInvalidate );
 172     void PaintGrid( OutputDevice const * pOut, SwRect const &rRect ) const;
 173     bool HasGrid() const { return m_bHasGrid; }
 174
 175     void PaintDecorators( ) const;
 176     virtual void PaintSubsidiaryLines( const SwPageFrame*, const SwRect& ) const override;
 177     virtual void PaintBreak() const override;
 178
 179     /// Paint line number etc.
 180     void RefreshExtraData( const SwRect & ) const;
 181
 182     /// Paint helper lines
 183     void RefreshSubsidiary( const SwRect& ) const;
 184
 185     /// Foot note interface
 186     bool IsFootnotePage() const                          { return m_bFootnotePage; }
 187     bool IsEndNotePage() const                      { return m_bEndNotePage; }
 188     void SetFootnotePage( bool b )                       { m_bFootnotePage = b; }
 189     void SetEndNotePage( bool b )                   { m_bEndNotePage = b; }
 190
 191     sal_uInt16 GetPhyPageNum() const        { return m_nPhyPageNum;}
 192     void SetPhyPageNum( sal_uInt16 nNum )   { m_nPhyPageNum = nNum;}
 193
 194     /// Validate, invalidate and query the Page status
 195     /// Layout/Content and Fly/non-Fly respectively are inspected separately
 196     inline void InvalidateFlyLayout() const;
 197     inline void InvalidateFlyContent() const;
 198     inline void InvalidateFlyInCnt() const;
 199     inline void InvalidateLayout() const;
 200     inline void InvalidateContent() const;
 201     inline void InvalidateSpelling() const;
 202     inline void InvalidateSmartTags() const;
 203     inline void InvalidateAutoCompleteWords() const;
 204     inline void InvalidateWordCount() const;
 205     inline void ValidateFlyLayout() const;
 206     inline void ValidateFlyContent() const;
 207     inline void ValidateFlyInCnt() const;
 208     inline void ValidateLayout() const;
 209     inline void ValidateContent() const;
 210     inline void ValidateSpelling()  const;
 211     inline void ValidateSmartTags() const;
 212     inline void ValidateAutoCompleteWords() const;
 213     inline void ValidateWordCount() const;
 214     inline bool IsInvalid() const;
 215     inline bool IsInvalidFly() const;
 216     bool IsRightShadowNeeded() const;
 217     bool IsLeftShadowNeeded() const;
 218     bool IsInvalidFlyLayout() const { return m_bInvalidFlyLayout; }
 219     bool IsInvalidFlyContent() const { return m_bInvalidFlyContent; }
 220     bool IsInvalidFlyInCnt() const { return m_bInvalidFlyInCnt; }
 221     bool IsInvalidLayout() const { return m_bInvalidLayout; }
 222     bool IsInvalidContent() const { return (m_bInvalidContent || m_bInvalidFlyInCnt); }
 223     bool IsInvalidSpelling() const { return m_bInvalidSpelling; }
 224     bool IsInvalidSmartTags() const { return m_bInvalidSmartTags; }
 225     bool IsInvalidAutoCompleteWords() const { return m_bInvalidAutoCmplWrds; }
 226     bool IsInvalidWordCount() const { return m_bInvalidWordCount; }
 227
 228     /** SwPageFrame::GetDrawBackgrdColor
 229
 230         determine the color, that is respectively will be drawn as background
 231         for the page frame.
 232
 233         @return reference to an instance of class Color
 234     */
 235     Color GetDrawBackgrdColor() const;
 236
 237     /** paint margin area of a page
 238
 239         implement paint of margin area; margin area will be painted for a
 240         view shell with a window and if the document is not in online layout.
 241
 242         @param _rOutputRect
 243         input parameter - constant instance reference of the rectangle, for
 244         which an output has to be generated.
 245
 246         @param _pViewShell
 247         input parameter - instance of the view shell, on which the output
 248         has to be generated.
 249     */
 250     void PaintMarginArea( const SwRect& _rOutputRect,
 251                           SwViewShell const * _pViewShell ) const;
 252
 253     /** paint page border and shadow
 254
 255         @param _rPageRect
 256         input parameter - constant instance reference of the page rectangle.
 257         Generally, it's the frame area of the page, but for empty pages in print
 258         preview, this parameter is useful.
 259
 260         @param _pViewShell
 261         input parameter - instance of the view shell, on which the output
 262         has to be generated.
 263
 264         @param bPaintRightShadow
 265         Should we paint shadow on the right or not (used in book mode)
 266
 267         @param bFullBottomShadow
 268         Should we have a bottom shadow of the same size as the pages or
 269         not (for right pages in book mode in a LTR environment).
 270
 271         @param bRightSidebar
 272         Is the note sidebar on the right or not (used to adjust the
 273         shadow with & position).
 274     */
 275     static void PaintBorderAndShadow( const SwRect& _rPageRect,
 276                                       const SwViewShell*    _pViewShell,
 277                                       bool bPaintLeftShadow,
 278                                       bool bPaintRightShadow,
 279                                       bool bRightSidebar );
 280
 281     /** get bound rectangle of border and shadow for repaints
 282
 283         @param _rPageRect
 284         input parameter - constant instance reference of the page rectangle.
 285         Generally, it's the frame area of the page, but for empty pages in print
 286         preview, this parameter is useful.
 287
 288         @param _pViewShell
 289         input parameter - instance of the view shell, for which the rectangle
 290         has to be generated.
 291
 292         @param _orBorderAndShadowBoundRect
 293         output parameter - instance reference of the bounded border and shadow
 294         rectangle for the given page rectangle
 295     */
 296     static void GetBorderAndShadowBoundRect( const SwRect& _rPageRect,
 297                                              const SwViewShell*    _pViewShell,
 298                                              OutputDevice const * pRenderContext,
 299                                              SwRect& _orBorderAndShadowBoundRect,
 300                                              const bool bLeftShadow,
 301                                              const bool bRightShadow,
 302                                              const bool bRightSidebar
 303                                             );
 304
 305     static void PaintNotesSidebar(const SwRect& _rPageRect, SwViewShell* _pViewShell, sal_uInt16 nPageNum, bool bRight);
 306     static void PaintNotesSidebarArrows(const Point &rMiddleFirst, const Point &rMiddleSecond, SwViewShell const * _pViewShell, const Color& rColorUp, const Color& rColorDown);
 307     /**
 308         asks the page on which side a margin should be shown, e.g for notes
 309         returns true for left side, false for right side
 310     */
 311     sw::sidebarwindows::SidebarPosition SidebarPosition() const;
 312
 313     virtual bool FillSelection( SwSelectionList& rList, const SwRect& rRect ) const override;
 314
 315     SwRect PrtWithoutHeaderAndFooter() const;
 316
 317     // in case this is an empty page, this function returns the 'reference' page
 318     const SwPageFrame& GetFormatPage() const;
 319
 320     /// If in header or footer area, it also indicates the exact area in rControl.
 321     /// Header or footer must be active, otherwise returns false.
 322     bool IsOverHeaderFooterArea( const Point& rPt, FrameControlType &rControl ) const;
 323
 324     // return font used to paint the "empty page" string
 325     static const vcl::Font& GetEmptyPageFont();
 326
 327     static SwTwips GetSidebarBorderWidth( const SwViewShell* );
 328
 329     /// Is bottom-of-page-frame - bottom-of-text-frame difference valid in case whitespace is hidden?
 330     /// If false is returned, then the caller should handle negative difference as (at least) zero difference instead.
 331     bool CheckPageHeightValidForHideWhitespace(SwTwips nDiff);
 332
 333     const SwHeaderFrame* GetHeaderFrame() const;
 334     const SwFooterFrame* GetFooterFrame() const;
 335 };
 336
 337 inline SwContentFrame *SwPageFrame::FindFirstBodyContent()
 338 {
 339     SwLayoutFrame *pBody = FindBodyCont();
 340     return pBody ? pBody->ContainsContent() : nullptr;
 341 }
 342 inline const SwContentFrame *SwPageFrame::FindFirstBodyContent() const
 343 {
 344     const SwLayoutFrame *pBody = FindBodyCont();
 345     return pBody ? pBody->ContainsContent() : nullptr;
 346 }
 347 inline const SwContentFrame *SwPageFrame::FindLastBodyContent() const
 348 {
 349     return const_cast<SwPageFrame*>(this)->FindLastBodyContent();
 350 }
 351 inline void SwPageFrame::InvalidateFlyLayout() const
 352 {
 353     const_cast<SwPageFrame*>(this)->m_bInvalidFlyLayout = true;
 354 }
 355 inline void SwPageFrame::InvalidateFlyContent() const
 356 {
 357     const_cast<SwPageFrame*>(this)->m_bInvalidFlyContent = true;
 358 }
 359 inline void SwPageFrame::InvalidateFlyInCnt() const
 360 {
 361     const_cast<SwPageFrame*>(this)->m_bInvalidFlyInCnt = true;
 362 }
 363 inline void SwPageFrame::InvalidateLayout() const
 364 {
 365     const_cast<SwPageFrame*>(this)->m_bInvalidLayout = true;
 366 }
 367 inline void SwPageFrame::InvalidateContent() const
 368 {
 369     const_cast<SwPageFrame*>(this)->m_bInvalidContent = true;
 370 }
 371 inline void SwPageFrame::InvalidateSpelling() const
 372 {
 373     const_cast<SwPageFrame*>(this)->m_bInvalidSpelling = true;
 374 }
 375
 376 inline void SwPageFrame::InvalidateSmartTags() const
 377 {
 378    const_cast<SwPageFrame*>(this)->m_bInvalidSmartTags = true;
 379 }
 380 inline void SwPageFrame::InvalidateAutoCompleteWords() const
 381 {
 382     const_cast<SwPageFrame*>(this)->m_bInvalidAutoCmplWrds = true;
 383 }
 384 inline void SwPageFrame::InvalidateWordCount() const
 385 {
 386     const_cast<SwPageFrame*>(this)->m_bInvalidWordCount = true;
 387 }
 388 inline void SwPageFrame::ValidateFlyLayout() const
 389 {
 390     const_cast<SwPageFrame*>(this)->m_bInvalidFlyLayout = false;
 391 }
 392 inline void SwPageFrame::ValidateFlyContent() const
 393 {
 394     const_cast<SwPageFrame*>(this)->m_bInvalidFlyContent = false;
 395 }
 396 inline void SwPageFrame::ValidateFlyInCnt() const
 397 {
 398     const_cast<SwPageFrame*>(this)->m_bInvalidFlyInCnt = false;
 399 }
 400 inline void SwPageFrame::ValidateLayout() const
 401 {
 402     const_cast<SwPageFrame*>(this)->m_bInvalidLayout = false;
 403 }
 404 inline void SwPageFrame::ValidateContent() const
 405 {
 406     const_cast<SwPageFrame*>(this)->m_bInvalidContent = false;
 407 }
 408 inline void SwPageFrame::ValidateSpelling() const
 409 {
 410     const_cast<SwPageFrame*>(this)->m_bInvalidSpelling = false;
 411 }
 412
 413 inline void SwPageFrame::ValidateSmartTags() const
 414 {
 415    const_cast<SwPageFrame*>(this)->m_bInvalidSmartTags = false;
 416 }
 417 inline void SwPageFrame::ValidateAutoCompleteWords() const
 418 {
 419     const_cast<SwPageFrame*>(this)->m_bInvalidAutoCmplWrds = false;
 420 }
 421 inline void SwPageFrame::ValidateWordCount() const
 422 {
 423     const_cast<SwPageFrame*>(this)->m_bInvalidWordCount = false;
 424 }
 425
 426 inline bool SwPageFrame::IsInvalid() const
 427 {
 428     return (m_bInvalidContent || m_bInvalidLayout || m_bInvalidFlyInCnt);
 429 }
 430 inline bool SwPageFrame::IsInvalidFly() const
 431 {
 432     return m_bInvalidFlyLayout || m_bInvalidFlyContent;
 433 }
 434
 435
 436 class SwTextGridItem;
 437
 438 SwTextGridItem const* GetGridItem(SwPageFrame const*const);
 439
 440 sal_uInt16 GetGridWidth(SwTextGridItem const&, SwDoc const&);
 441
 442 namespace sw { bool IsPageFrameEmpty(SwPageFrame const& rPage); }
 443
 444
 445 #endif // INCLUDED_SW_SOURCE_CORE_INC_PAGEFRM_HXX
 446
 447 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */