aboutsummaryrefslogtreecommitdiffstats
path: root/src/virtualkeyboard/doc/src/qtvirtualkeyboard-namespace.qdoc
blob: 6c2635e581903d131ae01590ea86a921e70f9664 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
// Copyright (C) 2022 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only

/*!
    \namespace QtVirtualKeyboard
    \inmodule QtVirtualKeyboard
    \ingroup qtvirtualkeyboard-cpp-for-devs
    \keyword Qt Virtual Keyboard Namespace
    \brief Contains enums used by the virtual keyboard classes.
*/

/*!
    \enum QtVirtualKeyboard::KeyType

    \inmodule QtVirtualKeyboard
    \ingroup qtvirtualkeyboard-cpp-for-devs

    \brief Key type for the virtual keyboard key.

    \value BaseKey
    \value BackspaceKey
    \value ChangeLanguageKey
    \value EnterKey
    \value FillerKey
    \value HandwritingModeKey
    \value HideKeyboardKey
    \value InputModeKey
    \value Key
    \value ModeKey
    \value NumberKey
    \value ShiftKey
    \value SpaceKey
    \value SymbolModeKey
    \value FlickKey
*/

/*!
    \enum QtVirtualKeyboard::KeyboardFunction

    \inmodule QtVirtualKeyboard
    \ingroup qtvirtualkeyboard-cpp-for-devs

    \brief Specifies a keyboard function to be executed by the virtual keyboard.

    This enumeration is used as an alias for predefined keyboard functions, such
    as hiding the virtual keyboard. The enumeration is used internally by the
    virtual keyboard to implement common functionality. The enumeration value is
    passed to Keyboard.doKeyboardFunction() for execution.

    \value HideInputPanel
    \value ChangeLanguage
    \value ToggleHandwritingMode
*/