shell.h

/********************************************************************
Copyright 2014  Martin Gräßlin <[email protected]>

This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2.1 of the License, or (at your option) version 3, or any
later version accepted by the membership of KDE e.V. (or its
successor approved by the membership of KDE e.V.), which shall
act as a proxy defined in Section 6 of version 3 of the license.

This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public
License along with this library.  If not, see <http://www.gnu.org/licenses/>.
*********************************************************************/
#ifndef WAYLAND_SHELL_H
#define WAYLAND_SHELL_H

#include <QObject>
#include <QPoint>
#include <QSize>
#include <QWindow>

#include <KWayland/Client/kwaylandclient_export.h>

struct wl_surface;
struct wl_shell;
struct wl_shell_surface;

namespace KWayland
{
namespace Client
{
class EventQueue;
class ShellSurface;
class Output;
class Seat;
class Surface;

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

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

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

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

    operator wl_shell*();
    operator wl_shell*() const;

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

    void removed();

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

class KWAYLANDCLIENT_EXPORT ShellSurface : public QObject
{
    Q_OBJECT
    Q_PROPERTY(QSize size READ size WRITE setSize NOTIFY sizeChanged)
public:
    explicit ShellSurface(QObject *parent);
    virtual ~ShellSurface();

    void release();
    void destroy();
    void setup(wl_shell_surface *surface);
    QSize size() const;
    void setSize(const QSize &size);

    void setFullscreen(Output *output = nullptr);
    void setMaximized(Output *output = nullptr);
    void setToplevel();
    enum class TransientFlag {
        Default = 0x0, 
        NoFocus = 0x1 
    };
    Q_DECLARE_FLAGS(TransientFlags, TransientFlag)
    void setTransient(Surface *parent, const QPoint &offset = QPoint(), TransientFlags flags = TransientFlag::Default);

    void setTransientPopup(Surface *parent, Seat *grabbedSeat, quint32 grabSerial, const QPoint &offset = QPoint(), TransientFlags flags = TransientFlag::Default);

    bool isValid() const;

    void requestMove(Seat *seat, quint32 serial);

    void requestResize(Seat *seat, quint32 serial, Qt::Edges edges);

    void setTitle(const QString &title);

    void setWindowClass(const QByteArray &windowClass);

    static ShellSurface *fromWindow(QWindow *window);

    static ShellSurface *fromQtWinId(WId wid);

    static ShellSurface *get(wl_shell_surface *native);

    operator wl_shell_surface*();
    operator wl_shell_surface*() const;

Q_SIGNALS:
    void pinged();
    void sizeChanged(const QSize &);

    void popupDone();

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

}
}

Q_DECLARE_METATYPE(KWayland::Client::ShellSurface::TransientFlag)
Q_DECLARE_METATYPE(KWayland::Client::ShellSurface::TransientFlags)

#endif