/* ============================================================
 *
 * This file is a part of digiKam project
 * https://www.digikam.org
 *
 * Date        : 2023-05-15
 * Description : geolocation engine based on Marble.
 *               (c) 2007-2022 Marble Team
 *               https://invent.kde.org/education/marble/-/raw/master/data/credits_authors.html
 *
 * SPDX-FileCopyrightText: 2023-2026 by Gilles Caulier <caulier dot gilles at gmail dot com>
 *
 * SPDX-License-Identifier: LGPL-2.1-or-later
 *
 * ============================================================ */

#pragma once

// Qt includes

#include <Qt>

// Local includes

#include "ScreenGraphicsItem.h"
#include "digikam_export.h"

class QBrush;
class QPainterPath;

namespace Marble
{

class FrameGraphicsItemPrivate;

class DIGIKAM_EXPORT FrameGraphicsItem : public ScreenGraphicsItem
{
public:

    enum FrameType
    {
        NoFrame,
        RectFrame,
        RoundedRectFrame,
        ShadowFrame
    };

public:

    explicit FrameGraphicsItem(MarbleGraphicsItem* parent = nullptr);

    ~FrameGraphicsItem()                                      override;

    /**
     * Returns the type of the frame.
     */
    FrameType frame()                                   const;

    /**
     * Sets the type of the Frame. Standard is NoFrame.
     */
    void setFrame(FrameType type);

    /**
     * Returns the margin of the item. This is used for all margins with the value 0.0.
     * The padding is the space outside the painted space.
     */
    qreal margin()                                      const;

    /**
     * Sets the margin of the item. This is used for all margins with the value 0.0.
     */
    void setMargin(qreal margin);

    /**
     * Returns the top margin of the item.
     */
    qreal marginTop()                                   const;

    /**
     * Set the top margin of the item.
     */
    void setMarginTop(qreal marginTop);

    /**
     * Returns the bottom margin of the item.
     */
    qreal marginBottom()                                const;

    /**
     * Set the bottom margin of the item.
     */
    void setMarginBottom(qreal marginBottom);

    /**
     * Returns the left margin of the item.
     */
    qreal marginLeft()                                  const;

    /**
     * Set the left margin of the item.
     */
    void setMarginLeft(qreal marginLeft);

    /**
     * Returns the right margin of the item.
     */
    qreal marginRight()                                 const;

    /**
     * Set the right margin of the item.
     */
    void setMarginRight(qreal marginRight);

    /**
     * Returns the border width of the item.
     */
    qreal borderWidth()                                 const;

    /**
     * Set the border width of the item.
     */
    void setBorderWidth(qreal width);

    /**
     * Returns the padding of the item.
     * The padding is the empty space inside the border.
     */
    qreal padding()                                     const;

    /**
     * Set the padding of the item.
     */
    void setPadding(qreal width);

    /**
     * Returns the brush of the border.
     */
    QBrush borderBrush()                                const;

    /**
     * Change the brush of the border.
     */
    void setBorderBrush(const QBrush& brush);

    /**
     * Returns the style of the border.
     */
    Qt::PenStyle borderStyle()                          const;

    /**
     * Change the style of the border.
     */
    void setBorderStyle(Qt::PenStyle style);

    /**
     * Returns the background brush of the item.
     */
    QBrush background()                                 const;

    /**
     * Changes the background brush of the item.
     */
    void setBackground(const QBrush& background);

    QRectF paintedRect()                                const;

    QRectF contentRect()                                const override;
    QSizeF contentSize()                                const override;

    /**
     * Sets the size of the content of the item.
     * @p size is the size required for contents.
     */
    void setContentSize(const QSizeF& size)                   override;

protected:

    /**
     * Returns the shape of the background.
     */
    virtual QPainterPath backgroundShape()              const;

    /**
     * This function won't be reimplemented in most cases.
     */
    void paint(QPainter* painter)                             override;

    /**
     * Here the items paint their content.
     */
    virtual void paintContent(QPainter* painter);

    /**
     * Paints the background. This function won't be reimplemented in most cases.
     */
    virtual void paintBackground(QPainter* painter);

    explicit FrameGraphicsItem(FrameGraphicsItemPrivate* dd);

private:

    Q_DISABLE_COPY(FrameGraphicsItem)
    Q_DECLARE_PRIVATE(FrameGraphicsItem)
};

} // namespace Marble
