plasmawindowmanagement.h

Go to the documentation of this file.

/*
    SPDX-FileCopyrightText: 2015 Martin Gräßlin <mgraesslin@kde.org>
 
    SPDX-License-Identifier: LGPL-2.1-only OR LGPL-3.0-only OR LicenseRef-KDE-Accepted-LGPL
*/
#pragma once
 
#include "kwin_export.h"
 
#include <QObject>
#include <memory>
 
class QSize;
 
namespace KWin
{
class Display;
class OutputInterface;
class PlasmaWindowActivationFeedbackInterfacePrivate;
class PlasmaWindowInterface;
class PlasmaVirtualDesktopManagementInterface;
class PlasmaWindowActivationInterfacePrivate;
class PlasmaWindowManagementInterfacePrivate;
class PlasmaWindowInterfacePrivate;
class SurfaceInterface;
 
class KWIN_EXPORT PlasmaWindowActivationInterface
{
public:
    ~PlasmaWindowActivationInterface();
 
    void sendAppId(const QString &id);
 
private:
    friend class PlasmaWindowActivationFeedbackInterface;
    explicit PlasmaWindowActivationInterface();
 
    std::unique_ptr<PlasmaWindowActivationInterfacePrivate> d;
};
 
class KWIN_EXPORT PlasmaWindowActivationFeedbackInterface : public QObject
{
    Q_OBJECT
 
public:
    explicit PlasmaWindowActivationFeedbackInterface(Display *display, QObject *parent = nullptr);
    ~PlasmaWindowActivationFeedbackInterface() override;
 
    std::unique_ptr<PlasmaWindowActivationInterface> createActivation(const QString &app_id);
 
private:
    std::unique_ptr<PlasmaWindowActivationFeedbackInterfacePrivate> d;
};
 
class KWIN_EXPORT PlasmaWindowManagementInterface : public QObject
{
    Q_OBJECT
 
public:
    explicit PlasmaWindowManagementInterface(Display *display, QObject *parent = nullptr);
    ~PlasmaWindowManagementInterface() override;
    enum class ShowingDesktopState {
        Disabled,
        Enabled,
    };
    void setShowingDesktopState(ShowingDesktopState state);
 
    PlasmaWindowInterface *createWindow(QObject *parent, const QUuid &uuid);
    QList<PlasmaWindowInterface *> windows() const;
 
    void setPlasmaVirtualDesktopManagementInterface(PlasmaVirtualDesktopManagementInterface *manager);
 
    PlasmaVirtualDesktopManagementInterface *plasmaVirtualDesktopManagementInterface() const;
 
    void setStackingOrder(const QList<quint32> &stackingOrder);
 
    void setStackingOrderUuids(const QList<QString> &stackingOrderUuids);
 
Q_SIGNALS:
    void requestChangeShowingDesktop(ShowingDesktopState requestedState);
 
private:
    std::unique_ptr<PlasmaWindowManagementInterfacePrivate> d;
};
 
class KWIN_EXPORT PlasmaWindowInterface : public QObject
{
    Q_OBJECT
public:
    ~PlasmaWindowInterface() override;
 
    void setTitle(const QString &title);
    void setAppId(const QString &appId);
    void setPid(quint32 pid);
    void setActive(bool set);
    void setMinimized(bool set);
    void setMaximized(bool set);
    void setFullscreen(bool set);
    void setKeepAbove(bool set);
    void setKeepBelow(bool set);
    void setOnAllDesktops(bool set);
    void setDemandsAttention(bool set);
    void setCloseable(bool set);
    void setMinimizeable(bool set);
    void setMaximizeable(bool set);
    void setFullscreenable(bool set);
    void setSkipTaskbar(bool skip);
    void setSkipSwitcher(bool skip);
    void setShadeable(bool set);
    void setShaded(bool set);
    void setMovable(bool set);
    void setResizable(bool set);
    void setResourceName(const QString &resourceName);
    void setVirtualDesktopChangeable(bool set);
 
    void unmap();
 
    QHash<SurfaceInterface *, QRect> minimizedGeometries() const;
 
    void setParentWindow(PlasmaWindowInterface *parentWindow);
 
    void setGeometry(const QRect &geometry);
 
    void setIcon(const QIcon &icon);
 
    void addPlasmaVirtualDesktop(const QString &id);
 
    void removePlasmaVirtualDesktop(const QString &id);
 
    QStringList plasmaVirtualDesktops() const;
 
    void addPlasmaActivity(const QString &id);
 
    void removePlasmaActivity(const QString &id);
 
    QStringList plasmaActivities() const;
 
    void setApplicationMenuPaths(const QString &serviceName, const QString &objectPath);
 
    quint32 internalId() const;
 
    QString uuid() const;
 
Q_SIGNALS:
    void closeRequested();
    void moveRequested();
    void resizeRequested();
    void activeRequested(bool set);
    void minimizedRequested(bool set);
    void maximizedRequested(bool set);
    void fullscreenRequested(bool set);
    void keepAboveRequested(bool set);
    void keepBelowRequested(bool set);
    void demandsAttentionRequested(bool set);
    void closeableRequested(bool set);
    void minimizeableRequested(bool set);
    void maximizeableRequested(bool set);
    void fullscreenableRequested(bool set);
    void skipTaskbarRequested(bool set);
    void skipSwitcherRequested(bool set);
    QRect minimizedGeometriesChanged();
    void shadeableRequested(bool set);
    void shadedRequested(bool set);
    void movableRequested(bool set);
    void resizableRequested(bool set);
    void virtualDesktopChangeableRequested(bool set);
 
    void enterPlasmaVirtualDesktopRequested(const QString &desktop);
 
    void enterNewPlasmaVirtualDesktopRequested();
 
    void leavePlasmaVirtualDesktopRequested(const QString &desktop);
 
    void enterPlasmaActivityRequested(const QString &activity);
 
    void leavePlasmaActivityRequested(const QString &activity);
 
    void sendToOutput(KWin::OutputInterface *output);
 
private:
    friend class PlasmaWindowManagementInterface;
    friend class PlasmaWindowInterfacePrivate;
    friend class PlasmaWindowManagementInterfacePrivate;
    explicit PlasmaWindowInterface(PlasmaWindowManagementInterface *wm, QObject *parent);
 
    std::unique_ptr<PlasmaWindowInterfacePrivate> d;
};
 
}
 
Q_DECLARE_METATYPE(KWin::PlasmaWindowManagementInterface::ShowingDesktopState)