pointer.h

Go to the documentation of this file.

/*
    SPDX-FileCopyrightText: 2014 Martin Gräßlin <mgraesslin@kde.org>
    SPDX-FileCopyrightText: 2020 Adrien Faveraux <ad1rie3@hotmail.fr>
    SPDX-FileCopyrightText: 2021 Vlad Zahorodnii <vlad.zahorodnii@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>
 
struct wl_resource;
 
namespace KWin
{
class PointerSurfaceCursorPrivate;
class PointerSurfaceCursor;
class PointerInterfacePrivate;
class SeatInterface;
class SurfaceInterface;
 
enum class PointerAxisSource;
enum class PointerAxisRelativeDirection;
enum class PointerButtonState : quint32;
 
using PointerCursor = std::variant<PointerSurfaceCursor *, QByteArray>;
 
class KWIN_EXPORT PointerInterface : public QObject
{
    Q_OBJECT
 
public:
    ~PointerInterface() override;
 
    SurfaceInterface *focusedSurface() const;
    quint32 focusedSerial() const;
 
    SeatInterface *seat() const;
 
    static PointerInterface *get(wl_resource *native);
 
    void sendEnter(SurfaceInterface *surface, const QPointF &position, quint32 serial);
    void sendLeave(quint32 serial);
    void sendButton(quint32 button, PointerButtonState state, quint32 serial);
    void sendAxis(Qt::Orientation orientation, qreal delta, qint32 deltaV120, PointerAxisSource source, PointerAxisRelativeDirection direction);
    void sendMotion(const QPointF &position);
    void sendFrame();
 
Q_SIGNALS:
    void cursorChanged(const PointerCursor &cursor);
    void focusedSurfaceChanged();
 
private:
    explicit PointerInterface(SeatInterface *seat);
    std::unique_ptr<PointerInterfacePrivate> d;
 
    friend class SeatInterfacePrivate;
    friend class PointerInterfacePrivate;
};
 
class KWIN_EXPORT PointerSurfaceCursor
{
public:
    PointerSurfaceCursor();
    ~PointerSurfaceCursor();
 
    QPointF hotspot() const;
    SurfaceInterface *surface() const;
 
private:
    std::unique_ptr<PointerSurfaceCursorPrivate> d;
    friend class PointerInterfacePrivate;
};
 
} // namespace KWin