textinput_v2.h

Go to the documentation of this file.

/*
    SPDX-FileCopyrightText: 2016 Martin Gräßlin <mgraesslin@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>
 
#include "textinput.h"
 
struct wl_resource;
namespace KWin
{
class ClientConnection;
class Display;
class SeatInterface;
class SurfaceInterface;
class TextInputV2Interface;
class TextInputV2InterfacePrivate;
class TextInputManagerV2InterfacePrivate;
 
class KWIN_EXPORT TextInputManagerV2Interface : public QObject
{
    Q_OBJECT
public:
    explicit TextInputManagerV2Interface(Display *display, QObject *parent = nullptr);
    ~TextInputManagerV2Interface() override;
 
private:
    std::unique_ptr<TextInputManagerV2InterfacePrivate> d;
};
 
class KWIN_EXPORT TextInputV2Interface : public QObject
{
    Q_OBJECT
public:
    ~TextInputV2Interface() override;
 
    enum class UpdateReason : uint32_t {
        StateChange = 0, // updated state because it changed
        StateFull = 1, // full state after enter or input_method_changed event
        StateReset = 2, // full state after reset
        StateEnter = 3, // full state after switching focus to a different widget on client side
    };
    Q_ENUM(UpdateReason)
    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 keysym, quint32 modifiers = 0);
    void keysymReleased(quint32 keysym, quint32 modifiers = 0);
 
    void setInputPanelState(bool visible, const QRect &overlappedSurfaceArea);
 
    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(uint32_t serial, UpdateReason reason);
 
private:
    friend class TextInputManagerV2InterfacePrivate;
    friend class SeatInterface;
    friend class SeatInterfacePrivate;
    friend class TextInputV2InterfacePrivate;
    explicit TextInputV2Interface(SeatInterface *seat);
 
    std::unique_ptr<TextInputV2InterfacePrivate> d;
};
 
}
 
Q_DECLARE_METATYPE(KWin::TextInputV2Interface *)
Q_DECLARE_METATYPE(KWin::TextInputV2Interface::UpdateReason)