framesvg.h

/*
    SPDX-FileCopyrightText: 2008 Aaron Seigo <[email protected]>
    SPDX-FileCopyrightText: 2008 Marco Martin <[email protected]>

    SPDX-License-Identifier: LGPL-2.0-or-later
*/

#ifndef PLASMA_FRAMESVG_H
#define PLASMA_FRAMESVG_H

#include <QObject>
#include <QPixmap>

#include <plasma/plasma_export.h>

#include <plasma/plasma.h>
#include <plasma/svg.h>

class QPainter;
class QPoint;
class QPointF;
class QRect;
class QRectF;
class QSize;
class QSizeF;
class QMatrix;

namespace Plasma
{

class FrameSvgPrivate;

class PLASMA_EXPORT FrameSvg : public Svg
{
    Q_OBJECT

    Q_PROPERTY(EnabledBorders enabledBorders READ enabledBorders WRITE setEnabledBorders)

public:
    enum EnabledBorder {
        NoBorder = 0,
        TopBorder = 1,
        BottomBorder = 2,
        LeftBorder = 4,
        RightBorder = 8,
        AllBorders = TopBorder | BottomBorder | LeftBorder | RightBorder
    };
    Q_DECLARE_FLAGS(EnabledBorders, EnabledBorder)
    Q_FLAG(EnabledBorders)

    
    explicit FrameSvg(QObject *parent = nullptr);
    ~FrameSvg() override;

    Q_INVOKABLE void setImagePath(const QString &path) override;

    void setEnabledBorders(const EnabledBorders borders);

    EnabledBorders enabledBorders() const;

    Q_INVOKABLE void resizeFrame(const QSizeF &size);

    Q_INVOKABLE QSizeF frameSize() const;

    Q_INVOKABLE qreal marginSize(const Plasma::Types::MarginEdge edge) const;

    Q_INVOKABLE void getMargins(qreal &left, qreal &top, qreal &right, qreal &bottom) const;

    Q_INVOKABLE qreal fixedMarginSize(const Plasma::Types::MarginEdge edge) const;

    Q_INVOKABLE void getFixedMargins(qreal &left, qreal &top, qreal &right, qreal &bottom) const;

    Q_INVOKABLE qreal insetSize(const Plasma::Types::MarginEdge edge) const;

    Q_INVOKABLE void getInset(qreal &left, qreal &top, qreal &right, qreal &bottom) const;

    Q_INVOKABLE QRectF contentsRect() const;

    Q_INVOKABLE void setElementPrefix(Plasma::Types::Location location);

    Q_INVOKABLE void setElementPrefix(const QString &prefix);

    Q_INVOKABLE bool hasElementPrefix(const QString &prefix) const;

    Q_INVOKABLE bool hasElementPrefix(Plasma::Types::Location location) const;

    Q_INVOKABLE QString prefix();

    Q_INVOKABLE QRegion mask() const;

    QPixmap alphaMask() const;

    Q_INVOKABLE void setCacheAllRenderedFrames(bool cache);

    Q_INVOKABLE bool cacheAllRenderedFrames() const;

    Q_INVOKABLE void clearCache();

    Q_INVOKABLE QPixmap framePixmap();

    Q_INVOKABLE void paintFrame(QPainter *painter, const QRectF &target,
                                const QRectF &source = QRectF());

    Q_INVOKABLE void paintFrame(QPainter *painter, const QPointF &pos = QPointF(0, 0));

    QString actualPrefix() const;

    bool isRepaintBlocked() const;

    void setRepaintBlocked(bool blocked);

private:
    FrameSvgPrivate *const d;
    friend class FrameData;

    //Q_PRIVATE_SLOT(d, void updateSizes())
};

Q_DECLARE_OPERATORS_FOR_FLAGS(FrameSvg::EnabledBorders)

} // Plasma namespace

#endif // multiple inclusion guard