470 lines
18 KiB
C++
470 lines
18 KiB
C++
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
|
|
/*
|
|
* This file is part of the LibreOffice project.
|
|
*
|
|
* This Source Code Form is subject to the terms of the Mozilla Public
|
|
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
|
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
|
|
*
|
|
* This file incorporates work covered by the following license notice:
|
|
*
|
|
* Licensed to the Apache Software Foundation (ASF) under one or more
|
|
* contributor license agreements. See the NOTICE file distributed
|
|
* with this work for additional information regarding copyright
|
|
* ownership. The ASF licenses this file to you under the Apache
|
|
* License, Version 2.0 (the "License"); you may not use this file
|
|
* except in compliance with the License. You may obtain a copy of
|
|
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
|
|
*/
|
|
#ifndef INCLUDED_SW_SOURCE_CORE_INC_PAGEFRM_HXX
|
|
#define INCLUDED_SW_SOURCE_CORE_INC_PAGEFRM_HXX
|
|
|
|
#include <viewsh.hxx>
|
|
#include <swdllapi.h>
|
|
#include "ftnboss.hxx"
|
|
#include "hffrm.hxx"
|
|
|
|
#include <SidebarWindowsTypes.hxx>
|
|
|
|
class SwFlyFrame;
|
|
class SwFlyFrameFormat;
|
|
class SwPageDesc;
|
|
class SwContentFrame;
|
|
struct SwPosition;
|
|
struct SwCursorMoveState;
|
|
class SwAttrSetChg;
|
|
namespace vcl { class Font; }
|
|
class SwSortedObjs;
|
|
class SwAnchoredObject;
|
|
namespace sw {
|
|
class VirtPageNumHint;
|
|
}
|
|
|
|
enum class SwPageFrameInvFlags : sal_uInt8
|
|
{
|
|
NONE = 0x00,
|
|
InvalidatePrt = 0x01,
|
|
SetCompletePaint = 0x02,
|
|
InvalidateNextPos = 0x04,
|
|
PrepareHeader = 0x08,
|
|
PrepareFooter = 0x10,
|
|
CheckGrid = 0x20,
|
|
InvalidateGrid = 0x40,
|
|
};
|
|
|
|
namespace o3tl {
|
|
template<> struct typed_flags<SwPageFrameInvFlags> : is_typed_flags<SwPageFrameInvFlags, 0x007f> {};
|
|
}
|
|
|
|
/// A page of the document layout. Upper frame is expected to be an SwRootFrame
|
|
/// instance. At least an SwBodyFrame lower is expected.
|
|
class SW_DLLPUBLIC SwPageFrame final: public SwFootnoteBossFrame
|
|
{
|
|
friend class SwFrame;
|
|
|
|
std::unique_ptr<SwSortedObjs> m_pSortedObjs;
|
|
|
|
SwPageDesc *m_pDesc; //PageDesc that describes the Page
|
|
|
|
/// Physical page number: index into list of SwRootFrame lowers
|
|
sal_uInt16 m_nPhyPageNum;
|
|
|
|
bool m_bInvalidContent :1;
|
|
bool m_bInvalidLayout :1;
|
|
bool m_bInvalidFlyContent :1;
|
|
bool m_bInvalidFlyLayout :1;
|
|
bool m_bInvalidFlyInCnt :1;
|
|
bool m_bFootnotePage :1; // This Page is for document end footnotes
|
|
bool m_bEmptyPage :1; // This Page is an explicitly empty page
|
|
bool m_bEndNotePage :1; // 'Footnote page' for end notes
|
|
bool m_bInvalidSpelling :1; // We need online spelling
|
|
bool m_bInvalidSmartTags :1; // We need checking for smarttags
|
|
bool m_bInvalidAutoCmplWrds :1; // Update auto complete word list
|
|
bool m_bInvalidWordCount :1;
|
|
bool m_bHasGrid :1; // Grid for Asian layout
|
|
|
|
static const sal_Int8 snShadowPxWidth;
|
|
|
|
void UpdateAttr_( const SfxPoolItem*, const SfxPoolItem*, SwPageFrameInvFlags &,
|
|
SwAttrSetChg *pa = nullptr, SwAttrSetChg *pb = nullptr );
|
|
void UpdateAttrForFormatChange( SwFormat* pOldFormat, SwFormat* pNewFormat, SwPageFrameInvFlags & );
|
|
|
|
/// Adapt the max. footnote height in each single column
|
|
void SetColMaxFootnoteHeight();
|
|
|
|
/** determine rectangle for horizontal page shadow
|
|
|
|
#i9719#
|
|
|
|
@param _rPageRect
|
|
input parameter - constant instance reference of the page rectangle.
|
|
Generally, it's the frame area of the page, but for empty pages in print
|
|
preview, this parameter is useful.
|
|
|
|
@param _pViewShell
|
|
input parameter - instance of the view shell, for which the rectangle
|
|
has to be generated.
|
|
|
|
@param _orBottomShadowRect
|
|
output parameter - instance reference of the bottom shadow rectangle for
|
|
the given page rectangle
|
|
*/
|
|
|
|
static void GetHorizontalShadowRect( const SwRect& _rPageRect,
|
|
const SwViewShell* _pViewShell,
|
|
OutputDevice const * pRenderContext,
|
|
SwRect& _orBottomShadowRect,
|
|
bool bPaintLeftShadow,
|
|
bool bPaintRightShadow,
|
|
bool bRightSidebar );
|
|
|
|
virtual void DestroyImpl() override;
|
|
virtual ~SwPageFrame() override;
|
|
virtual void MakeAll(vcl::RenderContext* pRenderContext) override;
|
|
virtual void SwClientNotify(const SwModify&, const SfxHint&) override;
|
|
|
|
/// Calculate the content height of a page (without columns).
|
|
size_t GetContentHeight(const tools::Long nTop, const tools::Long nBottom) const;
|
|
|
|
std::vector<basegfx::B2DPolygon> GetSubsidiaryLinesPolygons(const SwViewShell& rViewShell) const;
|
|
|
|
public:
|
|
SwPageFrame( SwFrameFormat*, SwFrame*, SwPageDesc* );
|
|
|
|
/// Make this public, so that the SwViewShell can access it when switching from browse mode
|
|
/// Add/remove header/footer
|
|
void PrepareHeader();
|
|
void PrepareFooter();
|
|
|
|
const SwSortedObjs *GetSortedObjs() const { return m_pSortedObjs.get(); }
|
|
SwSortedObjs *GetSortedObjs() { return m_pSortedObjs.get(); }
|
|
|
|
void AppendDrawObjToPage( SwAnchoredObject& _rNewObj );
|
|
void RemoveDrawObjFromPage( SwAnchoredObject& _rToRemoveObj );
|
|
|
|
void AppendFlyToPage( SwFlyFrame *pNew );
|
|
void RemoveFlyFromPage( SwFlyFrame *pToRemove );
|
|
void MoveFly( SwFlyFrame *pToMove, SwPageFrame *pDest ); // Optimized Remove/Append
|
|
|
|
void SetPageDesc( SwPageDesc *, SwFrameFormat * );
|
|
SwPageDesc *GetPageDesc() { return m_pDesc; }
|
|
const SwPageDesc *GetPageDesc() const { return m_pDesc; }
|
|
SwPageDesc *FindPageDesc();
|
|
|
|
SwContentFrame *FindLastBodyContent();
|
|
inline SwContentFrame *FindFirstBodyContent();
|
|
inline const SwContentFrame *FindFirstBodyContent() const;
|
|
inline const SwContentFrame *FindLastBodyContent() const;
|
|
|
|
SwRect GetBoundRect(OutputDevice const * pOutputDevice) const;
|
|
|
|
// Specialized GetContentPos() for Field in Frames
|
|
void GetContentPosition( const Point &rPt, SwPosition &rPos ) const;
|
|
|
|
bool IsEmptyPage() const { return m_bEmptyPage; } // Explicitly empty page
|
|
|
|
void UpdateFootnoteNum();
|
|
|
|
/// Always call after Paste
|
|
/// Creates the page-bound frames and formats the generic content
|
|
void PreparePage( bool bFootnote );
|
|
|
|
// Sends a Prepare() to all ContentFrames caused by a changed register template
|
|
void PrepareRegisterChg();
|
|
|
|
// Appends a fly frame - the given one or a new one - at the page frame.
|
|
// Needed for <Modify> and <MakeFrames>
|
|
// - return value not needed any more
|
|
// - second parameter is of type <SwFlyFrameFormat*>
|
|
// - third parameter only needed for assertion, but calling method assures
|
|
// this assertion. Thus, delete it.
|
|
void PlaceFly( SwFlyFrame* pFly, SwFlyFrameFormat* pFormat );
|
|
|
|
virtual bool GetModelPositionForViewPoint( SwPosition *, Point&,
|
|
SwCursorMoveState* = nullptr, bool bTestBackground = false ) const override;
|
|
virtual void Cut() override;
|
|
virtual void Paste( SwFrame* pParent, SwFrame* pSibling = nullptr ) override;
|
|
virtual void CheckDirection( bool bVert ) override;
|
|
void CheckGrid( bool bInvalidate );
|
|
void PaintGrid( OutputDevice const * pOut, SwRect const &rRect ) const;
|
|
bool HasGrid() const { return m_bHasGrid; }
|
|
|
|
void PaintDecorators( ) const;
|
|
virtual void PaintSubsidiaryLines( const SwPageFrame*, const SwRect& ) const override;
|
|
void AddSubsidiaryLinesBounds(const SwViewShell& rShell, RectangleVector& rRects) const;
|
|
virtual void PaintBreak() const override;
|
|
|
|
/// Paint line number etc.
|
|
void RefreshExtraData( const SwRect & ) const;
|
|
|
|
/// Paint helper lines
|
|
void RefreshSubsidiary( const SwRect& ) const;
|
|
|
|
/// Foot note interface
|
|
bool IsFootnotePage() const { return m_bFootnotePage; }
|
|
bool IsEndNotePage() const { return m_bEndNotePage; }
|
|
void SetFootnotePage( bool b ) { m_bFootnotePage = b; }
|
|
void SetEndNotePage( bool b ) { m_bEndNotePage = b; }
|
|
SwSectionFrame* GetEndNoteSection();
|
|
|
|
sal_uInt16 GetPhyPageNum() const { return m_nPhyPageNum;}
|
|
void SetPhyPageNum( sal_uInt16 nNum ) { m_nPhyPageNum = nNum;}
|
|
|
|
/// Validate, invalidate and query the Page status
|
|
/// Layout/Content and Fly/non-Fly respectively are inspected separately
|
|
inline void InvalidateFlyLayout() const;
|
|
inline void InvalidateFlyContent() const;
|
|
inline void InvalidateFlyInCnt() const;
|
|
inline void InvalidateLayout() const;
|
|
inline void InvalidateContent() const;
|
|
inline void InvalidateSpelling() const;
|
|
inline void InvalidateSmartTags() const;
|
|
inline void InvalidateAutoCompleteWords() const;
|
|
inline void InvalidateWordCount() const;
|
|
inline void ValidateFlyLayout() const;
|
|
inline void ValidateFlyContent() const;
|
|
inline void ValidateFlyInCnt() const;
|
|
inline void ValidateLayout() const;
|
|
inline void ValidateContent() const;
|
|
inline void ValidateSpelling() const;
|
|
inline void ValidateSmartTags() const;
|
|
inline void ValidateAutoCompleteWords() const;
|
|
inline void ValidateWordCount() const;
|
|
inline bool IsInvalid() const;
|
|
inline bool IsInvalidFly() const;
|
|
bool IsRightShadowNeeded() const;
|
|
bool IsLeftShadowNeeded() const;
|
|
bool IsInvalidFlyLayout() const { return m_bInvalidFlyLayout; }
|
|
bool IsInvalidFlyContent() const { return m_bInvalidFlyContent; }
|
|
bool IsInvalidFlyInCnt() const { return m_bInvalidFlyInCnt; }
|
|
bool IsInvalidLayout() const { return m_bInvalidLayout; }
|
|
bool IsInvalidContent() const { return (m_bInvalidContent || m_bInvalidFlyInCnt); }
|
|
bool IsInvalidSpelling() const { return m_bInvalidSpelling; }
|
|
bool IsInvalidSmartTags() const { return m_bInvalidSmartTags; }
|
|
bool IsInvalidAutoCompleteWords() const { return m_bInvalidAutoCmplWrds; }
|
|
bool IsInvalidWordCount() const { return m_bInvalidWordCount; }
|
|
|
|
/** SwPageFrame::GetDrawBackgroundColor
|
|
|
|
determine the color, that is respectively will be drawn as background
|
|
for the page frame.
|
|
|
|
@return reference to an instance of class Color
|
|
*/
|
|
Color GetDrawBackgroundColor() const;
|
|
|
|
/** paint margin area of a page
|
|
|
|
implement paint of margin area; margin area will be painted for a
|
|
view shell with a window and if the document is not in online layout.
|
|
|
|
@param _rOutputRect
|
|
input parameter - constant instance reference of the rectangle, for
|
|
which an output has to be generated.
|
|
|
|
@param _pViewShell
|
|
input parameter - instance of the view shell, on which the output
|
|
has to be generated.
|
|
*/
|
|
void PaintMarginArea( const SwRect& _rOutputRect,
|
|
SwViewShell const * _pViewShell ) const;
|
|
|
|
/** paint page border and shadow
|
|
|
|
@param _rPageRect
|
|
input parameter - constant instance reference of the page rectangle.
|
|
Generally, it's the frame area of the page, but for empty pages in print
|
|
preview, this parameter is useful.
|
|
|
|
@param _pViewShell
|
|
input parameter - instance of the view shell, on which the output
|
|
has to be generated.
|
|
|
|
@param bPaintRightShadow
|
|
Should we paint shadow on the right or not (used in book mode)
|
|
|
|
@param bFullBottomShadow
|
|
Should we have a bottom shadow of the same size as the pages or
|
|
not (for right pages in book mode in a LTR environment).
|
|
|
|
@param bRightSidebar
|
|
Is the note sidebar on the right or not (used to adjust the
|
|
shadow with & position).
|
|
*/
|
|
static void PaintBorderAndShadow( const SwRect& _rPageRect,
|
|
const SwViewShell* _pViewShell,
|
|
bool bPaintLeftShadow,
|
|
bool bPaintRightShadow,
|
|
bool bRightSidebar );
|
|
|
|
/** get bound rectangle of border and shadow for repaints
|
|
|
|
@param _rPageRect
|
|
input parameter - constant instance reference of the page rectangle.
|
|
Generally, it's the frame area of the page, but for empty pages in print
|
|
preview, this parameter is useful.
|
|
|
|
@param _pViewShell
|
|
input parameter - instance of the view shell, for which the rectangle
|
|
has to be generated.
|
|
|
|
@param _orBorderAndShadowBoundRect
|
|
output parameter - instance reference of the bounded border and shadow
|
|
rectangle for the given page rectangle
|
|
*/
|
|
static void GetBorderAndShadowBoundRect( const SwRect& _rPageRect,
|
|
const SwViewShell* _pViewShell,
|
|
OutputDevice const * pRenderContext,
|
|
SwRect& _orBorderAndShadowBoundRect,
|
|
const bool bLeftShadow,
|
|
const bool bRightShadow,
|
|
const bool bRightSidebar
|
|
);
|
|
|
|
static void PaintNotesSidebar(const SwRect& _rPageRect, SwViewShell* _pViewShell, sal_uInt16 nPageNum, bool bRight);
|
|
static void PaintNotesSidebarArrows(const Point &rMiddleFirst, const Point &rMiddleSecond, SwViewShell const * _pViewShell, const Color& rColorUp, const Color& rColorDown);
|
|
/**
|
|
asks the page on which side a margin should be shown, e.g for notes
|
|
returns true for left side, false for right side
|
|
*/
|
|
sw::sidebarwindows::SidebarPosition SidebarPosition() const;
|
|
|
|
virtual bool FillSelection( SwSelectionList& rList, const SwRect& rRect ) const override;
|
|
|
|
SwRect PrtWithoutHeaderAndFooter() const;
|
|
|
|
// in case this is an empty page, this function returns the 'reference' page
|
|
const SwPageFrame& GetFormatPage() const;
|
|
|
|
/// If in header or footer area, it also indicates the exact area in rControl.
|
|
/// Header or footer must be active, otherwise returns false.
|
|
bool IsOverHeaderFooterArea( const Point& rPt, FrameControlType &rControl ) const;
|
|
|
|
// return font used to paint the "empty page" string
|
|
static const vcl::Font& GetEmptyPageFont();
|
|
|
|
static SwTwips GetSidebarBorderWidth( const SwViewShell* );
|
|
|
|
/// Is bottom-of-page-frame - bottom-of-text-frame difference valid in case whitespace is hidden?
|
|
/// If false is returned, then the caller should handle negative difference as (at least) zero difference instead.
|
|
bool CheckPageHeightValidForHideWhitespace(SwTwips nDiff);
|
|
|
|
const SwHeaderFrame* GetHeaderFrame() const;
|
|
const SwFooterFrame* GetFooterFrame() const;
|
|
|
|
void UpdateVirtPageNumInfo(sw::VirtPageNumHint& rHint, const SwFrame* pFrame) const;
|
|
|
|
void dumpAsXml(xmlTextWriterPtr writer = nullptr) const override;
|
|
};
|
|
|
|
inline SwContentFrame *SwPageFrame::FindFirstBodyContent()
|
|
{
|
|
SwLayoutFrame *pBody = FindBodyCont();
|
|
return pBody ? pBody->ContainsContent() : nullptr;
|
|
}
|
|
inline const SwContentFrame *SwPageFrame::FindFirstBodyContent() const
|
|
{
|
|
const SwLayoutFrame *pBody = FindBodyCont();
|
|
return pBody ? pBody->ContainsContent() : nullptr;
|
|
}
|
|
inline const SwContentFrame *SwPageFrame::FindLastBodyContent() const
|
|
{
|
|
return const_cast<SwPageFrame*>(this)->FindLastBodyContent();
|
|
}
|
|
inline void SwPageFrame::InvalidateFlyLayout() const
|
|
{
|
|
const_cast<SwPageFrame*>(this)->m_bInvalidFlyLayout = true;
|
|
}
|
|
inline void SwPageFrame::InvalidateFlyContent() const
|
|
{
|
|
const_cast<SwPageFrame*>(this)->m_bInvalidFlyContent = true;
|
|
}
|
|
inline void SwPageFrame::InvalidateFlyInCnt() const
|
|
{
|
|
const_cast<SwPageFrame*>(this)->m_bInvalidFlyInCnt = true;
|
|
}
|
|
inline void SwPageFrame::InvalidateLayout() const
|
|
{
|
|
const_cast<SwPageFrame*>(this)->m_bInvalidLayout = true;
|
|
}
|
|
inline void SwPageFrame::InvalidateContent() const
|
|
{
|
|
const_cast<SwPageFrame*>(this)->m_bInvalidContent = true;
|
|
}
|
|
inline void SwPageFrame::InvalidateSpelling() const
|
|
{
|
|
const_cast<SwPageFrame*>(this)->m_bInvalidSpelling = true;
|
|
}
|
|
|
|
inline void SwPageFrame::InvalidateSmartTags() const
|
|
{
|
|
const_cast<SwPageFrame*>(this)->m_bInvalidSmartTags = true;
|
|
}
|
|
inline void SwPageFrame::InvalidateAutoCompleteWords() const
|
|
{
|
|
const_cast<SwPageFrame*>(this)->m_bInvalidAutoCmplWrds = true;
|
|
}
|
|
inline void SwPageFrame::InvalidateWordCount() const
|
|
{
|
|
const_cast<SwPageFrame*>(this)->m_bInvalidWordCount = true;
|
|
}
|
|
inline void SwPageFrame::ValidateFlyLayout() const
|
|
{
|
|
const_cast<SwPageFrame*>(this)->m_bInvalidFlyLayout = false;
|
|
}
|
|
inline void SwPageFrame::ValidateFlyContent() const
|
|
{
|
|
const_cast<SwPageFrame*>(this)->m_bInvalidFlyContent = false;
|
|
}
|
|
inline void SwPageFrame::ValidateFlyInCnt() const
|
|
{
|
|
const_cast<SwPageFrame*>(this)->m_bInvalidFlyInCnt = false;
|
|
}
|
|
inline void SwPageFrame::ValidateLayout() const
|
|
{
|
|
const_cast<SwPageFrame*>(this)->m_bInvalidLayout = false;
|
|
}
|
|
inline void SwPageFrame::ValidateContent() const
|
|
{
|
|
const_cast<SwPageFrame*>(this)->m_bInvalidContent = false;
|
|
}
|
|
inline void SwPageFrame::ValidateSpelling() const
|
|
{
|
|
const_cast<SwPageFrame*>(this)->m_bInvalidSpelling = false;
|
|
}
|
|
|
|
inline void SwPageFrame::ValidateSmartTags() const
|
|
{
|
|
const_cast<SwPageFrame*>(this)->m_bInvalidSmartTags = false;
|
|
}
|
|
inline void SwPageFrame::ValidateAutoCompleteWords() const
|
|
{
|
|
const_cast<SwPageFrame*>(this)->m_bInvalidAutoCmplWrds = false;
|
|
}
|
|
inline void SwPageFrame::ValidateWordCount() const
|
|
{
|
|
const_cast<SwPageFrame*>(this)->m_bInvalidWordCount = false;
|
|
}
|
|
|
|
inline bool SwPageFrame::IsInvalid() const
|
|
{
|
|
return (m_bInvalidContent || m_bInvalidLayout || m_bInvalidFlyInCnt);
|
|
}
|
|
inline bool SwPageFrame::IsInvalidFly() const
|
|
{
|
|
return m_bInvalidFlyLayout || m_bInvalidFlyContent;
|
|
}
|
|
|
|
|
|
class SwTextGridItem;
|
|
|
|
SwTextGridItem const* GetGridItem(SwPageFrame const*const);
|
|
|
|
sal_uInt16 GetGridWidth(SwTextGridItem const&, SwDoc const&);
|
|
|
|
namespace sw { bool IsPageFrameEmpty(SwPageFrame const& rPage); }
|
|
|
|
|
|
#endif // INCLUDED_SW_SOURCE_CORE_INC_PAGEFRM_HXX
|
|
|
|
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|