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
 139     : public SwModify
 140     , public sw::BroadcasterMixin
 141 {
 142     friend class SwDoc;
 143     friend class SwPageDescs;
 144
 145     OUString    m_StyleName;
 146     SvxNumberType m_NumType;
 147     SwFrameFormat    m_Master;
 148     SwFrameFormat    m_Left;
 149     // FIXME epicycles growing here - page margins need to be stored differently
 150     SwFrameFormat    m_FirstMaster;
 151     SwFrameFormat    m_FirstLeft;
 152     sw::WriterMultiListener m_aDepends; ///< Because of grid alignment (Registerhaltigkeit).
 153     mutable const SwTextFormatColl* m_pTextFormatColl;
 154     SwPageDesc *m_pFollow;
 155     sal_uInt16  m_nRegHeight; ///< Sentence spacing and fontascent of style.
 156     sal_uInt16  m_nRegAscent; ///< For grid alignment (Registerhaltigkeit).
 157     drawing::TextVerticalAdjust   m_nVerticalAdjustment; // doc/docx: vertically center / justify / bottom
 158     UseOnPage   m_eUse;
 159     bool        m_IsLandscape;
 160     bool        m_IsHidden;
 161
 162     /// Footnote information.
 163     SwPageFootnoteInfo m_IsFootnoteInfo;
 164
 165     /// Backref to the assigned SwPageDescs list to handle renames.
 166     SwPageDescs  *m_pdList;
 167
 168     /** Called for mirroring of Chg (doc).
 169        No adjustment at any other place. */
 170     SAL_DLLPRIVATE void Mirror();
 171
 172     SAL_DLLPRIVATE void ResetAllAttr();
 173
 174     SAL_DLLPRIVATE SwPageDesc(const OUString&, SwFrameFormat*, SwDoc *pDc );
 175
 176     struct change_name
 177     {
 178         change_name(const OUString &rName) : mName(rName) {}
 179         void operator()(SwPageDesc *pPageDesc) { pPageDesc->m_StyleName = mName; }
 180         const OUString &mName;
 181     };
 182
 183 protected:
 184     virtual void SwClientNotify(const SwModify&, const SfxHint&) override;
 185
 186 public:
 187     const OUString& GetName() const { return m_StyleName; }
 188     bool SetName(const OUString& rNewName);
 189
 190     bool GetLandscape() const { return m_IsLandscape; }
 191     void SetLandscape( bool bNew ) { m_IsLandscape = bNew; }
 192
 193     const SvxNumberType &GetNumType() const { return m_NumType; }
 194     void  SetNumType(const SvxNumberType& rNew) { m_NumType = rNew; }
 195
 196     const SwPageFootnoteInfo &GetFootnoteInfo() const { return m_IsFootnoteInfo; }
 197           SwPageFootnoteInfo &GetFootnoteInfo()       { return m_IsFootnoteInfo; }
 198     void  SetFootnoteInfo(const SwPageFootnoteInfo &rNew) { m_IsFootnoteInfo = rNew; }
 199
 200     inline bool IsHeaderShared() const;
 201     inline bool IsFooterShared() const;
 202     inline void ChgHeaderShare( bool bNew );
 203     inline void ChgFooterShare( bool bNew );
 204     bool IsFirstShared() const;
 205     void ChgFirstShare( bool bNew );
 206
 207     bool IsHidden() const { return m_IsHidden; }
 208     void SetHidden(bool const bValue) { m_IsHidden = bValue; }
 209
 210     /// Same as WriteUseOn(), but the >= HeaderShare part of the bitfield is not modified.
 211     inline void      SetUseOn( UseOnPage eNew );
 212     inline UseOnPage GetUseOn() const;
 213
 214     void      WriteUseOn(UseOnPage const eNew) { m_eUse = eNew; }
 215     UseOnPage ReadUseOn() const { return m_eUse; }
 216
 217           SwFrameFormat &GetMaster()      { return m_Master; }
 218           SwFrameFormat &GetLeft()        { return m_Left; }
 219           SwFrameFormat &GetFirstMaster() { return m_FirstMaster; }
 220           SwFrameFormat &GetFirstLeft()   { return m_FirstLeft; }
 221     const SwFrameFormat &GetMaster() const      { return m_Master; }
 222     const SwFrameFormat &GetLeft()   const      { return m_Left; }
 223     const SwFrameFormat &GetFirstMaster() const { return m_FirstMaster; }
 224     const SwFrameFormat &GetFirstLeft()   const { return m_FirstLeft; }
 225
 226     /** Reset all attrs of the format but keep the ones a pagedesc
 227        cannot live without. */
 228     inline void ResetAllMasterAttr();
 229
 230     /** Layout uses the following methods to obtain a format in order
 231        to be able to create a page. */
 232            SwFrameFormat *GetRightFormat(bool const bFirst = false);
 233     inline const SwFrameFormat *GetRightFormat(bool const bFirst = false) const;
 234            SwFrameFormat *GetLeftFormat(bool const bFirst = false);
 235     inline const SwFrameFormat *GetLeftFormat(bool const bFirst = false) const;
 236
 237     sal_uInt16 GetRegHeight() const { return m_nRegHeight; }
 238     sal_uInt16 GetRegAscent() const { return m_nRegAscent; }
 239     void SetRegHeight(sal_uInt16 const nNew) { m_nRegHeight = nNew; }
 240     void SetRegAscent(sal_uInt16 const nNew) { m_nRegAscent = nNew; }
 241
 242     drawing::TextVerticalAdjust GetVerticalAdjustment () const {return m_nVerticalAdjustment; }
 243     void SetVerticalAdjustment (const drawing::TextVerticalAdjust nVA) {m_nVerticalAdjustment = nVA; }
 244
 245     inline void SetFollow( const SwPageDesc* pNew );
 246     const SwPageDesc* GetFollow() const { return m_pFollow; }
 247           SwPageDesc* GetFollow() { return m_pFollow; }
 248
 249     void SetRegisterFormatColl( const SwTextFormatColl* rFormat );
 250     const SwTextFormatColl* GetRegisterFormatColl() const;
 251     void RegisterChange();
 252
 253     /// Query and set PoolFormat-Id.
 254     sal_uInt16 GetPoolFormatId() const         { return m_Master.GetPoolFormatId(); }
 255     void SetPoolFormatId(sal_uInt16 const nId) { m_Master.SetPoolFormatId(nId); }
 256     sal_uInt16 GetPoolHelpId() const        { return m_Master.GetPoolHelpId(); }
 257     void SetPoolHelpId(sal_uInt16 const nId){ m_Master.SetPoolHelpId(nId); }
 258     sal_uInt8 GetPoolHlpFileId() const      { return m_Master.GetPoolHlpFileId(); }
 259     void SetPoolHlpFileId(sal_uInt8 const nId) { m_Master.SetPoolHlpFileId(nId); }
 260
 261     /// Query information from Client.
 262     virtual bool GetInfo( SfxPoolItem& ) const override;
 263
 264     const SwFrameFormat* GetPageFormatOfNode( const SwNode& rNd,
 265                                     bool bCheckForThisPgDc = true ) const;
 266     bool IsFollowNextPageOfNode( const SwNode& rNd ) const;
 267
 268     /// Given a SwNode return the pagedesc in use at that location.
 269     static const SwPageDesc* GetPageDescOfNode(const SwNode& rNd);
 270
 271     static SwPageDesc* GetByName(SwDoc& rDoc, const OUString& rName);
 272
 273     SwPageDesc& operator=( const SwPageDesc& );
 274
 275     SwPageDesc( const SwPageDesc& );
 276     virtual ~SwPageDesc() override;
 277
 278     void dumpAsXml(xmlTextWriterPtr pWriter) const;
 279 };
 280
 281 namespace std {
 282     template<>
 283     struct less<SwPageDesc*> {
 284         bool operator()(const SwPageDesc *pPageDesc, const OUString &rName) const
 285             { return pPageDesc->GetName() < rName; }
 286         bool operator()(const OUString &rName, const SwPageDesc *pPageDesc) const
 287             { return rName < pPageDesc->GetName(); }
 288         bool operator()(const SwPageDesc *lhs, const SwPageDesc *rhs) const
 289             { return lhs->GetName() < rhs->GetName(); }
 290     };
 291 }
 292
 293 inline void SwPageDesc::SetFollow( const SwPageDesc* pNew )
 294 {
 295     m_pFollow = pNew ? const_cast<SwPageDesc*>(pNew) : this;
 296 }
 297
 298 inline bool SwPageDesc::IsHeaderShared() const
 299 {
 300     return bool(m_eUse & UseOnPage::HeaderShare);
 301 }
 302 inline bool SwPageDesc::IsFooterShared() const
 303 {
 304     return bool(m_eUse & UseOnPage::FooterShare);
 305 }
 306 inline void SwPageDesc::ChgHeaderShare( bool bNew )
 307 {
 308     if ( bNew )
 309         m_eUse |= UseOnPage::HeaderShare;
 310     else
 311         m_eUse &= UseOnPage::NoHeaderShare;
 312 }
 313 inline void SwPageDesc::ChgFooterShare( bool bNew )
 314 {
 315     if ( bNew )
 316         m_eUse |= UseOnPage::FooterShare;
 317     else
 318         m_eUse &= UseOnPage::NoFooterShare;
 319 }
 320 inline void SwPageDesc::SetUseOn( UseOnPage eNew )
 321 {
 322     UseOnPage eTmp = UseOnPage::NONE;
 323     if (m_eUse & UseOnPage::HeaderShare)
 324         eTmp = UseOnPage::HeaderShare;
 325     if (m_eUse & UseOnPage::FooterShare)
 326         eTmp |= UseOnPage::FooterShare;
 327     if (m_eUse & UseOnPage::FirstShare)
 328         eTmp |= UseOnPage::FirstShare;
 329     m_eUse = eTmp | eNew;
 330
 331 }
 332 inline UseOnPage SwPageDesc::GetUseOn() const
 333 {
 334     UseOnPage eRet = m_eUse;
 335     eRet &= UseOnPage::NoHeaderShare;
 336     eRet &= UseOnPage::NoFooterShare;
 337     eRet &= UseOnPage::NoFirstShare;
 338     return eRet;
 339 }
 340
 341 inline void SwPageDesc::ResetAllMasterAttr()
 342 {
 343     ResetAllAttr();
 344 }
 345
 346 inline const SwFrameFormat *SwPageDesc::GetRightFormat(bool const bFirst) const
 347 {
 348     return const_cast<SwPageDesc*>(this)->GetRightFormat(bFirst);
 349 }
 350 inline const SwFrameFormat *SwPageDesc::GetLeftFormat(bool const bFirst) const
 351 {
 352     return const_cast<SwPageDesc*>(this)->GetLeftFormat(bFirst);
 353 }
 354
 355 class SwPageDescExt
 356 {
 357 public:
 358     SwPageDesc m_PageDesc;
 359 private:
 360     SwDoc * const m_pDoc;
 361     OUString m_sFollow;
 362
 363     void SetPageDesc(const SwPageDesc & rPageDesc);
 364
 365 public:
 366     SwPageDescExt(const SwPageDesc & rPageDesc, SwDoc * pDoc);
 367     SwPageDescExt(const SwPageDescExt & rSrc);
 368     ~SwPageDescExt();
 369
 370     SwPageDescExt & operator = (const SwPageDescExt & rSrc);
 371     SwPageDescExt & operator = (const SwPageDesc & rSrc);
 372
 373     OUString const & GetName() const;
 374
 375     operator SwPageDesc() const; // #i7983#
 376 };
 377
 378 namespace sw {
 379     class PageFootnoteHint final : public SfxHint {};
 380
 381     SW_DLLPUBLIC SwTwips FootnoteSeparatorHeight(SwPageFootnoteInfo const&);
 382 }
 383
 384 typedef boost::multi_index_container<
 385         SwPageDesc*,
 386         boost::multi_index::indexed_by<
 387             boost::multi_index::random_access<>,
 388             boost::multi_index::ordered_unique<
 389                 boost::multi_index::identity<SwPageDesc*> >
 390         >
 391     >
 392     SwPageDescsBase;
 393
 394 class SwPageDescs final
 395 {
 396     // function updating ByName index via modify
 397     friend bool SwPageDesc::SetName( const OUString& rNewName );
 398
 399     typedef SwPageDescsBase::nth_index<0>::type ByPos;
 400     typedef SwPageDescsBase::nth_index<1>::type ByName;
 401     typedef ByPos::iterator iterator;
 402
 403     iterator find_( const OUString &name ) const;
 404
 405     SwPageDescsBase   m_Array;
 406     ByPos            &m_PosIndex;
 407     ByName           &m_NameIndex;
 408
 409 public:
 410     typedef ByPos::const_iterator const_iterator;
 411     typedef SwPageDescsBase::size_type size_type;
 412     typedef SwPageDescsBase::value_type value_type;
 413
 414     SwPageDescs();
 415
 416     // frees all SwPageDesc!
 417     ~SwPageDescs();
 418
 419     void clear()        { return m_Array.clear(); }
 420     bool empty()  const { return m_Array.empty(); }
 421     size_t size() const { return m_Array.size(); }
 422
 423     std::pair<const_iterator,bool> push_back( const value_type& x );
 424     void erase( const value_type& x );
 425     void erase( size_type index );
 426     void erase( const_iterator const& position );
 427
 428     const_iterator find( const OUString &name ) const
 429         { return find_( name ); }
 430     const value_type& operator[]( size_t index_ ) const
 431         { return m_PosIndex.operator[]( index_ ); }
 432     const value_type& front() const { return m_PosIndex.front(); }
 433     const value_type& back() const { return m_PosIndex.back(); }
 434     const_iterator begin() const { return m_PosIndex.begin(); }
 435     const_iterator end() const { return m_PosIndex.end(); }
 436
 437     bool contains( const value_type& x ) const
 438         { return x->m_pdList == this; }
 439
 440     void dumpAsXml(xmlTextWriterPtr pWriter) const;
 441 };
 442
 443 #endif // INCLUDED_SW_INC_PAGEDESC_HXX
 444
 445 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */