plasmashell.h

/*
    SPDX-FileCopyrightText: 2015 Martin Gräßlin <[email protected]>

    SPDX-License-Identifier: LGPL-2.1-only OR LGPL-3.0-only OR LicenseRef-KDE-Accepted-LGPL
*/
#ifndef WAYLAND_PLASMASHELL_H
#define WAYLAND_PLASMASHELL_H

#include <QObject>
#include <QSize>

#include <KWayland/Client/kwaylandclient_export.h>

struct wl_surface;
struct org_kde_plasma_shell;
struct org_kde_plasma_surface;

namespace KWayland
{
namespace Client
{
class EventQueue;
class Surface;
class PlasmaShellSurface;

class KWAYLANDCLIENT_EXPORT PlasmaShell : public QObject
{
    Q_OBJECT
public:
    explicit PlasmaShell(QObject *parent = nullptr);
    virtual ~PlasmaShell();

    bool isValid() const;
    void release();
    void destroy();
    void setup(org_kde_plasma_shell *shell);

    void setEventQueue(EventQueue *queue);
    EventQueue *eventQueue();

    PlasmaShellSurface *createSurface(wl_surface *surface, QObject *parent = nullptr);
    PlasmaShellSurface *createSurface(Surface *surface, QObject *parent = nullptr);

    operator org_kde_plasma_shell*();
    operator org_kde_plasma_shell*() const;

Q_SIGNALS:
    void interfaceAboutToBeReleased();
    void interfaceAboutToBeDestroyed();

    void removed();

private:
    class Private;
    QScopedPointer<Private> d;
};

class KWAYLANDCLIENT_EXPORT PlasmaShellSurface : public QObject
{
    Q_OBJECT
public:
    explicit PlasmaShellSurface(QObject *parent);
    virtual ~PlasmaShellSurface();

    void release();
    void destroy();
    void setup(org_kde_plasma_surface *surface);

    static PlasmaShellSurface *get(Surface *surf);

    bool isValid() const;
    operator org_kde_plasma_surface*();
    operator org_kde_plasma_surface*() const;

    enum class Role {
        Normal, 
        Desktop, 
        Panel, 
        OnScreenDisplay, 
        Notification, 
        ToolTip, 
        CriticalNotification, 
    };
    void setRole(Role role);
    Role role() const;
    void setPosition(const QPoint &point);

    enum class PanelBehavior {
        AlwaysVisible,
        AutoHide,
        WindowsCanCover,
        WindowsGoBelow
    };
    void setPanelBehavior(PanelBehavior behavior);

    void setSkipTaskbar(bool skip);

    void setSkipSwitcher(bool skip);

    void requestHideAutoHidingPanel();

    void requestShowAutoHidingPanel();

    //KF6 TODO rename to make it generic
    void setPanelTakesFocus(bool takesFocus);

Q_SIGNALS:
    void autoHidePanelHidden();

    void autoHidePanelShown();

private:
    friend class PlasmaShell;
    class Private;
    QScopedPointer<Private> d;
};

}
}

Q_DECLARE_METATYPE(KWayland::Client::PlasmaShellSurface::Role)
Q_DECLARE_METATYPE(KWayland::Client::PlasmaShellSurface::PanelBehavior)

#endif