/****************************************************************************
**
** Copyright (C) 2016 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the Qt Virtual Keyboard module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:GPL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3 or (at your option) any later version
** approved by the KDE Free Qt Foundation. The licenses are as published by
** the Free Software Foundation and appearing in the file LICENSE.GPL3
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-3.0.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/

/*!

\page qtvirtualkeyboard-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
\target user-guide-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

*/