dbusinterface.h

Go to the documentation of this file.

/*
    KWin - the KDE window manager
    This file is part of the KDE project.
 
    SPDX-FileCopyrightText: 2012 Martin Gräßlin <mgraesslin@kde.org>
 
    SPDX-License-Identifier: GPL-2.0-or-later
*/
 
#pragma once
 
#include <QDBusContext>
#include <QDBusMessage>
#include <QObject>
 
#include "virtualdesktopsdbustypes.h"
 
namespace KWin
{
 
class Compositor;
class PluginManager;
class VirtualDesktopManager;
 
class DBusInterface : public QObject, protected QDBusContext
{
    Q_OBJECT
    Q_CLASSINFO("D-Bus Interface", "org.kde.KWin")
public:
    explicit DBusInterface(QObject *parent);
    ~DBusInterface() override;
 
public: // PROPERTIES
    Q_PROPERTY(bool showingDesktop READ showingDesktop NOTIFY showingDesktopChanged)
    bool showingDesktop() const;
 
public Q_SLOTS: // METHODS
    Q_NOREPLY void cascadeDesktop();
    int currentDesktop();
    Q_NOREPLY void killWindow();
    void nextDesktop();
    void previousDesktop();
    Q_NOREPLY void reconfigure();
    bool setCurrentDesktop(int desktop);
    bool startActivity(const QString &in0);
    bool stopActivity(const QString &in0);
    QString supportInformation();
    QString activeOutputName();
    Q_NOREPLY void unclutterDesktop();
    Q_NOREPLY void showDebugConsole();
 
    Q_NOREPLY void replace();
 
    QVariantMap queryWindowInfo();
 
    QVariantMap getWindowInfo(const QString &uuid);
 
    Q_NOREPLY void showDesktop(bool show);
 
Q_SIGNALS:
    void showingDesktopChanged(bool showing);
 
private Q_SLOTS:
    void onShowingDesktopChanged(bool show, bool /*animated*/);
 
private:
    QString m_serviceName;
    QDBusMessage m_replyQueryWindowInfo;
};
 
class CompositorDBusInterface : public QObject
{
    Q_OBJECT
    Q_CLASSINFO("D-Bus Interface", "org.kde.kwin.Compositing")
 
    
    Q_PROPERTY(bool active READ isActive)
 
    Q_PROPERTY(bool compositingPossible READ isCompositingPossible)
 
    Q_PROPERTY(QString compositingNotPossibleReason READ compositingNotPossibleReason)
 
    Q_PROPERTY(bool openGLIsBroken READ isOpenGLBroken)
 
    Q_PROPERTY(QString compositingType READ compositingType)
 
    Q_PROPERTY(QStringList supportedOpenGLPlatformInterfaces READ supportedOpenGLPlatformInterfaces)
 
    Q_PROPERTY(bool platformRequiresCompositing READ platformRequiresCompositing)
public:
    explicit CompositorDBusInterface(Compositor *parent);
    ~CompositorDBusInterface() override = default;
 
    bool isActive() const;
    bool isCompositingPossible() const;
    QString compositingNotPossibleReason() const;
    bool isOpenGLBroken() const;
    QString compositingType() const;
    QStringList supportedOpenGLPlatformInterfaces() const;
    bool platformRequiresCompositing() const;
 
public Q_SLOTS:
    void reinitialize();
 
Q_SIGNALS:
    void compositingToggled(bool active);
 
private:
    Compositor *m_compositor;
};
 
// TODO: disable all of this in case of kiosk?
 
class VirtualDesktopManagerDBusInterface : public QObject
{
    Q_OBJECT
    Q_CLASSINFO("D-Bus Interface", "org.kde.KWin.VirtualDesktopManager")
 
    
    Q_PROPERTY(uint count READ count NOTIFY countChanged)
 
    Q_PROPERTY(uint rows READ rows WRITE setRows NOTIFY rowsChanged)
 
    Q_PROPERTY(QString current READ current WRITE setCurrent NOTIFY currentChanged)
 
    Q_PROPERTY(bool navigationWrappingAround READ isNavigationWrappingAround WRITE setNavigationWrappingAround NOTIFY navigationWrappingAroundChanged)
 
    Q_PROPERTY(KWin::DBusDesktopDataVector desktops READ desktops NOTIFY desktopsChanged);
 
public:
    VirtualDesktopManagerDBusInterface(VirtualDesktopManager *parent);
    ~VirtualDesktopManagerDBusInterface() override = default;
 
    uint count() const;
 
    void setRows(uint rows);
    uint rows() const;
 
    void setCurrent(const QString &id);
    QString current() const;
 
    void setNavigationWrappingAround(bool wraps);
    bool isNavigationWrappingAround() const;
 
    KWin::DBusDesktopDataVector desktops() const;
 
Q_SIGNALS:
    void countChanged(uint count);
    void rowsChanged(uint rows);
    void currentChanged(const QString &id);
    void navigationWrappingAroundChanged(bool wraps);
    void desktopsChanged(KWin::DBusDesktopDataVector);
    void desktopDataChanged(const QString &id, KWin::DBusDesktopDataStruct);
    void desktopCreated(const QString &id, KWin::DBusDesktopDataStruct);
    void desktopRemoved(const QString &id);
 
public Q_SLOTS:
    void createDesktop(uint position, const QString &name);
    void setDesktopName(const QString &id, const QString &name);
    void removeDesktop(const QString &id);
 
private:
    VirtualDesktopManager *m_manager;
};
 
class PluginManagerDBusInterface : public QObject
{
    Q_OBJECT
    Q_CLASSINFO("D-Bus Interface", "org.kde.KWin.Plugins")
 
    Q_PROPERTY(QStringList LoadedPlugins READ loadedPlugins)
    Q_PROPERTY(QStringList AvailablePlugins READ availablePlugins)
 
public:
    explicit PluginManagerDBusInterface(PluginManager *manager);
 
    QStringList loadedPlugins() const;
    QStringList availablePlugins() const;
 
public Q_SLOTS:
    bool LoadPlugin(const QString &name);
    void UnloadPlugin(const QString &name);
 
private:
    PluginManager *m_manager;
};
 
} // namespace