xdgforeign.h

/****************************************************************************
Copyright 2017  Marco Martin <[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 KWAYLAND_CLIENT_XDGFOREIGN_H
#define KWAYLAND_CLIENT_XDGFOREIGN_H

#include "surface.h"

#include <QObject>

#include <KWayland/Client/kwaylandclient_export.h>

struct zxdg_exporter_v2;
struct zxdg_importer_v2;
struct zxdg_exported_v2;
struct zxdg_imported_v2;

namespace KWayland
{
namespace Client
{

class EventQueue;
class Surface;
class XdgExported;
class XdgImported;

class KWAYLANDCLIENT_EXPORT XdgExporter : public QObject
{
    Q_OBJECT
public:
    virtual ~XdgExporter();

    void setup(zxdg_exporter_v2 *);
    bool isValid() const;
    void release();
    void destroy();

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

    XdgExported *exportTopLevel(Surface *surface, QObject *parent = nullptr);

    operator zxdg_exporter_v2*();
    operator zxdg_exporter_v2*() const;

Q_SIGNALS:
    void removed();

protected:
    class Private;
    explicit XdgExporter(Private *p, QObject *parent = nullptr);
    QScopedPointer<Private> d;
};

class KWAYLANDCLIENT_EXPORT XdgImporter : public QObject
{
    Q_OBJECT
public:
    virtual ~XdgImporter();

    void setup(zxdg_importer_v2 *);
    bool isValid() const;
    void release();
    void destroy();

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

    XdgImported *importTopLevel(const QString & handle, QObject *parent = nullptr);

    operator zxdg_importer_v2*();
    operator zxdg_importer_v2*() const;

Q_SIGNALS:
    void removed();

protected:
    class Private;
    explicit XdgImporter(Private *p, QObject *parent = nullptr);
    QScopedPointer<Private> d;
};

class KWAYLANDCLIENT_EXPORT XdgExported : public QObject
{
    Q_OBJECT
public:
    virtual ~XdgExported();

    void setup(zxdg_exported_v2 *);
    bool isValid() const;
    void release();
    void destroy();

    QString handle() const;

    operator zxdg_exported_v2*();
    operator zxdg_exported_v2*() const;

Q_SIGNALS:
    void done();

protected:
    friend class XdgExporter;
    class Private;
    explicit XdgExported(Private *p, QObject *parent = nullptr);
    QScopedPointer<Private> d;
};

class KWAYLANDCLIENT_EXPORT XdgImported : public QObject
{
    Q_OBJECT
public:
    virtual ~XdgImported();

    void setup(zxdg_imported_v2 *);
    bool isValid() const;
    void release();
    void destroy();

    void setParentOf(Surface *surface);

    operator zxdg_imported_v2*();
    operator zxdg_imported_v2*() const;

Q_SIGNALS:
    void importedDestroyed();

protected:
    friend class XdgImporter;
    class Private;
    explicit XdgImported(Private *p, QObject *parent = nullptr);
    QScopedPointer<Private> d;
};


}
}

#endif