textinput_v1.h

Go to the documentation of this file.

/*
    SPDX-FileCopyrightText: 2022 Xuetian Weng <wengxt@gmail.com>
 
    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>
 
#include "textinput.h"
 
struct wl_resource;
namespace KWin
{
class ClientConnection;
class Display;
class SeatInterface;
class SurfaceInterface;
class TextInputV1Interface;
class TextInputV1InterfacePrivate;
class TextInputManagerV1InterfacePrivate;
 
class KWIN_EXPORT TextInputManagerV1Interface : public QObject
{
    Q_OBJECT
public:
    explicit TextInputManagerV1Interface(Display *display, QObject *parent = nullptr);
    ~TextInputManagerV1Interface() override;
 
private:
    std::unique_ptr<TextInputManagerV1InterfacePrivate> d;
};
 
class KWIN_EXPORT TextInputV1Interface : public QObject
{
    Q_OBJECT
public:
    explicit TextInputV1Interface(SeatInterface *seat);
    ~TextInputV1Interface() override;
 
    QString preferredLanguage() const;
 
    QRect cursorRectangle() const;
 
    TextInputContentPurpose contentPurpose() const;
 
    TextInputContentHints contentHints() const;
 
    QString surroundingText() const;
    qint32 surroundingTextCursorPosition() const;
    qint32 surroundingTextSelectionAnchor() const;
 
    QPointer<SurfaceInterface> surface() const;
 
    bool clientSupportsTextInput(ClientConnection *client) const;
 
    bool isEnabled() const;
 
    void preEdit(const QString &text, const QString &commitText);
 
    void commitString(const QString &text);
 
    void setPreEditCursor(qint32 index);
 
    void preEditStyling(uint32_t index, uint32_t length, uint32_t style);
 
    void deleteSurroundingText(quint32 beforeLength, quint32 afterLength);
 
    void setCursorPosition(qint32 index, qint32 anchor);
 
    void setTextDirection(Qt::LayoutDirection direction);
 
    void keysymPressed(quint32 time, quint32 keysym, quint32 modifiers = 0);
    void keysymReleased(quint32 time, quint32 keysym, quint32 modifiers = 0);
 
    void setInputPanelState(bool visible);
 
    void setLanguage(const QString &languageTag);
 
    void setModifiersMap(const QByteArray &modifiersMap);
 
Q_SIGNALS:
    void requestShowInputPanel();
    void requestHideInputPanel();
    void preferredLanguageChanged(const QString &language);
    void cursorRectangleChanged(const QRect &rect);
    void contentTypeChanged();
    void surroundingTextChanged();
    void enabledChanged();
    void stateUpdated(quint32 serial);
    void reset();
    void invokeAction(quint32 button, quint32 index);
 
private:
    friend class TextInputManagerV1InterfacePrivate;
    friend class SeatInterface;
    friend class SeatInterfacePrivate;
    friend class TextInputV1InterfacePrivate;
 
    std::unique_ptr<TextInputV1InterfacePrivate> d;
};
 
}
 
Q_DECLARE_METATYPE(KWin::TextInputV1Interface *)