bdb138bdcd
Currently, we have a mix of Frameworks versions and Plasma versions in @since tags, which leads to some confusion. Since this is an unstable library, one cannot rely on since version tags, we are free to add, change, and remove apis to serve best to kwin requirements. Thus, we can simply remove all since version tags to fix mixing up different product versions.
150 lines
4.3 KiB
C++
150 lines
4.3 KiB
C++
/*
|
|
SPDX-FileCopyrightText: 2018 Marco Martin <notmart@gmail.com>
|
|
|
|
SPDX-License-Identifier: LGPL-2.1-only OR LGPL-3.0-only OR LicenseRef-KDE-Accepted-LGPL
|
|
*/
|
|
#pragma once
|
|
|
|
#include <QObject>
|
|
|
|
#include <KWaylandServer/kwaylandserver_export.h>
|
|
|
|
namespace KWaylandServer
|
|
{
|
|
|
|
class Display;
|
|
class PlasmaVirtualDesktopInterface;
|
|
class PlasmaVirtualDesktopInterfacePrivate;
|
|
class PlasmaVirtualDesktopManagementInterfacePrivate;
|
|
|
|
/**
|
|
* @short Wrapper for the org_kde_plasma_virtual_desktop_management interface.
|
|
*
|
|
* This class provides a convenient wrapper for the org_kde_plasma_virtual_desktop_management interface.
|
|
*/
|
|
class KWAYLANDSERVER_EXPORT PlasmaVirtualDesktopManagementInterface : public QObject
|
|
{
|
|
Q_OBJECT
|
|
|
|
public:
|
|
explicit PlasmaVirtualDesktopManagementInterface(Display *display, QObject *parent = nullptr);
|
|
~PlasmaVirtualDesktopManagementInterface() override;
|
|
|
|
/**
|
|
* Sets how many rows the virtual desktops should be laid into
|
|
*/
|
|
void setRows(quint32 rows);
|
|
|
|
/**
|
|
* @returns A desktop identified uniquely by this id.
|
|
* If not found, nullptr will be returned.
|
|
* @see createDesktop
|
|
*/
|
|
PlasmaVirtualDesktopInterface *desktop(const QString &id);
|
|
|
|
/**
|
|
* @returns A desktop identified uniquely by this id, if not found
|
|
* a new desktop will be created for this id at a given position.
|
|
* @param id the id for the desktop
|
|
* @param position the position the desktop will be in, if not provided,
|
|
* it will be appended at the end. If the desktop was already
|
|
* existing, position is ignored.
|
|
*/
|
|
PlasmaVirtualDesktopInterface *createDesktop(const QString &id, quint32 position = std::numeric_limits<uint32_t>::max());
|
|
|
|
/**
|
|
* Removed and destroys the desktop identified by id, if present
|
|
*/
|
|
void removeDesktop(const QString &id);
|
|
|
|
/**
|
|
* @returns All tghe desktops present.
|
|
*/
|
|
QList <PlasmaVirtualDesktopInterface *> desktops() const;
|
|
|
|
/**
|
|
* Inform the clients that all the properties have been sent, and
|
|
* their client-side representation is complete.
|
|
*/
|
|
void sendDone();
|
|
|
|
Q_SIGNALS:
|
|
/**
|
|
* A desktop has been activated
|
|
*/
|
|
void desktopActivated(const QString &id);
|
|
|
|
/**
|
|
* The client asked to remove a desktop, It's responsibility of the server
|
|
* deciding whether to remove it or not.
|
|
*/
|
|
void desktopRemoveRequested(const QString &id);
|
|
|
|
/**
|
|
* The client asked to create a desktop, It's responsibility of the server
|
|
* deciding whether to create it or not.
|
|
* @param name The desired user readable name
|
|
* @param position The desired position. Normalized, guaranteed to be in the range 0-count
|
|
*/
|
|
void desktopCreateRequested(const QString &name, quint32 position);
|
|
|
|
private:
|
|
QScopedPointer<PlasmaVirtualDesktopManagementInterfacePrivate> d;
|
|
};
|
|
|
|
class KWAYLANDSERVER_EXPORT PlasmaVirtualDesktopInterface : public QObject
|
|
{
|
|
Q_OBJECT
|
|
public:
|
|
~PlasmaVirtualDesktopInterface() override;
|
|
|
|
/**
|
|
* @returns the unique id for this desktop.
|
|
* ids are set at creation time by PlasmaVirtualDesktopManagementInterface::createDesktop
|
|
* and can't be changed at runtime.
|
|
*/
|
|
QString id() const;
|
|
|
|
/**
|
|
* Sets a new name for this desktop
|
|
*/
|
|
void setName(const QString &name);
|
|
|
|
/**
|
|
* @returns the name for this desktop
|
|
*/
|
|
QString name() const;
|
|
|
|
/**
|
|
* Set this desktop as active or not.
|
|
* It's the compositor responsibility to manage the mutual exclusivity of active desktops.
|
|
*/
|
|
void setActive(bool active);
|
|
|
|
/**
|
|
* @returns true if this desktop is active. Only one at a time will be.
|
|
*/
|
|
bool isActive() const;
|
|
|
|
/**
|
|
* Inform the clients that all the properties have been sent, and
|
|
* their client-side representation is complete.
|
|
*/
|
|
void sendDone();
|
|
|
|
Q_SIGNALS:
|
|
/**
|
|
* Emitted when the client asked to activate this desktop:
|
|
* it's the decision of the server whether to perform the activation or not.
|
|
*/
|
|
void activateRequested();
|
|
|
|
private:
|
|
explicit PlasmaVirtualDesktopInterface(PlasmaVirtualDesktopManagementInterface *parent);
|
|
friend class PlasmaVirtualDesktopManagementInterface;
|
|
friend class PlasmaVirtualDesktopManagementInterfacePrivate;
|
|
|
|
QScopedPointer<PlasmaVirtualDesktopInterfacePrivate> d;
|
|
};
|
|
|
|
}
|