aboutsummaryrefslogtreecommitdiffstats
path: root/src/virtualkeyboard/doc
diff options
context:
space:
mode:
authorJarkko Koivikko <jarkko.koivikko@code-q.fi>2015-10-26 11:31:56 +0200
committerJarkko Koivikko <jarkko.koivikko@code-q.fi>2015-10-28 09:44:59 +0000
commit03e2a1036061b82739041911e3827de3cb388d02 (patch)
treee23bb1390d0fba0d69a68dfee70afdc09a496bc5 /src/virtualkeyboard/doc
parent2c5d6925ceeee7b216dead5ab87693c0d4cc0ca4 (diff)
Refactor class names
Since the virtual keyboard C++ interface is wrapped inside a namespace, it is possible to get rid of "Declarative" name in the class names, that would otherwise conflict with the QML namespace in the documentation. - Rename DeclarativeSettings to VirtualKeyboardSettings - Remove "Declarative" from class names The rationale for this change is that the name Declarative refers to now obsolete QtQuick1 module. Also, the class names are now the same in C++ and QML name spaces. Change-Id: Ide050d47110443d894d95d35dddf0df5891587be Reviewed-by: Mitch Curtis <mitch.curtis@theqtcompany.com>
Diffstat (limited to 'src/virtualkeyboard/doc')
-rw-r--r--src/virtualkeyboard/doc/src/technical-guide.qdoc10
1 files changed, 5 insertions, 5 deletions
diff --git a/src/virtualkeyboard/doc/src/technical-guide.qdoc b/src/virtualkeyboard/doc/src/technical-guide.qdoc
index 3f18187c..ddc6b1d3 100644
--- a/src/virtualkeyboard/doc/src/technical-guide.qdoc
+++ b/src/virtualkeyboard/doc/src/technical-guide.qdoc
@@ -48,7 +48,7 @@ The input framework provides the following main interfaces:
\li InputEngine: exposes an API to integrate user input events (key
presses, etc.) and acts as a host for input methods.
\li InputMethod: a base type for QML based input methods.
- \li AbstractInputMethod: a base type for C++ based input methods.
+ \li \l {QtVirtualKeyboard::AbstractInputMethod} {AbstractInputMethod}: a base type for C++ based input methods.
\endlist
\section1 The Input Context
@@ -96,7 +96,7 @@ After the locale selection is done, the keyboard updates the input locale and
input direction to match the current layout. The application can receive this
information through the QInputMethod interface.
-Internally, the current input locale is also updated to the DeclarativeInputEngine
+Internally, the current input locale is also updated to the InputEngine
and the current InputMethod instances.
\section2 UI Animations
@@ -133,7 +133,7 @@ Activating an input method is straightforward. The required steps are:
\list
\li Instantiate a concrete implementation of InputMethod or
- AbstractInputMethod
+ \l {QtVirtualKeyboard::AbstractInputMethod} {AbstractInputMethod}
\li Assign the instance to InputEngine::inputMethod
\li Set the proper input mode with InputEngine::inputMode
\endlist
@@ -274,7 +274,7 @@ touch input data from touch screens or other input devices.
\section2 Data Model for the Handwriting Input
-The data collected from the input source is stored in an object named DeclarativeTrace (C++) or \l Trace (QML).
+The data collected from the input source is stored in an object named QtVirtualKeyboard::Trace (C++) or \l Trace (QML).
By definition, a trace is a set of points collected from a single point of contact.
In addition to point data, the trace may also include data from other channels,
@@ -296,7 +296,7 @@ from a variety of input sources.
The patternRecognitionModes method returns a list of pattern recognition modes,
which are supported by the input method. A pattern recognition mode, such as
-\l { QtVirtualKeyboard::DeclarativeInputEngine::HandwritingRecoginition } { HandwritingRecoginition },
+\l { QtVirtualKeyboard::InputEngine::HandwritingRecoginition } { HandwritingRecoginition },
defines the method by which the input method processes the data.
The trace interaction is started when an input source detects a new contact point, and