114 lines
3 KiB
C++
114 lines
3 KiB
C++
/*
|
|
SPDX-FileCopyrightText: 2014 Martin Gräßlin <mgraesslin@kde.org>
|
|
|
|
SPDX-License-Identifier: LGPL-2.1-only OR LGPL-3.0-only OR LicenseRef-KDE-Accepted-LGPL
|
|
*/
|
|
#ifndef WAYLAND_SERVER_SUBCOMPOSITOR_INTERFACE_H
|
|
#define WAYLAND_SERVER_SUBCOMPOSITOR_INTERFACE_H
|
|
|
|
#include <QObject>
|
|
#include <QPointer>
|
|
|
|
#include <KWaylandServer/kwaylandserver_export.h>
|
|
|
|
#include "global.h"
|
|
#include "resource.h"
|
|
|
|
struct wl_resource;
|
|
|
|
namespace KWaylandServer
|
|
{
|
|
|
|
class Display;
|
|
class SurfaceInterface;
|
|
class SubSurfaceInterface;
|
|
|
|
/**
|
|
* @todo Add documentation
|
|
*/
|
|
class KWAYLANDSERVER_EXPORT SubCompositorInterface : public Global
|
|
{
|
|
Q_OBJECT
|
|
public:
|
|
virtual ~SubCompositorInterface();
|
|
|
|
Q_SIGNALS:
|
|
void subSurfaceCreated(KWaylandServer::SubSurfaceInterface*);
|
|
|
|
private:
|
|
explicit SubCompositorInterface(Display *display, QObject *parent = nullptr);
|
|
friend class Display;
|
|
class Private;
|
|
};
|
|
|
|
/**
|
|
* @todo Add documentation
|
|
*/
|
|
class KWAYLANDSERVER_EXPORT SubSurfaceInterface : public Resource
|
|
{
|
|
Q_OBJECT
|
|
Q_PROPERTY(QPoint position READ position NOTIFY positionChanged)
|
|
Q_PROPERTY(KWaylandServer::SubSurfaceInterface::Mode mode READ mode NOTIFY modeChanged)
|
|
public:
|
|
virtual ~SubSurfaceInterface();
|
|
|
|
QPoint position() const;
|
|
|
|
enum class Mode {
|
|
Synchronized,
|
|
Desynchronized
|
|
};
|
|
Mode mode() const;
|
|
|
|
/**
|
|
* Whether this SubSurfaceInterface is in synchronized mode.
|
|
* A SubSurface is in synchronized mode if either {@link mode} is
|
|
* @c Mode::Synchronized or if the parent surface is in synchronized
|
|
* mode. If a SubSurfaceInterface is in synchronized mode all child
|
|
* SubSurfaceInterfaces are also in synchronized mode ignoring the actual mode.
|
|
* @returns Whether this SubSurfaceInterface is in synchronized mode.
|
|
* @see mode
|
|
* @since 5.22
|
|
**/
|
|
bool isSynchronized() const;
|
|
|
|
// TODO: remove with ABI break (KF6)
|
|
QPointer<SurfaceInterface> surface();
|
|
/**
|
|
* @returns The surface this SubSurfaceInterface was created on.
|
|
* @since 5.22
|
|
**/
|
|
QPointer<SurfaceInterface> surface() const;
|
|
// TODO: remove with ABI break (KF6)
|
|
QPointer<SurfaceInterface> parentSurface();
|
|
/**
|
|
* @returns The parent surface for which this SubSurfaceInterface is a child
|
|
* @since 5.22
|
|
**/
|
|
QPointer<SurfaceInterface> parentSurface() const;
|
|
|
|
/**
|
|
* @returns the main surface for the sub-surface tree, that is the first surface without a parent
|
|
* @since 5.22
|
|
**/
|
|
QPointer<SurfaceInterface> mainSurface() const;
|
|
|
|
Q_SIGNALS:
|
|
void positionChanged(const QPoint&);
|
|
void modeChanged(KWaylandServer::SubSurfaceInterface::Mode);
|
|
|
|
private:
|
|
friend class SubCompositorInterface;
|
|
friend class SurfaceInterface;
|
|
friend class SurfaceInterfacePrivate;
|
|
explicit SubSurfaceInterface(SubCompositorInterface *parent, wl_resource *parentResource);
|
|
|
|
class Private;
|
|
Private *d_func() const;
|
|
};
|
|
|
|
}
|
|
|
|
Q_DECLARE_METATYPE(KWaylandServer::SubSurfaceInterface::Mode)
|
|
|
|
#endif
|