blob: 1555caf9286f9bcf012bdb395fc76e911941050b (
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
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
|
// Copyright (C) 2016 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only
#include <QtVirtualKeyboard/private/enterkeyaction_p.h>
#include <QtVirtualKeyboard/private/enterkeyactionattachedtype_p.h>
QT_BEGIN_NAMESPACE
namespace QtVirtualKeyboard {
/*!
\qmltype EnterKeyAction
\inqmlmodule QtQuick.VirtualKeyboard
\ingroup qmlclass
\ingroup qtvirtualkeyboard-qml
\brief Provides attached properties for customizing the enter key.
The EnterKeyAction type provides attached properties which allows
customizing the enter key button of the keyboard.
The EnterKeyAction must be used directly inside the item
receiving input focus, e.g. TextInput.
For example:
\code
TextInput {
id: myInput
EnterKeyAction.enabled: myInput.text.length > 0 || myInput.inputMethodComposing
EnterKeyAction.label: "Next"
Keys.onReleased: {
if (event.key === Qt.Key_Return) {
// execute action
}
}
}
\endcode
*/
/*!
\class QtVirtualKeyboard::EnterKeyAction
\internal
*/
/*!
\internal
*/
EnterKeyActionAttachedType *EnterKeyAction::qmlAttachedProperties(QObject *object)
{
return new EnterKeyActionAttachedType(object);
}
/*!
\qmlattachedproperty int EnterKeyAction::actionId
Sets the action id for the enter key in virtual keyboard.
When the action id is set, it takes preference over the label
and sets the icon for the enter key.
\list
\li \c EnterKeyAction.None No action defined.
\li \c EnterKeyAction.Go Action performs go operation.
For example taking user to the entered url.
\li \c EnterKeyAction.Search Action performs search operation.
\li \c EnterKeyAction.Send Action sends the entered text.
\li \c EnterKeyAction.Next Action moves the input focus to
the next field accepting text input.
\li \c EnterKeyAction.Done Same as \c EnterKeyAction.Next,
except all the text input is done.
\endlist
*/
/*!
\qmlattachedproperty string EnterKeyAction::label
Sets the label for the enter key in virtual keyboard.
*/
/*!
\qmlattachedproperty bool EnterKeyAction::enabled
Enables or disables the enter key button in virtual keyboard.
*/
} // namespace QtVirtualKeyboard
QT_END_NAMESPACE
|