outline.h

Go to the documentation of this file.

/*
    KWin - the KDE window manager
    This file is part of the KDE project.
 
    SPDX-FileCopyrightText: 2011 Arthur Arlt <a.arlt@stud.uni-heidelberg.de>
 
    SPDX-License-Identifier: GPL-2.0-or-later
*/
 
#pragma once
#include "effect/globals.h"
#include <QObject>
#include <QRect>
#include <memory>
 
#include <kwin_export.h>
#include <memory>
 
class QQmlContext;
class QQmlComponent;
 
namespace KWin
{
class OutlineVisual;
 
class KWIN_EXPORT Outline : public QObject
{
    Q_OBJECT
    Q_PROPERTY(QRect geometry READ geometry NOTIFY geometryChanged)
    Q_PROPERTY(QRect visualParentGeometry READ visualParentGeometry NOTIFY visualParentGeometryChanged)
    Q_PROPERTY(QRect unifiedGeometry READ unifiedGeometry NOTIFY unifiedGeometryChanged)
    Q_PROPERTY(bool active READ isActive NOTIFY activeChanged)
public:
    explicit Outline();
    ~Outline() override;
 
    void setGeometry(const QRect &outlineGeometry);
 
    void setVisualParentGeometry(const QRect &visualParentGeometry);
 
    void show();
 
    void show(const QRect &outlineGeometry);
 
    void show(const QRect &outlineGeometry, const QRect &visualParentGeometry);
 
    void hide();
 
    const QRect &geometry() const;
    const QRect &visualParentGeometry() const;
    QRect unifiedGeometry() const;
 
    bool isActive() const;
 
private Q_SLOTS:
    void compositingChanged();
 
Q_SIGNALS:
    void activeChanged();
    void geometryChanged();
    void unifiedGeometryChanged();
    void visualParentGeometryChanged();
 
private:
    void createHelper();
    std::unique_ptr<OutlineVisual> m_visual;
    QRect m_outlineGeometry;
    QRect m_visualParentGeometry;
    bool m_active;
};
 
class KWIN_EXPORT OutlineVisual
{
public:
    OutlineVisual(Outline *outline);
    virtual ~OutlineVisual();
    virtual void show() = 0;
    virtual void hide() = 0;
 
protected:
    Outline *const m_outline;
};
 
class CompositedOutlineVisual : public OutlineVisual
{
public:
    CompositedOutlineVisual(Outline *outline);
    ~CompositedOutlineVisual() override;
    void show() override;
    void hide() override;
 
private:
    std::unique_ptr<QQmlContext> m_qmlContext;
    std::unique_ptr<QQmlComponent> m_qmlComponent;
    std::unique_ptr<QObject> m_mainItem;
};
}