summaryrefslogtreecommitdiffstats
path: root/src/compositor/extensions/qwaylandtextinputmanager.cpp
diff options
context:
space:
mode:
authorEskil Abrahamsen Blomfeldt <eskil.abrahamsen-blomfeldt@qt.io>2021-05-11 12:43:06 +0200
committerEskil Abrahamsen Blomfeldt <eskil.abrahamsen-blomfeldt@qt.io>2021-06-09 10:53:46 +0200
commite2df5571613f09248d26c57ccab19f85286ab6d1 (patch)
tree18dd62f7430a38ef4b8e37e86b0678cae5387bce /src/compositor/extensions/qwaylandtextinputmanager.cpp
parent4421394b2024b744375818b82a7b7216819a2174 (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>
Diffstat (limited to 'src/compositor/extensions/qwaylandtextinputmanager.cpp')
-rw-r--r--src/compositor/extensions/qwaylandtextinputmanager.cpp27
1 files changed, 27 insertions, 0 deletions
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)
{