diff options
author | Eskil Abrahamsen Blomfeldt <eskil.abrahamsen-blomfeldt@qt.io> | 2021-05-11 12:43:06 +0200 |
---|---|---|
committer | Eskil Abrahamsen Blomfeldt <eskil.abrahamsen-blomfeldt@qt.io> | 2021-06-09 10:53:46 +0200 |
commit | e2df5571613f09248d26c57ccab19f85286ab6d1 (patch) | |
tree | 18dd62f7430a38ef4b8e37e86b0678cae5387bce | |
parent | 4421394b2024b744375818b82a7b7216819a2174 (diff) |
doc: Add documentation for TextInputManager
This adds some information about TextInputManager which was
missing, and also consolidates phrasing with QtTextInputMethodManager
documentation.
Fixes: QTBUG-64652
Change-Id: I51e1c86a8e06057248c7400f6e1ba5d38eb98dc5
Reviewed-by: Liang Qi <liang.qi@qt.io>
-rw-r--r-- | src/compositor/extensions/qwaylandqttextinputmethodmanager.cpp | 8 | ||||
-rw-r--r-- | src/compositor/extensions/qwaylandtextinputmanager.cpp | 27 |
2 files changed, 33 insertions, 2 deletions
diff --git a/src/compositor/extensions/qwaylandqttextinputmethodmanager.cpp b/src/compositor/extensions/qwaylandqttextinputmethodmanager.cpp index 9406482e4..8b41d5920 100644 --- a/src/compositor/extensions/qwaylandqttextinputmethodmanager.cpp +++ b/src/compositor/extensions/qwaylandqttextinputmethodmanager.cpp @@ -65,7 +65,9 @@ void QWaylandQtTextInputMethodManagerPrivate::text_input_method_manager_v1_get_t in the \c qt-text-input-method-unstable-v1 extension protocol. It is specifically designed to be used with a Qt-based input method, such as Qt Virtual Keyboard. - To use it, simply instanitate a \c QtTextInputMethodManager object inside the \l WaylandCompositor. + Instantiating this as child of a \l WaylandCompositor adds it to the list of interfaces available + to the client. If a client binds to it, then it will be used to communciate text input to + that client. */ /*! @@ -78,7 +80,9 @@ void QWaylandQtTextInputMethodManagerPrivate::text_input_method_manager_v1_get_t in the \c qt-text-input-method-unstable-v1 extension protocol. It is specifically designed to be used with a Qt-based input method, such as Qt Virtual Keyboard. - To use it, simply instanitate a \c QtTextInputMethodManager object as a child of the \l QWaylandCompositor. + Instantiating this as child of a \l WaylandCompositor adds it to the list of interfaces available + to the client. If a client binds to it, then it will be used to communciate text input to + that client. */ QWaylandQtTextInputMethodManager::QWaylandQtTextInputMethodManager() diff --git a/src/compositor/extensions/qwaylandtextinputmanager.cpp b/src/compositor/extensions/qwaylandtextinputmanager.cpp index d9938d1f3..ae95b9659 100644 --- a/src/compositor/extensions/qwaylandtextinputmanager.cpp +++ b/src/compositor/extensions/qwaylandtextinputmanager.cpp @@ -55,6 +55,33 @@ void QWaylandTextInputManagerPrivate::zwp_text_input_manager_v2_get_text_input(R textInput->initialize(); } +/*! + \qmltype TextInputManager + \instantiates QWaylandTextInputManager + \inqmlmodule QtWayland.Compositor + \brief Provides access to input methods in the compositor. + + The \c TextInputManager corresponds to the \c zwp_text_input_manager_v2 interface + in the \c text_input_unstable_v2 extension protocol. + + Instantiating this as child of a \l WaylandCompositor adds it to the list of interfaces available + to the client. If a client binds to it, then it will be used to communciate text input to + that client. +*/ + +/*! + \class QWaylandTextInputManager + \inmodule QtWaylandCompositor + \brief Provides access to input methods in the compositor. + + The \c QWaylandTextInputManager corresponds to the \c zwp_text_input_manager_v2 interface + in the \c text_input_unstable_v2 extension protocol. + + Instantiating this as child of a \l WaylandCompositor adds it to the list of interfaces available + to the client. If a client binds to it, then it will be used to communciate text input to + that client. +*/ + QWaylandTextInputManager::QWaylandTextInputManager() : QWaylandCompositorExtensionTemplate<QWaylandTextInputManager>(*new QWaylandTextInputManagerPrivate) { |