sw/inc/fmthdft.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_FMTHDFT_HXX
  20 #define INCLUDED_SW_INC_FMTHDFT_HXX
  21
  22 #include "hintids.hxx"
  23 #include "format.hxx"
  24 #include <svl/poolitem.hxx>
  25 #include "calbck.hxx"
  26 #include "frmfmt.hxx"
  27
  28 class IntlWrapper;
  29
  30  /** Header, for PageFormats
  31  Client of FrameFormat describing the header. */
  32
  33 class SW_DLLPUBLIC SwFormatHeader final : public SfxPoolItem, public SwClient
  34 {
  35     bool m_bActive;       ///< Only for controlling (creation of content).
  36
  37 public:
  38     SwFormatHeader( bool bOn = false );
  39     SwFormatHeader( SwFrameFormat *pHeaderFormat );
  40     SwFormatHeader( const SwFormatHeader &rCpy );
  41     virtual ~SwFormatHeader() override;
  42     SwFormatHeader& operator=( const SwFormatHeader &rCpy );
  43
  44
  45     /// "pure virtual methods" of SfxPoolItem
  46     virtual bool            operator==( const SfxPoolItem& ) const override;
  47     virtual SwFormatHeader* Clone( SfxItemPool* pPool = nullptr ) const override;
  48     virtual bool GetPresentation( SfxItemPresentation ePres,
  49                                   MapUnit eCoreMetric,
  50                                   MapUnit ePresMetric,
  51                                   OUString &rText,
  52                                   const IntlWrapper& rIntl ) const override;
  53
  54     const SwFrameFormat *GetHeaderFormat() const { return static_cast<const SwFrameFormat*>(GetRegisteredIn()); }
  55           SwFrameFormat *GetHeaderFormat()       { return static_cast<SwFrameFormat*>(GetRegisteredIn()); }
  56
  57     void RegisterToFormat( SwFormat& rFormat );
  58     bool IsActive() const { return m_bActive; }
  59     void dumpAsXml(xmlTextWriterPtr pWriter) const override;
  60 };
  61
  62  /**Footer, for pageformats
  63  Client of FrameFormat describing the footer */
  64
  65 class SW_DLLPUBLIC SwFormatFooter final : public SfxPoolItem, public SwClient
  66 {
  67     bool m_bActive;       // Only for controlling (creation of content).
  68
  69 public:
  70     SwFormatFooter( bool bOn = false );
  71     SwFormatFooter( SwFrameFormat *pFooterFormat );
  72     SwFormatFooter( const SwFormatFooter &rCpy );
  73     virtual ~SwFormatFooter() override;
  74     SwFormatFooter& operator=( const SwFormatFooter &rCpy );
  75
  76
  77     /// "pure virtual methods" of SfxPoolItem
  78     virtual bool            operator==( const SfxPoolItem& ) const override;
  79     virtual SwFormatFooter* Clone( SfxItemPool* pPool = nullptr ) const override;
  80     virtual bool GetPresentation( SfxItemPresentation ePres,
  81                                   MapUnit eCoreMetric,
  82                                   MapUnit ePresMetric,
  83                                   OUString &rText,
  84                                   const IntlWrapper& rIntl ) const override;
  85
  86     const SwFrameFormat *GetFooterFormat() const { return static_cast<const SwFrameFormat*>(GetRegisteredIn()); }
  87           SwFrameFormat *GetFooterFormat()       { return static_cast<SwFrameFormat*>(GetRegisteredIn()); }
  88
  89     void RegisterToFormat( SwFormat& rFormat );
  90     bool IsActive() const { return m_bActive; }
  91     void dumpAsXml(xmlTextWriterPtr pWriter) const override;
  92 };
  93
  94 inline const SwFormatHeader &SwAttrSet::GetHeader(bool bInP) const
  95     { return Get( RES_HEADER,bInP); }
  96 inline const SwFormatFooter &SwAttrSet::GetFooter(bool bInP) const
  97     { return Get( RES_FOOTER,bInP); }
  98
  99 inline const SwFormatHeader &SwFormat::GetHeader(bool bInP) const
 100     { return m_aSet.GetHeader(bInP); }
 101 inline const SwFormatFooter &SwFormat::GetFooter(bool bInP) const
 102     { return m_aSet.GetFooter(bInP); }
 103
 104 #endif
 105
 106 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */