textinput_interface.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_SERVER_TEXTINPUT_INTERFACE_H
#define KWAYLAND_SERVER_TEXTINPUT_INTERFACE_H

#include "global.h"
#include "resource.h"

#include <KWayland/Server/kwaylandserver_export.h>

namespace KWayland
{
namespace Server
{

class Display;
class SeatInterface;
class SurfaceInterface;
class TextInputInterface;

enum class TextInputInterfaceVersion {
    UnstableV0,
    UnstableV1,
    UnstableV2
};

class KWAYLANDSERVER_EXPORT TextInputManagerInterface : public Global
{
    Q_OBJECT
public:
    virtual ~TextInputManagerInterface();

    TextInputInterfaceVersion interfaceVersion() const;

protected:
    class Private;
    explicit TextInputManagerInterface(Private *d, QObject *parent = nullptr);

private:
    Private *d_func() const;
};

class KWAYLANDSERVER_EXPORT TextInputInterface : public Resource
{
    Q_OBJECT
public:
    virtual ~TextInputInterface();

    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
    };

    TextInputInterfaceVersion interfaceVersion() const;

    QByteArray preferredLanguage() const;

    QRect cursorRectangle() const;

    ContentPurpose contentPurpose() const;

    ContentHints contentHints() const;

    QByteArray surroundingText() const;
    qint32 surroundingTextCursorPosition() const;
    qint32 surroundingTextSelectionAnchor() const;

    QPointer<SurfaceInterface> surface() const;

    bool isEnabled() const;

    void preEdit(const QByteArray &text, const QByteArray &commitText);

    void commit(const QByteArray &text);

    void setPreEditCursor(qint32 index);

    void deleteSurroundingText(quint32 beforeLength, quint32 afterLength);

    void setCursorPosition(qint32 index, qint32 anchor);

    void setTextDirection(Qt::LayoutDirection direction);

    void keysymPressed(quint32 keysym, Qt::KeyboardModifiers modifiers = Qt::NoModifier);
    void keysymReleased(quint32 keysym, Qt::KeyboardModifiers modifiers = Qt::NoModifier);

    void setInputPanelState(bool visible, const QRect &overlappedSurfaceArea);

    void setLanguage(const QByteArray &languageTag);

Q_SIGNALS:
    void requestShowInputPanel();
    void requestHideInputPanel();
    void requestReset();
    void preferredLanguageChanged(const QByteArray &language);
    void cursorRectangleChanged(const QRect &rect);
    void contentTypeChanged();
    void surroundingTextChanged();
    void enabledChanged();

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

private:
    friend class TextInputManagerUnstableV0Interface;
    friend class TextInputManagerUnstableV2Interface;
    friend class SeatInterface;

    Private *d_func() const;
};

Q_DECLARE_OPERATORS_FOR_FLAGS(TextInputInterface::ContentHints)

}
}

Q_DECLARE_METATYPE(KWayland::Server::TextInputInterfaceVersion)
Q_DECLARE_METATYPE(KWayland::Server::TextInputInterface *)
Q_DECLARE_METATYPE(KWayland::Server::TextInputInterface::ContentHint)
Q_DECLARE_METATYPE(KWayland::Server::TextInputInterface::ContentHints)
Q_DECLARE_METATYPE(KWayland::Server::TextInputInterface::ContentPurpose)

#endif