textinput.h

/*
    SPDX-FileCopyrightText: 2016 Martin Gräßlin <[email protected]>

    SPDX-License-Identifier: LGPL-2.1-only OR LGPL-3.0-only OR LicenseRef-KDE-Accepted-LGPL
*/
#ifndef KWAYLAND_CLIENT_TEXTINPUT_H
#define KWAYLAND_CLIENT_TEXTINPUT_H

#include <QObject>

#include <KWayland/Client/kwaylandclient_export.h>

struct wl_text_input;
struct wl_text_input_manager;
struct zwp_text_input_manager_v2;

namespace KWayland
{
namespace Client
{

class EventQueue;
class TextInputUnstableV0;
class Surface;
class Seat;

class KWAYLANDCLIENT_EXPORT TextInput : public QObject
{
    Q_OBJECT
public:
    virtual ~TextInput();
    bool isValid() const;

    Surface *enteredSurface() const;

    void setEventQueue(EventQueue *queue);
    EventQueue *eventQueue() const;

    bool isInputPanelVisible() const;

    void enable(Surface *surface);

    void disable(Surface *surface);

    void showInputPanel();

    void hideInputPanel();

    void reset();

    void setSurroundingText(const QString &text, quint32 cursor, quint32 anchor);

    enum class KeyState {
        Pressed,
        Released
    };

    enum class ContentHint : uint32_t {
        None = 0,
        AutoCompletion = 1 << 0,
        AutoCorrection = 1 << 1,
        AutoCapitalization = 1 << 2,
        LowerCase = 1 << 3,
        UpperCase = 1 << 4,
        TitleCase = 1 << 5,
        HiddenText = 1 << 6,
        SensitiveData = 1 << 7,
        Latin = 1 << 8,
        MultiLine = 1 << 9
    };
    Q_DECLARE_FLAGS(ContentHints, ContentHint)

    
    enum class ContentPurpose : uint32_t {
        Normal,
        Alpha,
        Digits,
        Number,
        Phone,
        Url,
        Email,
        Name,
        Password,
        Date,
        Time,
        DateTime,
        Terminal
    };
    void setContentType(ContentHints hints, ContentPurpose purpose);

    void setCursorRectangle(const QRect &rect);

    void setPreferredLanguage(const QString &language);

    Qt::LayoutDirection textDirection() const;

    QByteArray language() const;

    qint32 composingTextCursorPosition() const;

    QByteArray composingText() const;

    QByteArray composingFallbackText() const;

    QByteArray commitText() const;

    qint32 cursorPosition() const;

    qint32 anchorPosition() const;

    struct DeleteSurroundingText {
        quint32 beforeLength;
        quint32 afterLength;
    };
    DeleteSurroundingText deleteSurroundingText() const;

Q_SIGNALS:
    void entered();
    void left();
    void inputPanelStateChanged();
    void textDirectionChanged();
    void languageChanged();

    void keyEvent(quint32 xkbKeySym, KWayland::Client::TextInput::KeyState state, Qt::KeyboardModifiers modifiers, quint32 time);

    void composingTextChanged();

    void committed();

protected:
    class Private;
    QScopedPointer<Private> d;
    explicit TextInput(Private *p, QObject *parent = nullptr);
};

class KWAYLANDCLIENT_EXPORT TextInputManager : public QObject
{
    Q_OBJECT
public:
    virtual ~TextInputManager();

    void setup(wl_text_input_manager *textinputmanagerunstablev0);
    void setup(zwp_text_input_manager_v2 *textinputmanagerunstablev2);
    bool isValid() const;
    void release();
    void destroy();

    void setEventQueue(EventQueue *queue);
    EventQueue *eventQueue();

    TextInput *createTextInput(Seat *seat, QObject *parent = nullptr);

    operator wl_text_input_manager*();
    operator wl_text_input_manager*() const;
    operator zwp_text_input_manager_v2*();
    operator zwp_text_input_manager_v2*() const;

Q_SIGNALS:
    void removed();

protected:
    class Private;
    explicit TextInputManager(Private *p, QObject *parent = nullptr);

    QScopedPointer<Private> d;
};

}
}

Q_DECLARE_METATYPE(KWayland::Client::TextInput::KeyState)
Q_DECLARE_METATYPE(KWayland::Client::TextInput::ContentHint)
Q_DECLARE_METATYPE(KWayland::Client::TextInput::ContentPurpose)
Q_DECLARE_METATYPE(KWayland::Client::TextInput::ContentHints)
Q_DECLARE_OPERATORS_FOR_FLAGS(KWayland::Client::TextInput::ContentHints)

#endif