effectframe.h

Go to the documentation of this file.

/*
    SPDX-FileCopyrightText: 2006 Lubos Lunak <l.lunak@kde.org>
    SPDX-FileCopyrightText: 2010, 2011 Martin Gräßlin <mgraesslin@kde.org>
 
    SPDX-License-Identifier: GPL-2.0-or-later
*/
 
#pragma once
 
#include "effect/globals.h"
#include "effect/offscreenquickview.h"
 
#include <QFont>
#include <QIcon>
 
namespace KWin
{
 
class RenderTarget;
class RenderViewport;
 
enum EffectFrameStyle {
    EffectFrameNone, 
    EffectFrameUnstyled, 
    EffectFrameStyled 
};
 
class EffectFrameQuickScene : public OffscreenQuickScene
{
    Q_OBJECT
 
    Q_PROPERTY(QFont font READ font NOTIFY fontChanged)
    Q_PROPERTY(QIcon icon READ icon NOTIFY iconChanged)
    Q_PROPERTY(QSize iconSize READ iconSize NOTIFY iconSizeChanged)
    Q_PROPERTY(QString text READ text NOTIFY textChanged)
    Q_PROPERTY(qreal frameOpacity READ frameOpacity NOTIFY frameOpacityChanged)
    Q_PROPERTY(bool crossFadeEnabled READ crossFadeEnabled NOTIFY crossFadeEnabledChanged)
    Q_PROPERTY(qreal crossFadeProgress READ crossFadeProgress NOTIFY crossFadeProgressChanged)
 
public:
    EffectFrameQuickScene(EffectFrameStyle style, bool staticSize, QPoint position, Qt::Alignment alignment);
    ~EffectFrameQuickScene() override;
 
    EffectFrameStyle style() const;
    bool isStatic() const;
 
    QFont font() const;
    void setFont(const QFont &font);
    Q_SIGNAL void fontChanged(const QFont &font);
 
    QIcon icon() const;
    void setIcon(const QIcon &icon);
    Q_SIGNAL void iconChanged(const QIcon &icon);
 
    QSize iconSize() const;
    void setIconSize(const QSize &iconSize);
    Q_SIGNAL void iconSizeChanged(const QSize &iconSize);
 
    QString text() const;
    void setText(const QString &text);
    Q_SIGNAL void textChanged(const QString &text);
 
    qreal frameOpacity() const;
    void setFrameOpacity(qreal frameOpacity);
    Q_SIGNAL void frameOpacityChanged(qreal frameOpacity);
 
    bool crossFadeEnabled() const;
    void setCrossFadeEnabled(bool enabled);
    Q_SIGNAL void crossFadeEnabledChanged(bool enabled);
 
    qreal crossFadeProgress() const;
    void setCrossFadeProgress(qreal progress);
    Q_SIGNAL void crossFadeProgressChanged(qreal progress);
 
    Qt::Alignment alignment() const;
    void setAlignment(Qt::Alignment alignment);
 
    QPoint position() const;
    void setPosition(const QPoint &point);
 
private:
    void reposition();
 
    EffectFrameStyle m_style;
 
    // Position
    bool m_static;
    QPoint m_point;
    Qt::Alignment m_alignment;
 
    // Contents
    QFont m_font;
    QIcon m_icon;
    QSize m_iconSize;
    QString m_text;
    qreal m_frameOpacity = 0.0;
    bool m_crossFadeEnabled = false;
    qreal m_crossFadeProgress = 0.0;
};
 
class KWIN_EXPORT EffectFrame : public QObject
{
    Q_OBJECT
 
public:
    explicit EffectFrame(EffectFrameStyle style, bool staticSize = true, QPoint position = QPoint(-1, -1),
                         Qt::Alignment alignment = Qt::AlignCenter);
    ~EffectFrame();
 
    void free();
 
    void render(const RenderTarget &renderTarget, const RenderViewport &viewport, const QRegion &region = infiniteRegion(), double opacity = 1.0, double frameOpacity = 1.0);
 
    void setPosition(const QPoint &point);
    void setAlignment(Qt::Alignment alignment);
    Qt::Alignment alignment() const;
    void setGeometry(const QRect &geometry, bool force = false);
    QRect geometry() const;
 
    void setText(const QString &text);
    QString text() const;
    void setFont(const QFont &font);
    QFont font() const;
    void setIcon(const QIcon &icon);
    QIcon icon() const;
    void setIconSize(const QSize &size);
    QSize iconSize() const;
 
    EffectFrameStyle style() const;
 
    void enableCrossFade(bool enable);
    bool isCrossFade() const;
    void setCrossFadeProgress(qreal progress);
    qreal crossFadeProgress() const;
 
private:
    EffectFrameQuickScene *m_view;
};
 
} // namespace KWin