aboutsummaryrefslogtreecommitdiffstats
path: root/src/quick/items/qquickitem.cpp
diff options
context:
space:
mode:
authorTopi Reinio <topi.reinio@digia.com>2015-08-04 13:41:12 +0200
committerTopi Reiniƶ <topi.reinio@digia.com>2015-08-04 13:50:51 +0000
commitcb182b46cdbf2fa166bd584afefb07fa90c2b6df (patch)
treed5cfbd1818ef90c5067d331b491f837569504646 /src/quick/items/qquickitem.cpp
parent38fe08b8af9015264a1f8a5f4dcf1dd40f04f4ba (diff)
Doc: Fix QtQuick::EnterKey QML type documentation
Fix QDoc warnings and edit language/formatting. Change-Id: I38f4683c582e444079bff488d0d2e0d9682a7085 Reviewed-by: Venugopal Shivashankar <venugopal.shivashankar@digia.com>
Diffstat (limited to 'src/quick/items/qquickitem.cpp')
-rw-r--r--src/quick/items/qquickitem.cpp53
1 files changed, 32 insertions, 21 deletions
diff --git a/src/quick/items/qquickitem.cpp b/src/quick/items/qquickitem.cpp
index f6bae315ec..22290d4fc1 100644
--- a/src/quick/items/qquickitem.cpp
+++ b/src/quick/items/qquickitem.cpp
@@ -1614,34 +1614,45 @@ void QQuickItemPrivate::setLayoutMirror(bool mirror)
\inqmlmodule QtQuick
\ingroup qtquick-input
\since 5.6
- \brief Property used to manipulate Enter key appearance
+ \brief Provides a property to manipulate the appearance of Enter key on
+ an on-screen keyboard.
- The EnterKey attached property is used to manipulate the appearance and behavior of the Enter key
- on an on-screen keyboard.
+ The EnterKey attached property is used to manipulate the appearance and
+ behavior of the Enter key on an on-screen keyboard.
*/
/*!
- \qmlproperty bool QtQuick::EnterKey::type
+ \qmlproperty enumeration QtQuick::EnterKey::type
- This property holds the type of the Enter key.
+ Holds the type of the Enter key.
- \note Not all of these values are supported on all platforms.
- For unsupported values the default key will be used instead.
+ \note Not all of these values are supported on all platforms. For
+ unsupported values the default key is used instead.
- \li Qt.EnterKeyDefault The default Enter key.
- This can either be a button closing the keyboard, or a Return button
- causing a new line in case of a multi-line input field.
- \li Qt.EnterKeyReturn Show a Return button that inserts a new line.
- \li Qt.EnterKeyDone Show a "Done" button.
- Typically the keyboard is expected to close when the button is pressed.
- \li Qt.EnterKeyGo Show a "Go" button.
- Typically used in an address bar when entering a URL.
- \li Qt.EnterKeySend Show a "Send" button.
- \li Qt.EnterKeySearch Show a "Search" button.
- \li Qt.EnterKeyNext Show a "Next" button.
- Typically used in a form to allow navigating to the next input field
- without the keyboard closing.
- \li Qt.EnterKeyPrevious Show a "Previous" button.
+ \value Qt.EnterKeyDefault The default Enter key. This can be either a
+ button to accept the input and close the
+ keyboard, or a \e Return button to enter a
+ newline in case of a multi-line input field.
+
+ \value Qt.EnterKeyReturn Show a \e Return button that inserts a
+ newline.
+
+ \value Qt.EnterKeyDone Show a \e {"Done"} button. Typically, the
+ keyboard is expected to close when the button
+ is pressed.
+
+ \value Qt.EnterKeyGo Show a \e {"Go"} button. Typically used in an
+ address bar when entering a URL.
+
+ \value Qt.EnterKeySend Show a \e {"Send"} button.
+
+ \value Qt.EnterKeySearch Show a \e {"Search"} button.
+
+ \value Qt.EnterKeyNext Show a \e {"Next"} button. Typically used in a
+ form to allow navigating to the next input
+ field without the keyboard closing.
+
+ \value Qt.EnterKeyPrevious Show a \e {"Previous"} button.
*/
QQuickEnterKeyAttached::QQuickEnterKeyAttached(QObject *parent)