sw/inc/pagedesc.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_INC_PAGEDESC_HXX
  20 #define INCLUDED_SW_INC_PAGEDESC_HXX
  21
  22 #include <tools/fract.hxx>
  23 #include <tools/color.hxx>
  24 #include "swdllapi.h"
  25 #include "swtypes.hxx"
  26 #include "frmfmt.hxx"
  27 #include <editeng/numitem.hxx>
  28 #include <editeng/borderline.hxx>
  29 #include <com/sun/star/drawing/TextVerticalAdjust.hpp>
  30 #include <com/sun/star/text/HorizontalAdjust.hpp>
  31 #include <o3tl/typed_flags_set.hxx>
  32
  33 #include <boost/multi_index_container.hpp>
  34 #include <boost/multi_index/identity.hpp>
  35 #include <boost/multi_index/ordered_index.hpp>
  36 #include <boost/multi_index/random_access_index.hpp>
  37
  38 using namespace ::com::sun::star;
  39
  40
  41 class SfxPoolItem;
  42 class SwTextFormatColl;
  43 class SwNode;
  44 class SwPageDescs;
  45 typedef struct _xmlTextWriter* xmlTextWriterPtr;
  46
  47 /// Footnote information.
  48 class SW_DLLPUBLIC SwPageFootnoteInfo
  49 {
  50 private:
  51     SwTwips     m_nMaxHeight;   ///< maximum height of the footnote area.
  52     sal_uLong   m_nLineWidth;   ///< width of separator line
  53     SvxBorderLineStyle m_eLineStyle;  ///< Style of the separator line
  54     Color       m_LineColor;    ///< color of the separator line
  55     Fraction    m_Width;        ///< percentage width of the separator line.
  56     css::text::HorizontalAdjust m_eAdjust;      ///< line adjustment.
  57     SwTwips     m_nTopDist;     ///< distance between body and separator.
  58     SwTwips     m_nBottomDist;  ///< distance between separator and first footnote
  59
  60 public:
  61     SwTwips     GetHeight() const       { return m_nMaxHeight; }
  62     sal_uLong   GetLineWidth() const    { return m_nLineWidth; }
  63     const Color& GetLineColor() const   { return m_LineColor;}
  64     SvxBorderLineStyle  GetLineStyle() const { return m_eLineStyle; }
  65     const Fraction& GetWidth() const    { return m_Width; }
  66     css::text::HorizontalAdjust GetAdj() const { return m_eAdjust; }
  67     SwTwips     GetTopDist() const      { return m_nTopDist; }
  68     SwTwips     GetBottomDist() const   { return m_nBottomDist; }
  69
  70     void SetHeight(SwTwips const nNew)      { m_nMaxHeight = nNew; }
  71     void SetLineWidth(sal_uLong const nSet) { m_nLineWidth = nSet; }
  72     void SetLineStyle(SvxBorderLineStyle const eSet) {m_eLineStyle = eSet;}
  73     void SetLineColor(const Color& rCol)    { m_LineColor = rCol;}
  74     void SetWidth(const Fraction & rNew)    { m_Width = rNew; }
  75     void SetAdj(css::text::HorizontalAdjust const eNew)   { m_eAdjust = eNew; }
  76     void SetTopDist   (SwTwips const nNew)  { m_nTopDist = nNew; }
  77     void SetBottomDist(SwTwips const nNew)  { m_nBottomDist = nNew; }
  78
  79     SwPageFootnoteInfo();
  80     SwPageFootnoteInfo( const SwPageFootnoteInfo& );
  81     SwPageFootnoteInfo& operator=( const SwPageFootnoteInfo& );
  82
  83     bool operator ==( const SwPageFootnoteInfo& ) const;
  84 };
  85
  86 /*
  87  *  Use of UseOnPage (m_eUse) and of FrameFormats
  88  *
  89  *  RIGHT   - m_Master only for right hand (odd) pages, left hand (even) pages
  90  *            always empty.
  91  *  LEFT    - m_Left for left-hand pages, right-hand pages always empty.
  92  *            m_Left is a copy of master.
  93  *  ALL     - m_Master for right hand pages, m_Left for left hand pages.
  94  *          - m_Left is a copy of master.
  95  * MIRROR   - m_Master for right hand pages, m_Left for left hand pagers.
  96  *            m_Left is a copy of master, margins are mirrored.
  97  *
  98  * UI works exclusively on master! m_Left is adjusted on Chg at document
  99  * according to m_eUse.
 100  *
 101  * In order to simplify the work of the filters some more values are placed
 102  * into m_eUse:
 103  *
 104  * HEADERSHARE - Content of header is equal on left and right hand pages.
 105  * FOOTERSHARE - Content of footer is equal on left and right hand pages.
 106  *
 107  * The values are masked out in the respective getter and setter methods.
 108  * Access to complete m_eUse including the information on header and footer
 109  * via ReadUseOn(), WriteUseOn() (for Filter and CopyCTor)!
 110  *
 111  * The Frameformats for header/footer are adjusted by the UI according to
 112  * the attributes for header and footer at master (height, margin, back-
 113  * ground ...)
 114  * Header/footer for left hand pages are copied or mirrored (Chg at
 115  * document).
 116  * The respective attribute for content is cared for automatically on Chg at
 117  * document (contents are created or removed according to SHARE-information).
 118  */
 119
 120 enum class UseOnPage : sal_uInt16
 121 {
 122     NONE           = 0x0000, ///< For internal use only.
 123     Left           = 0x0001,
 124     Right          = 0x0002,
 125     All            = 0x0003,
 126     Mirror         = 0x0007,
 127     HeaderShare    = 0x0040,
 128     FooterShare    = 0x0080,
 129     FirstShare     = 0x0100,
 130     NoHeaderShare  = 0xFFBF, ///< For internal use only.
 131     NoFooterShare  = 0xFF7F, ///< For internal use only.
 132     NoFirstShare   = 0xFEFF
 133 };
 134 namespace o3tl {
 135     template<> struct typed_flags<UseOnPage> : is_typed_flags<UseOnPage, 0xffff> {};
 136 }
 137
 138 class SW_DLLPUBLIC SwPageDesc final
 139     : public sw::BroadcastingModify
 140 {
 141     friend class SwDoc;
 142     friend class SwPageDescs;
 143
 144     OUString    m_StyleName;
 145     SvxNumberType m_NumType;
 146     SwFrameFormat    m_Master;
 147     SwFrameFormat    m_Left;
 148     // FIXME epicycles growing here - page margins need to be stored differently
 149     SwFrameFormat    m_FirstMaster;
 150     SwFrameFormat    m_FirstLeft;
 151
 152     struct StashedPageDesc
 153     {
 154         std::shared_ptr<SwFrameFormat> m_pStashedFirst;
 155         std::shared_ptr<SwFrameFormat> m_pStashedLeft;
 156         std::shared_ptr<SwFrameFormat> m_pStashedFirstLeft;
 157     };
 158
 159     mutable StashedPageDesc m_aStashedHeader;
 160     mutable StashedPageDesc m_aStashedFooter;
 161
 162     sw::WriterMultiListener m_aDepends; ///< Because of grid alignment (Registerhaltigkeit).
 163     mutable const SwTextFormatColl* m_pTextFormatColl;
 164     SwPageDesc *m_pFollow;
 165     sal_uInt16  m_nRegHeight; ///< Sentence spacing and fontascent of style.
 166     sal_uInt16  m_nRegAscent; ///< For grid alignment (Registerhaltigkeit).
 167     drawing::TextVerticalAdjust   m_nVerticalAdjustment; // doc/docx: vertically center / justify / bottom
 168     UseOnPage   m_eUse;
 169     bool        m_IsLandscape;
 170     bool        m_IsHidden;
 171
 172     /// Footnote information.
 173     SwPageFootnoteInfo m_FootnoteInfo;
 174
 175     /// Backref to the assigned SwPageDescs list to handle renames.
 176     SwPageDescs  *m_pdList;
 177
 178     /** Called for mirroring of Chg (doc).
 179        No adjustment at any other place. */
 180     SAL_DLLPRIVATE void Mirror();
 181
 182     SAL_DLLPRIVATE void ResetAllAttr();
 183
 184     SAL_DLLPRIVATE SwPageDesc(const OUString&, SwFrameFormat*, SwDoc *pDc );
 185
 186     struct change_name
 187     {
 188         change_name(const OUString &rName) : mName(rName) {}
 189         void operator()(SwPageDesc *pPageDesc) { pPageDesc->m_StyleName = mName; }
 190         const OUString &mName;
 191     };
 192
 193     virtual void SwClientNotify(const SwModify&, const SfxHint&) override;
 194
 195 public:
 196     const OUString& GetName() const { return m_StyleName; }
 197     bool SetName(const OUString& rNewName);
 198
 199     bool GetLandscape() const { return m_IsLandscape; }
 200     void SetLandscape( bool bNew ) { m_IsLandscape = bNew; }
 201
 202     const SvxNumberType &GetNumType() const { return m_NumType; }
 203     void  SetNumType(const SvxNumberType& rNew) { m_NumType = rNew; }
 204
 205     const SwPageFootnoteInfo &GetFootnoteInfo() const { return m_FootnoteInfo; }
 206           SwPageFootnoteInfo &GetFootnoteInfo()       { return m_FootnoteInfo; }
 207     void  SetFootnoteInfo(const SwPageFootnoteInfo &rNew) { m_FootnoteInfo = rNew; }
 208
 209     inline bool IsHeaderShared() const;
 210     inline bool IsFooterShared() const;
 211     inline void ChgHeaderShare( bool bNew );
 212     inline void ChgFooterShare( bool bNew );
 213     bool IsFirstShared() const;
 214     void ChgFirstShare( bool bNew );
 215
 216     bool IsHidden() const { return m_IsHidden; }
 217     void SetHidden(bool const bValue) { m_IsHidden = bValue; }
 218
 219     /// Remember original header/footer formats even when they are hidden by "sharing".
 220     void StashFrameFormat(const SwFrameFormat& rFormat, bool bHeader, bool bLeft, bool bFirst);
 221
 222     /// Used to restore hidden header/footer formats.
 223     const SwFrameFormat* GetStashedFrameFormat(bool bHeader, bool bLeft, bool bFirst) const;
 224
 225     /// Checks if the pagedescriptor has a stashed format according to the parameters or not.
 226     bool HasStashedFormat(bool bHeader, bool bLeft, bool bFirst);
 227
 228     /// Gives the feature of removing the stashed format by hand if it is necessary.
 229     void RemoveStashedFormat(bool bHeader, bool bLeft, bool bFirst);
 230
 231     /// Same as WriteUseOn(), but the >= HeaderShare part of the bitfield is not modified.
 232     inline void      SetUseOn( UseOnPage eNew );
 233     inline UseOnPage GetUseOn() const;
 234
 235     void      WriteUseOn(UseOnPage const eNew) { m_eUse = eNew; }
 236     UseOnPage ReadUseOn() const { return m_eUse; }
 237
 238           SwFrameFormat &GetMaster()      { return m_Master; }
 239           SwFrameFormat &GetLeft()        { return m_Left; }
 240           SwFrameFormat &GetFirstMaster() { return m_FirstMaster; }
 241           SwFrameFormat &GetFirstLeft()   { return m_FirstLeft; }
 242     const SwFrameFormat &GetMaster() const      { return m_Master; }
 243     const SwFrameFormat &GetLeft()   const      { return m_Left; }
 244     const SwFrameFormat &GetFirstMaster() const { return m_FirstMaster; }
 245     const SwFrameFormat &GetFirstLeft()   const { return m_FirstLeft; }
 246
 247     /** Reset all attrs of the format but keep the ones a pagedesc
 248        cannot live without. */
 249     inline void ResetAllMasterAttr();
 250
 251     /** Layout uses the following methods to obtain a format in order
 252        to be able to create a page. */
 253            SwFrameFormat *GetRightFormat(bool const bFirst = false);
 254     inline const SwFrameFormat *GetRightFormat(bool const bFirst = false) const;
 255            SwFrameFormat *GetLeftFormat(bool const bFirst = false);
 256     inline const SwFrameFormat *GetLeftFormat(bool const bFirst = false) const;
 257
 258     sal_uInt16 GetRegHeight() const { return m_nRegHeight; }
 259     sal_uInt16 GetRegAscent() const { return m_nRegAscent; }
 260     void SetRegHeight(sal_uInt16 const nNew) { m_nRegHeight = nNew; }
 261     void SetRegAscent(sal_uInt16 const nNew) { m_nRegAscent = nNew; }
 262
 263     drawing::TextVerticalAdjust GetVerticalAdjustment () const {return m_nVerticalAdjustment; }
 264     void SetVerticalAdjustment (const drawing::TextVerticalAdjust nVA) {m_nVerticalAdjustment = nVA; }
 265
 266     inline void SetFollow( const SwPageDesc* pNew );
 267     const SwPageDesc* GetFollow() const { return m_pFollow; }
 268           SwPageDesc* GetFollow() { return m_pFollow; }
 269
 270     void SetRegisterFormatColl( const SwTextFormatColl* rFormat );
 271     const SwTextFormatColl* GetRegisterFormatColl() const;
 272     void RegisterChange();
 273
 274     /// Query and set PoolFormat-Id.
 275     sal_uInt16 GetPoolFormatId() const         { return m_Master.GetPoolFormatId(); }
 276     void SetPoolFormatId(sal_uInt16 const nId) { m_Master.SetPoolFormatId(nId); }
 277     sal_uInt16 GetPoolHelpId() const        { return m_Master.GetPoolHelpId(); }
 278     void SetPoolHelpId(sal_uInt16 const nId){ m_Master.SetPoolHelpId(nId); }
 279     sal_uInt8 GetPoolHlpFileId() const      { return m_Master.GetPoolHlpFileId(); }
 280     void SetPoolHlpFileId(sal_uInt8 const nId) { m_Master.SetPoolHlpFileId(nId); }
 281
 282     /// Query information from Client.
 283     virtual bool GetInfo( SfxPoolItem& ) const override;
 284
 285     const SwFrameFormat* GetPageFormatOfNode( const SwNode& rNd,
 286                                     bool bCheckForThisPgDc = true ) const;
 287     bool IsFollowNextPageOfNode( const SwNode& rNd ) const;
 288
 289     /// Given a SwNode return the pagedesc in use at that location.
 290     static const SwPageDesc* GetPageDescOfNode(const SwNode& rNd);
 291
 292     static SwPageDesc* GetByName(SwDoc& rDoc, std::u16string_view rName);
 293
 294     SwPageDesc& operator=( const SwPageDesc& );
 295
 296     SwPageDesc( const SwPageDesc& );
 297     virtual ~SwPageDesc() override;
 298
 299     void dumpAsXml(xmlTextWriterPtr pWriter) const;
 300 };
 301
 302 namespace std {
 303     template<>
 304     struct less<SwPageDesc*> {
 305         bool operator()(const SwPageDesc *pPageDesc, std::u16string_view rName) const
 306             { return pPageDesc->GetName() < rName; }
 307         bool operator()(std::u16string_view rName, const SwPageDesc *pPageDesc) const
 308             { return rName < pPageDesc->GetName(); }
 309         bool operator()(const SwPageDesc *lhs, const SwPageDesc *rhs) const
 310             { return lhs->GetName() < rhs->GetName(); }
 311     };
 312 }
 313
 314 inline void SwPageDesc::SetFollow( const SwPageDesc* pNew )
 315 {
 316     m_pFollow = pNew ? const_cast<SwPageDesc*>(pNew) : this;
 317 }
 318
 319 inline bool SwPageDesc::IsHeaderShared() const
 320 {
 321     return bool(m_eUse & UseOnPage::HeaderShare);
 322 }
 323 inline bool SwPageDesc::IsFooterShared() const
 324 {
 325     return bool(m_eUse & UseOnPage::FooterShare);
 326 }
 327 inline void SwPageDesc::ChgHeaderShare( bool bNew )
 328 {
 329     if ( bNew )
 330         m_eUse |= UseOnPage::HeaderShare;
 331     else
 332         m_eUse &= UseOnPage::NoHeaderShare;
 333 }
 334 inline void SwPageDesc::ChgFooterShare( bool bNew )
 335 {
 336     if ( bNew )
 337         m_eUse |= UseOnPage::FooterShare;
 338     else
 339         m_eUse &= UseOnPage::NoFooterShare;
 340 }
 341 inline void SwPageDesc::SetUseOn( UseOnPage eNew )
 342 {
 343     UseOnPage eTmp = UseOnPage::NONE;
 344     if (m_eUse & UseOnPage::HeaderShare)
 345         eTmp = UseOnPage::HeaderShare;
 346     if (m_eUse & UseOnPage::FooterShare)
 347         eTmp |= UseOnPage::FooterShare;
 348     if (m_eUse & UseOnPage::FirstShare)
 349         eTmp |= UseOnPage::FirstShare;
 350     m_eUse = eTmp | eNew;
 351
 352 }
 353 inline UseOnPage SwPageDesc::GetUseOn() const
 354 {
 355     UseOnPage eRet = m_eUse;
 356     eRet &= UseOnPage::NoHeaderShare;
 357     eRet &= UseOnPage::NoFooterShare;
 358     eRet &= UseOnPage::NoFirstShare;
 359     return eRet;
 360 }
 361
 362 inline void SwPageDesc::ResetAllMasterAttr()
 363 {
 364     ResetAllAttr();
 365 }
 366
 367 inline const SwFrameFormat *SwPageDesc::GetRightFormat(bool const bFirst) const
 368 {
 369     return const_cast<SwPageDesc*>(this)->GetRightFormat(bFirst);
 370 }
 371 inline const SwFrameFormat *SwPageDesc::GetLeftFormat(bool const bFirst) const
 372 {
 373     return const_cast<SwPageDesc*>(this)->GetLeftFormat(bFirst);
 374 }
 375
 376 class SwPageDescExt
 377 {
 378 public:
 379     SwPageDesc m_PageDesc;
 380 private:
 381     SwDoc * m_pDoc;
 382     OUString m_sFollow;
 383
 384     void SetPageDesc(const SwPageDesc & rPageDesc);
 385
 386 public:
 387     SwPageDescExt(const SwPageDesc & rPageDesc, SwDoc * pDoc);
 388     SwPageDescExt(const SwPageDescExt & rSrc);
 389     ~SwPageDescExt();
 390
 391     SwPageDescExt & operator = (const SwPageDescExt & rSrc);
 392     SwPageDescExt & operator = (const SwPageDesc & rSrc);
 393
 394     OUString const & GetName() const;
 395
 396     operator SwPageDesc() const; // #i7983#
 397 };
 398
 399 namespace sw {
 400     class PageFootnoteHint final : public SfxHint {};
 401
 402     SW_DLLPUBLIC SwTwips FootnoteSeparatorHeight(SwPageFootnoteInfo const&);
 403 }
 404
 405 typedef boost::multi_index_container<
 406         SwPageDesc*,
 407         boost::multi_index::indexed_by<
 408             boost::multi_index::random_access<>,
 409             boost::multi_index::ordered_unique<
 410                 boost::multi_index::identity<SwPageDesc*> >
 411         >
 412     >
 413     SwPageDescsBase;
 414
 415 class SwPageDescs final
 416 {
 417     // function updating ByName index via modify
 418     friend bool SwPageDesc::SetName( const OUString& rNewName );
 419
 420     typedef SwPageDescsBase::nth_index<0>::type ByPos;
 421     typedef SwPageDescsBase::nth_index<1>::type ByName;
 422     typedef ByPos::iterator iterator;
 423
 424     iterator find_( const OUString &name ) const;
 425
 426     SwPageDescsBase   m_Array;
 427     ByPos            &m_PosIndex;
 428     ByName           &m_NameIndex;
 429
 430 public:
 431     typedef ByPos::const_iterator const_iterator;
 432     typedef SwPageDescsBase::size_type size_type;
 433     typedef SwPageDescsBase::value_type value_type;
 434
 435     SwPageDescs();
 436
 437     // frees all SwPageDesc!
 438     ~SwPageDescs();
 439
 440     void clear()        { return m_Array.clear(); }
 441     bool empty()  const { return m_Array.empty(); }
 442     size_t size() const { return m_Array.size(); }
 443
 444     std::pair<const_iterator,bool> push_back( const value_type& x );
 445     void erase( const value_type& x );
 446     void erase( size_type index );
 447     void erase( const_iterator const& position );
 448
 449     const_iterator find( const OUString &name ) const
 450         { return find_( name ); }
 451     const value_type& operator[]( size_t index_ ) const
 452         { return m_PosIndex.operator[]( index_ ); }
 453     const value_type& front() const { return m_PosIndex.front(); }
 454     const value_type& back() const { return m_PosIndex.back(); }
 455     const_iterator begin() const { return m_PosIndex.begin(); }
 456     const_iterator end() const { return m_PosIndex.end(); }
 457
 458     bool contains( const value_type& x ) const
 459         { return x->m_pdList == this; }
 460
 461     void dumpAsXml(xmlTextWriterPtr pWriter) const;
 462 };
 463
 464 #endif // INCLUDED_SW_INC_PAGEDESC_HXX
 465
 466 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */