effectwindow.h

Go to the documentation of this file.

/*
    SPDX-FileCopyrightText: 2006 Lubos Lunak <l.lunak@kde.org>
    SPDX-FileCopyrightText: 2009 Lucas Murray <lmurray@undefinedfire.com>
    SPDX-FileCopyrightText: 2010, 2011 Martin Gräßlin <mgraesslin@kde.org>
    SPDX-FileCopyrightText: 2018 Vlad Zahorodnii <vlad.zahorodnii@kde.org>
 
    SPDX-License-Identifier: GPL-2.0-or-later
*/
 
#pragma once
 
#include "kwin_export.h"
 
#include <NETWM>
 
#include <QObject>
 
class QWindow;
 
namespace KDecoration2
{
class Decoration;
}
 
namespace KWin
{
 
class EffectWindowGroup;
class EffectWindowVisibleRef;
class Group;
class Output;
class SurfaceInterface;
class VirtualDesktop;
class Window;
class WindowItem;
 
class KWIN_EXPORT EffectWindow : public QObject
{
    Q_OBJECT
    Q_PROPERTY(QRectF geometry READ frameGeometry)
    Q_PROPERTY(QRectF expandedGeometry READ expandedGeometry)
    Q_PROPERTY(qreal height READ height)
    Q_PROPERTY(qreal opacity READ opacity)
    Q_PROPERTY(QPointF pos READ pos)
    Q_PROPERTY(KWin::Output *screen READ screen)
    Q_PROPERTY(QSizeF size READ size)
    Q_PROPERTY(qreal width READ width)
    Q_PROPERTY(qreal x READ x)
    Q_PROPERTY(qreal y READ y)
    Q_PROPERTY(QList<KWin::VirtualDesktop *> desktops READ desktops)
    Q_PROPERTY(bool onAllDesktops READ isOnAllDesktops)
    Q_PROPERTY(bool onCurrentDesktop READ isOnCurrentDesktop)
    Q_PROPERTY(QRectF rect READ rect)
    Q_PROPERTY(QString windowClass READ windowClass)
    Q_PROPERTY(QString windowRole READ windowRole)
    Q_PROPERTY(bool desktopWindow READ isDesktop)
    Q_PROPERTY(bool dock READ isDock)
    Q_PROPERTY(bool toolbar READ isToolbar)
    Q_PROPERTY(bool menu READ isMenu)
    Q_PROPERTY(bool normalWindow READ isNormalWindow)
    Q_PROPERTY(bool dialog READ isDialog)
    Q_PROPERTY(bool splash READ isSplash)
    Q_PROPERTY(bool utility READ isUtility)
    Q_PROPERTY(bool dropdownMenu READ isDropdownMenu)
    Q_PROPERTY(bool popupMenu READ isPopupMenu)
    Q_PROPERTY(bool tooltip READ isTooltip)
    Q_PROPERTY(bool notification READ isNotification)
    Q_PROPERTY(bool criticalNotification READ isCriticalNotification)
    Q_PROPERTY(bool onScreenDisplay READ isOnScreenDisplay)
    Q_PROPERTY(bool comboBox READ isComboBox)
    Q_PROPERTY(bool dndIcon READ isDNDIcon)
    Q_PROPERTY(int windowType READ windowType)
    Q_PROPERTY(bool managed READ isManaged)
    Q_PROPERTY(bool deleted READ isDeleted)
    Q_PROPERTY(QString caption READ caption)
    Q_PROPERTY(bool keepAbove READ keepAbove)
    Q_PROPERTY(bool keepBelow READ keepBelow)
    Q_PROPERTY(bool minimized READ isMinimized WRITE setMinimized)
    Q_PROPERTY(bool modal READ isModal)
    Q_PROPERTY(bool moveable READ isMovable)
    Q_PROPERTY(bool moveableAcrossScreens READ isMovableAcrossScreens)
    Q_PROPERTY(QSizeF basicUnit READ basicUnit)
    Q_PROPERTY(bool move READ isUserMove)
    Q_PROPERTY(bool resize READ isUserResize)
    Q_PROPERTY(QRectF iconGeometry READ iconGeometry)
    Q_PROPERTY(bool specialWindow READ isSpecialWindow)
    Q_PROPERTY(QIcon icon READ icon)
    Q_PROPERTY(bool skipSwitcher READ isSkipSwitcher)
    Q_PROPERTY(QRectF contentsRect READ contentsRect)
    Q_PROPERTY(QRectF decorationInnerRect READ decorationInnerRect)
    Q_PROPERTY(bool hasDecoration READ hasDecoration)
    Q_PROPERTY(QStringList activities READ activities)
    Q_PROPERTY(bool onCurrentActivity READ isOnCurrentActivity)
    Q_PROPERTY(bool onAllActivities READ isOnAllActivities)
    Q_PROPERTY(bool decorationHasAlpha READ decorationHasAlpha)
    Q_PROPERTY(bool visible READ isVisible)
    Q_PROPERTY(bool skipsCloseAnimation READ skipsCloseAnimation)
 
    Q_PROPERTY(bool fullScreen READ isFullScreen)
 
    Q_PROPERTY(bool unresponsive READ isUnresponsive)
 
    Q_PROPERTY(bool waylandClient READ isWaylandClient CONSTANT)
 
    Q_PROPERTY(bool x11Client READ isX11Client CONSTANT)
 
    Q_PROPERTY(bool popupWindow READ isPopupWindow CONSTANT)
 
    Q_PROPERTY(QWindow *internalWindow READ internalWindow CONSTANT)
 
    Q_PROPERTY(bool outline READ isOutline CONSTANT)
 
    Q_PROPERTY(pid_t pid READ pid CONSTANT)
 
    Q_PROPERTY(bool lockScreen READ isLockScreen CONSTANT)
 
    Q_PROPERTY(bool hiddenByShowDesktop READ isHiddenByShowDesktop)
 
public:
    enum {
        PAINT_DISABLED = 1 << 0,
        PAINT_DISABLED_BY_DESKTOP = 1 << 1,
        PAINT_DISABLED_BY_MINIMIZE = 1 << 2,
        PAINT_DISABLED_BY_ACTIVITY = 1 << 3,
    };
 
    explicit EffectWindow(WindowItem *windowItem);
    ~EffectWindow() override;
 
    Q_SCRIPTABLE void addRepaint(const QRect &r);
    Q_SCRIPTABLE void addRepaint(int x, int y, int w, int h);
    Q_SCRIPTABLE void addRepaintFull();
    Q_SCRIPTABLE void addLayerRepaint(const QRect &r);
    Q_SCRIPTABLE void addLayerRepaint(int x, int y, int w, int h);
 
    void refWindow();
    void unrefWindow();
 
    bool isDeleted() const;
    bool isHidden() const;
    bool isHiddenByShowDesktop() const;
 
    bool isMinimized() const;
    double opacity() const;
 
    bool isOnCurrentActivity() const;
    Q_SCRIPTABLE bool isOnActivity(const QString &id) const;
    bool isOnAllActivities() const;
    QStringList activities() const;
 
    Q_SCRIPTABLE bool isOnDesktop(KWin::VirtualDesktop *desktop) const;
    bool isOnCurrentDesktop() const;
    bool isOnAllDesktops() const;
    QList<KWin::VirtualDesktop *> desktops() const;
 
    qreal x() const;
    qreal y() const;
    qreal width() const;
    qreal height() const;
    QSizeF basicUnit() const;
    QRectF frameGeometry() const;
    QRectF bufferGeometry() const;
    QRectF clientGeometry() const;
    QRectF expandedGeometry() const;
    Output *screen() const;
    QPointF pos() const;
    QSizeF size() const;
    QRectF rect() const;
    bool isMovable() const;
    bool isMovableAcrossScreens() const;
    bool isUserMove() const;
    bool isUserResize() const;
    QRectF iconGeometry() const;
 
    QRectF contentsRect() const;
    QRectF decorationInnerRect() const;
    bool hasDecoration() const;
    bool decorationHasAlpha() const;
    KDecoration2::Decoration *decoration() const;
    QByteArray readProperty(long atom, long type, int format) const;
    void deleteProperty(long atom) const;
 
    QString caption() const;
    QIcon icon() const;
    QString windowClass() const;
    QString windowRole() const;
    const EffectWindowGroup *group() const;
 
    bool isDesktop() const;
    bool isDock() const;
    bool isToolbar() const;
    bool isMenu() const;
    bool isNormalWindow() const; // normal as in 'NET::Normal or NET::Unknown non-transient'
    bool isSpecialWindow() const;
    bool isDialog() const;
    bool isSplash() const;
    bool isUtility() const;
    bool isDropdownMenu() const;
    bool isPopupMenu() const; // a context popup, not dropdown, not torn-off
    bool isTooltip() const;
    bool isNotification() const;
    bool isCriticalNotification() const;
    bool isAppletPopup() const;
    bool isOnScreenDisplay() const;
    bool isComboBox() const;
    bool isDNDIcon() const;
    NET::WindowType windowType() const;
    bool isManaged() const; // whether it's managed or override-redirect
    bool acceptsFocus() const;
    bool keepAbove() const;
    bool keepBelow() const;
 
    bool isModal() const;
    Q_SCRIPTABLE KWin::EffectWindow *findModal();
    Q_SCRIPTABLE KWin::EffectWindow *transientFor();
    Q_SCRIPTABLE QList<KWin::EffectWindow *> mainWindows() const;
 
    bool isSkipSwitcher() const;
 
    void setMinimized(bool minimize);
    void minimize();
    void unminimize();
    Q_SCRIPTABLE void closeWindow();
 
    bool isVisible() const;
 
    bool skipsCloseAnimation() const;
 
    SurfaceInterface *surface() const;
 
    bool isFullScreen() const;
 
    bool isUnresponsive() const;
 
    bool isWaylandClient() const;
 
    bool isX11Client() const;
 
    bool isPopupWindow() const;
 
    QWindow *internalWindow() const;
 
    bool isOutline() const;
 
    bool isLockScreen() const;
 
    pid_t pid() const;
 
    qlonglong windowId() const;
    QUuid internalId() const;
 
    bool isInputMethod() const;
 
    Q_SCRIPTABLE void setData(int role, const QVariant &data);
    Q_SCRIPTABLE QVariant data(int role) const;
 
    Window *window() const;
    WindowItem *windowItem() const;
    void elevate(bool elevate);
 
Q_SIGNALS:
    void windowStartUserMovedResized(KWin::EffectWindow *w);
    void windowStepUserMovedResized(KWin::EffectWindow *w, const QRectF &geometry);
    void windowFinishUserMovedResized(KWin::EffectWindow *w);
 
    void windowMaximizedStateChanged(KWin::EffectWindow *w, bool horizontal, bool vertical);
 
    void windowMaximizedStateAboutToChange(KWin::EffectWindow *w, bool horizontal, bool vertical);
 
    void windowFrameGeometryChanged(KWin::EffectWindow *window, const QRectF &oldGeometry);
 
    void windowFrameGeometryAboutToChange(KWin::EffectWindow *window);
 
    void windowOpacityChanged(KWin::EffectWindow *w, qreal oldOpacity, qreal newOpacity);
    void minimizedChanged(KWin::EffectWindow *w);
    void windowModalityChanged(KWin::EffectWindow *w);
    void windowUnresponsiveChanged(KWin::EffectWindow *w, bool unresponsive);
    void windowDamaged(KWin::EffectWindow *w);
 
    void windowKeepAboveChanged(KWin::EffectWindow *w);
 
    void windowKeepBelowChanged(KWin::EffectWindow *w);
 
    void windowFullScreenChanged(KWin::EffectWindow *w);
 
    void windowDecorationChanged(KWin::EffectWindow *window);
 
    void windowExpandedGeometryChanged(KWin::EffectWindow *window);
 
    void windowDesktopsChanged(KWin::EffectWindow *window);
 
    void windowShown(KWin::EffectWindow *w);
 
    void windowHidden(KWin::EffectWindow *w);
 
protected:
    friend EffectWindowVisibleRef;
    void refVisible(const EffectWindowVisibleRef *holder);
    void unrefVisible(const EffectWindowVisibleRef *holder);
 
private:
    class Private;
    std::unique_ptr<Private> d;
};
 
class KWIN_EXPORT EffectWindowDeletedRef
{
public:
    EffectWindowDeletedRef()
        : m_window(nullptr)
    {
    }
 
    explicit EffectWindowDeletedRef(EffectWindow *window)
        : m_window(window)
    {
        m_window->refWindow();
    }
 
    EffectWindowDeletedRef(const EffectWindowDeletedRef &other)
        : m_window(other.m_window)
    {
        if (m_window) {
            m_window->refWindow();
        }
    }
 
    ~EffectWindowDeletedRef()
    {
        if (m_window) {
            m_window->unrefWindow();
        }
    }
 
    EffectWindowDeletedRef &operator=(const EffectWindowDeletedRef &other)
    {
        if (other.m_window) {
            other.m_window->refWindow();
        }
        if (m_window) {
            m_window->unrefWindow();
        }
        m_window = other.m_window;
        return *this;
    }
 
    bool isNull() const
    {
        return m_window == nullptr;
    }
 
private:
    EffectWindow *m_window;
};
 
class KWIN_EXPORT EffectWindowVisibleRef
{
public:
    EffectWindowVisibleRef()
        : m_window(nullptr)
        , m_reason(0)
    {
    }
 
    explicit EffectWindowVisibleRef(EffectWindow *window, int reason)
        : m_window(window)
        , m_reason(reason)
    {
        m_window->refVisible(this);
    }
 
    EffectWindowVisibleRef(const EffectWindowVisibleRef &other)
        : m_window(other.m_window)
        , m_reason(other.m_reason)
    {
        if (m_window) {
            m_window->refVisible(this);
        }
    }
 
    ~EffectWindowVisibleRef()
    {
        if (m_window) {
            m_window->unrefVisible(this);
        }
    }
 
    int reason() const
    {
        return m_reason;
    }
 
    EffectWindowVisibleRef &operator=(const EffectWindowVisibleRef &other)
    {
        if (other.m_window) {
            other.m_window->refVisible(&other);
        }
        if (m_window) {
            m_window->unrefVisible(this);
        }
        m_window = other.m_window;
        m_reason = other.m_reason;
        return *this;
    }
 
    bool isNull() const
    {
        return m_window == nullptr;
    }
 
private:
    EffectWindow *m_window;
    int m_reason;
};
 
class KWIN_EXPORT EffectWindowGroup
{
public:
    explicit EffectWindowGroup(Group *group);
    virtual ~EffectWindowGroup();
 
    QList<EffectWindow *> members() const;
 
private:
    Group *m_group;
};
 
inline void EffectWindow::addRepaint(int x, int y, int w, int h)
{
    addRepaint(QRect(x, y, w, h));
}
 
inline void EffectWindow::addLayerRepaint(int x, int y, int w, int h)
{
    addLayerRepaint(QRect(x, y, w, h));
}
 
} // namespace KWin