textinput_v3.h

Go to the documentation of this file.

/*
    SPDX-FileCopyrightText: 2018 Roman Glig <subdiff@gmail.com>
    SPDX-FileCopyrightText: 2020 Bhushan Shah <bshah@kde.org>
 
    SPDX-License-Identifier: LGPL-2.1-only OR LGPL-3.0-only OR LicenseRef-KDE-Accepted-LGPL
*/
#pragma once
 
#include <QObject>
 
#include "textinput.h"
 
struct wl_resource;
namespace KWin
{
class ClientConnection;
class Display;
class SeatInterface;
class SurfaceInterface;
class TextInputV3Interface;
class TextInputV3InterfacePrivate;
class TextInputManagerV3InterfacePrivate;
 
class KWIN_EXPORT TextInputManagerV3Interface : public QObject
{
    Q_OBJECT
public:
    explicit TextInputManagerV3Interface(Display *display, QObject *parent = nullptr);
    ~TextInputManagerV3Interface() override;
 
private:
    std::unique_ptr<TextInputManagerV3InterfacePrivate> d;
};
 
class KWIN_EXPORT TextInputV3Interface : public QObject
{
    Q_OBJECT
public:
    ~TextInputV3Interface() override;
 
    QRect cursorRectangle() const;
 
    TextInputContentPurpose contentPurpose() const;
 
    TextInputContentHints contentHints() const;
 
    QString surroundingText() const;
    qint32 surroundingTextCursorPosition() const;
    qint32 surroundingTextSelectionAnchor() const;
 
    QPointer<SurfaceInterface> surface() const;
 
    bool isEnabled() const;
 
    void deleteSurroundingText(quint32 beforeLength, quint32 afterLength);
 
    void sendPreEditString(const QString &text, quint32 cursorBegin, quint32 cursorEnd);
 
    void commitString(const QString &text);
 
    void done();
 
    bool clientSupportsTextInput(ClientConnection *client) const;
 
Q_SIGNALS:
 
    void cursorRectangleChanged(const QRect &rect);
    void contentTypeChanged();
 
    void surroundingTextChanged();
 
    void enabledChanged();
 
    void stateCommitted(quint32 serial);
 
    void enableRequested();
 
private:
    friend class TextInputManagerV3InterfacePrivate;
    friend class SeatInterface;
    friend class SeatInterfacePrivate;
    friend class TextInputV3InterfacePrivate;
    explicit TextInputV3Interface(SeatInterface *seat);
 
    std::unique_ptr<TextInputV3InterfacePrivate> d;
};
 
}
 
Q_DECLARE_METATYPE(KWin::TextInputV3Interface *)