/* -*- 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_INC_FMTHDFT_HXX

#define INCLUDED_SW_INC_FMTHDFT_HXX

#include "hintids.hxx"

#include "format.hxx"

#include <svl/poolitem.hxx>

#include "calbck.hxx"

#include "frmfmt.hxx"

namespace sw {

    typedef ClientBase<::SwFrameFormat> FrameFormatClient;

}

 /** Header, for PageFormats

 Client of FrameFormat describing the header. */

class SW_DLLPUBLIC SwFormatHeader final : public SfxPoolItem, public sw::FrameFormatClient

{

    bool m_bActive;       ///< Only for controlling (creation of content).

    void ImplDestroy();

public:

    DECLARE_ITEM_TYPE_FUNCTION(SwFormatHeader)

    SwFormatHeader( bool bOn = false );

    SwFormatHeader( SwFrameFormat *pHeaderFormat );

    SwFormatHeader( const SwFormatHeader &rCpy );

    virtual ~SwFormatHeader() override;

    SwFormatHeader& operator=( const SwFormatHeader &rCpy );

    /// "pure virtual methods" of SfxPoolItem

    virtual bool            operator==( const SfxPoolItem& ) const override;

    virtual SwFormatHeader* Clone( SfxItemPool* pPool = nullptr ) const override;

    virtual bool GetPresentation( SfxItemPresentation ePres,

                                  MapUnit eCoreMetric,

                                  MapUnit ePresMetric,

                                  OUString &rText,

                                  const IntlWrapper& rIntl ) const override;

    const SwFrameFormat *GetHeaderFormat() const { return GetRegisteredIn(); }

          SwFrameFormat *GetHeaderFormat()       { return GetRegisteredIn(); }

    void RegisterToFormat( SwFrameFormat& rFormat );

    bool IsActive() const { return m_bActive; }

    void dumpAsXml(xmlTextWriterPtr pWriter) const override;

};

 /**Footer, for pageformats

 Client of FrameFormat describing the footer */

class SW_DLLPUBLIC SwFormatFooter final : public SfxPoolItem, public sw::FrameFormatClient

{

    bool m_bActive;       // Only for controlling (creation of content).

    void ImplDestroy();

public:

    DECLARE_ITEM_TYPE_FUNCTION(SwFormatFooter)

    SwFormatFooter( bool bOn = false );

    SwFormatFooter( SwFrameFormat *pFooterFormat );

    SwFormatFooter( const SwFormatFooter &rCpy );

    virtual ~SwFormatFooter() override;

    SwFormatFooter& operator=( const SwFormatFooter &rCpy );

    /// "pure virtual methods" of SfxPoolItem

    virtual bool            operator==( const SfxPoolItem& ) const override;

    virtual SwFormatFooter* Clone( SfxItemPool* pPool = nullptr ) const override;

    virtual bool GetPresentation( SfxItemPresentation ePres,

                                  MapUnit eCoreMetric,

                                  MapUnit ePresMetric,

                                  OUString &rText,

                                  const IntlWrapper& rIntl ) const override;

    const SwFrameFormat *GetFooterFormat() const { return GetRegisteredIn(); }

          SwFrameFormat *GetFooterFormat()       { return GetRegisteredIn(); }

    void RegisterToFormat( SwFormat& rFormat );

    bool IsActive() const { return m_bActive; }

    void dumpAsXml(xmlTextWriterPtr pWriter) const override;

};

inline const SwFormatHeader &SwAttrSet::GetHeader(bool bInP) const

    { return Get( RES_HEADER,bInP); }

inline const SwFormatFooter &SwAttrSet::GetFooter(bool bInP) const

    { return Get( RES_FOOTER,bInP); }

inline const SwFormatHeader &SwFormat::GetHeader(bool bInP) const

    { return m_aSet.GetHeader(bInP); }

inline const SwFormatFooter &SwFormat::GetFooter(bool bInP) const

    { return m_aSet.GetFooter(bInP); }

#endif

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */