plasmashell.h

Go to the documentation of this file.

/*
    SPDX-FileCopyrightText: 2015 Martin Gräßlin <mgraesslin@kde.org>
    SPDX-FileCopyrightText: 2020 David Edmundson <davidedmundson@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;
struct wl_resource;
 
namespace KWin
{
class Display;
class SurfaceInterface;
class PlasmaShellSurfaceInterface;
 
class PlasmaShellInterfacePrivate;
class PlasmaShellSurfaceInterfacePrivate;
 
class KWIN_EXPORT PlasmaShellInterface : public QObject
{
    Q_OBJECT
 
public:
    explicit PlasmaShellInterface(Display *display, QObject *parent);
    virtual ~PlasmaShellInterface();
 
Q_SIGNALS:
    void surfaceCreated(KWin::PlasmaShellSurfaceInterface *);
 
private:
    std::unique_ptr<PlasmaShellInterfacePrivate> d;
};
 
class KWIN_EXPORT PlasmaShellSurfaceInterface : public QObject
{
    Q_OBJECT
public:
    virtual ~PlasmaShellSurfaceInterface();
 
    SurfaceInterface *surface() const;
    QPoint position() const;
    bool isPositionSet() const;
 
    bool wantsOpenUnderCursor() const;
 
    enum class Role {
        Normal, 
        Desktop, 
        Panel, 
        OnScreenDisplay, 
        Notification, 
        ToolTip, 
        CriticalNotification, 
        AppletPopup, 
    };
    Role role() const;
    enum class PanelBehavior {
        AlwaysVisible, 
        AutoHide, 
        WindowsCanCover, 
        WindowsGoBelow, 
    };
    PanelBehavior panelBehavior() const;
 
    bool skipTaskbar() const;
 
    bool skipSwitcher() const;
 
    void hideAutoHidingPanel();
 
    void showAutoHidingPanel();
 
    // TODO KF6 rename to something generic
    bool panelTakesFocus() const;
 
    static PlasmaShellSurfaceInterface *get(wl_resource *native);
    static PlasmaShellSurfaceInterface *get(SurfaceInterface *surface);
 
Q_SIGNALS:
    void positionChanged();
 
    void openUnderCursorRequested();
    void roleChanged();
    void panelBehaviorChanged();
    void skipTaskbarChanged();
    void skipSwitcherChanged();
 
    void panelAutoHideHideRequested();
 
    void panelAutoHideShowRequested();
 
    /*
     * Emitted when panelTakesFocus changes
     * @see panelTakesFocus
     */
    void panelTakesFocusChanged();
 
private:
    friend class PlasmaShellInterfacePrivate;
    explicit PlasmaShellSurfaceInterface(SurfaceInterface *surface, wl_resource *resource);
    std::unique_ptr<PlasmaShellSurfaceInterfacePrivate> d;
};
 
}
 
Q_DECLARE_METATYPE(KWin::PlasmaShellSurfaceInterface::Role)
Q_DECLARE_METATYPE(KWin::PlasmaShellSurfaceInterface::PanelBehavior)