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

 */

#ifndef INCLUDED_SW_SOURCE_UIBASE_INC_HEADERFOOTERWIN_HXX

#define INCLUDED_SW_SOURCE_UIBASE_INC_HEADERFOOTERWIN_HXX

#include "edtwin.hxx"

#include "DashedLine.hxx"

#include "FrameControl.hxx"

#include <vcl/timer.hxx>

#include <drawinglayer/primitive2d/Primitive2DContainer.hxx>

namespace weld

{

class MenuButton;

}

/**

 *  Button painter helper class used to paint a runtime button positioned to a writer frame.

 *  See header/footer button.

 */

class SwFrameButtonPainter

{

public:

    static void PaintButton(drawinglayer::primitive2d::Primitive2DContainer& rSeq,

                            const tools::Rectangle& rRect, bool bOnTop);

};

class SwHeaderFooterWin;

/** Class for the header and footer separator control window.

    This control is showing the header / footer style name and provides

    a few useful actions to the user.

  */

class SwHeaderFooterDashedLine final : public SwDashedLine, public ISwFrameControl

{

private:

    VclPtr<SwHeaderFooterWin> m_pWin;

    VclPtr<SwEditWin> m_pEditWin;

    const SwFrame* m_pFrame;

    bool m_bIsHeader;

    void EnsureWin();

    bool IsOnScreen();

public:

    SwHeaderFooterDashedLine(SwEditWin* pEditWin, const SwFrame *pFrame, bool bIsHeader);

    virtual ~SwHeaderFooterDashedLine() override { disposeOnce(); }

    virtual void dispose() override { m_pWin.disposeAndClear(); m_pEditWin.reset(); SwDashedLine::dispose(); }

    virtual const SwFrame* GetFrame() override { return m_pFrame; }

    virtual SwEditWin* GetEditWin() override { return m_pEditWin; }

    virtual void ShowAll(bool bShow) override;

    virtual bool Contains(const Point &rDocPt) const override;

    virtual void SetReadonly(bool bReadonly) override;

    void SetOffset( Point aOffset, tools::Long nXLineStart, tools::Long nXLineEnd );

    bool IsHeader() const { return m_bIsHeader; };

};

class SwHeaderFooterWin final : public InterimItemWindow

{

    std::unique_ptr<weld::MenuButton> m_xMenuButton;

    std::unique_ptr<weld::Button> m_xPushButton;

    VclPtr<SwEditWin>     m_pEditWin;

    VclPtr<VirtualDevice> m_xVirDev;

    const SwFrame*        m_pFrame;

    OUString              m_sLabel;

    bool                  m_bIsHeader;

    bool                  m_bIsAppearing;

    int                   m_nFadeRate;

    Timer                 m_aFadeTimer;

public:

    SwHeaderFooterWin(SwEditWin *pEditWin, const SwFrame *pFrame, bool bHeader);

    virtual ~SwHeaderFooterWin( ) override;

    virtual void dispose() override;

    void SetOffset(Point aOffset);

    void ShowAll(bool bShow);

    bool Contains(const Point &rDocPt) const;

    bool IsEmptyHeaderFooter( ) const;

    void ExecuteCommand(std::u16string_view rIdent);

private:

    DECL_LINK(FadeHandler, Timer *, void);

    DECL_LINK(ClickHdl, weld::Button&, void);

    DECL_LINK(SelectHdl, const OUString&, void);

    void PaintButton();

};

#endif

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