diff --git a/src/virtualkeyboard/doc/images/gesture-double-left.png b/src/virtualkeyboard/doc/images/gesture-double-left.png new file mode 100644 index 0000000000000000000000000000000000000000..054a9e0e5d46397ebd77ac1f048b7f5021bd9893 Binary files /dev/null and b/src/virtualkeyboard/doc/images/gesture-double-left.png differ diff --git a/src/virtualkeyboard/doc/images/gesture-double-up.png b/src/virtualkeyboard/doc/images/gesture-double-up.png new file mode 100644 index 0000000000000000000000000000000000000000..127f08bad492fe7adc2fd7881946eebd61e20243 Binary files /dev/null and b/src/virtualkeyboard/doc/images/gesture-double-up.png differ diff --git a/src/virtualkeyboard/doc/images/gesture-single-down-left.png b/src/virtualkeyboard/doc/images/gesture-single-down-left.png new file mode 100644 index 0000000000000000000000000000000000000000..ac0add04b838114fbcddb0cd14760da104ae2f8a Binary files /dev/null and b/src/virtualkeyboard/doc/images/gesture-single-down-left.png differ diff --git a/src/virtualkeyboard/doc/images/gesture-single-left.png b/src/virtualkeyboard/doc/images/gesture-single-left.png new file mode 100644 index 0000000000000000000000000000000000000000..79efa2f045b115c79811837c40cf8c7d2b006fe2 Binary files /dev/null and b/src/virtualkeyboard/doc/images/gesture-single-left.png differ diff --git a/src/virtualkeyboard/doc/images/gesture-single-right.png b/src/virtualkeyboard/doc/images/gesture-single-right.png new file mode 100644 index 0000000000000000000000000000000000000000..2d1030bf84c5e92b53f34c36c939a6f79111f52a Binary files /dev/null and b/src/virtualkeyboard/doc/images/gesture-single-right.png differ diff --git a/src/virtualkeyboard/doc/images/gesture-single-up.png b/src/virtualkeyboard/doc/images/gesture-single-up.png new file mode 100644 index 0000000000000000000000000000000000000000..d82f595125551665e064387d443a72c14886b8ba Binary files /dev/null and b/src/virtualkeyboard/doc/images/gesture-single-up.png differ diff --git a/src/virtualkeyboard/doc/images/handwriting-mode-icon.png b/src/virtualkeyboard/doc/images/handwriting-mode-icon.png new file mode 100644 index 0000000000000000000000000000000000000000..38331dea2e38b04d1a8edb6515607ff0dd5552f3 Binary files /dev/null and b/src/virtualkeyboard/doc/images/handwriting-mode-icon.png differ diff --git a/src/virtualkeyboard/doc/images/language-icon.png b/src/virtualkeyboard/doc/images/language-icon.png new file mode 100644 index 0000000000000000000000000000000000000000..a9ac0302d092eea2b887ddf463b0f8e74dd8e77b Binary files /dev/null and b/src/virtualkeyboard/doc/images/language-icon.png differ diff --git a/src/virtualkeyboard/doc/src/qtvirtualkeyboard-index.qdoc b/src/virtualkeyboard/doc/src/qtvirtualkeyboard-index.qdoc index 39ba7bd31cfe84fcc1cda3c6ed2b487f3a06e64e..12c4f6b7a4a8c57309221269e53c6751fc895a0a 100644 --- a/src/virtualkeyboard/doc/src/qtvirtualkeyboard-index.qdoc +++ b/src/virtualkeyboard/doc/src/qtvirtualkeyboard-index.qdoc @@ -43,6 +43,7 @@ with possibility to easily extend the language support. \li Left-to-right and right-to-left input. \li Hardware key support for 2-way and 5-way navigation. + \li Handwriting support, with gestures for fullscreen input. \li Audio feedback. \li Cross-platform functionality. \endlist @@ -81,6 +82,7 @@ \li \l {Building Qt Virtual Keyboard} \li \l {Deployment Guide} \li \l {Technical Guide} + \li \l {User Guide} \endlist \section1 C++ Classes diff --git a/src/virtualkeyboard/doc/src/user-guide.qdoc b/src/virtualkeyboard/doc/src/user-guide.qdoc new file mode 100644 index 0000000000000000000000000000000000000000..3fdee9eaf4f99eca8fc724d5f76ca8398c7cab05 --- /dev/null +++ b/src/virtualkeyboard/doc/src/user-guide.qdoc @@ -0,0 +1,83 @@ +/****************************************************************************** +** +** Copyright (C) 2015 The Qt Company Ltd +** All rights reserved. +** For any questions to The Qt Company, please use contact form at http://qt.io +** +** This file is part of the Qt Virtual Keyboard module. +** +** Licensees holding valid commercial license for Qt may use this file in +** accordance with the Qt License Agreement provided with the Software +** or, alternatively, in accordance with the terms contained in a written +** agreement between you and The Qt Company. +** +** If you have questions regarding the use of this file, please use +** contact form at http://qt.io +** +******************************************************************************/ + +/*! + +\page user-guide.html +\contentspage {User Guide} {Contents} + +\title User Guide + +\section1 Overview + +This document explains how to interact with the virtual keyboard. + +\section1 Opening the Keyboard + +Once \l {Deployment Guide}{properly installed}, the virtual keyboard can be +opened by clicking on a text input field. + +\section1 Language + +The language can be changed by pressing the language key, which is illustrated +with a "globe" icon: + +\image language-icon.png + +The current language is displayed on the space bar key. + +\section1 Handwriting + +The handwriting mode can be activated by pressing the handwriting key: + +\image handwriting-mode-icon.png + +\section2 Gestures + +\table +\header + \li Gesture + \li Lipi Toolkit + \li T9 Write +\row + \li Backspace + \li \image gesture-single-left.png + \li \image gesture-single-left.png +\row + \li Space + \li \image gesture-single-right.png + \li \image gesture-single-right.png +\row + \li Enter + \li Gesture not available + \li \image gesture-single-down-left.png +\row + \li Reset word + \li \image gesture-double-left.png + \li Gesture not available +\row + \li Toggle input mode + \li \image gesture-single-up.png + \li Gesture not available +\row + \li Toggle text case + \li \image gesture-double-up.png + \li Gesture not available +\endtable + +*/