summaryrefslogtreecommitdiffstats
path: root/src/webenginequick/doc
diff options
context:
space:
mode:
authorMichal Klocek <michal.klocek@qt.io>2022-05-04 23:02:58 +0200
committerMichal Klocek <michal.klocek@qt.io>2022-05-10 19:54:01 +0000
commitf02fb09627a0023c5b6988c1067486fef3957d83 (patch)
treedf4bb6029412be8e1572facd634d0310d0e13274 /src/webenginequick/doc
parentc92314eecb1c6140c80ab232197d5bd0ddfa26fa (diff)
Cleanup custom touch handles implementation
Do not introduce extra class nor dummy QML element. Fix docs. Change-Id: I9848f6865cd585779d89fe387ad97c27e7450eb9 Reviewed-by: Kirill Burtsev <kirill.burtsev@qt.io>
Diffstat (limited to 'src/webenginequick/doc')
-rw-r--r--src/webenginequick/doc/src/custom_touch_handle.qdoc52
-rw-r--r--src/webenginequick/doc/src/webengineview_lgpl.qdoc24
2 files changed, 21 insertions, 55 deletions
diff --git a/src/webenginequick/doc/src/custom_touch_handle.qdoc b/src/webenginequick/doc/src/custom_touch_handle.qdoc
deleted file mode 100644
index 8ef193d16..000000000
--- a/src/webenginequick/doc/src/custom_touch_handle.qdoc
+++ /dev/null
@@ -1,52 +0,0 @@
-/****************************************************************************
-**
-** Copyright (C) 2022 The Qt Company Ltd.
-** Contact: https://www.qt.io/licensing/
-**
-** This file is part of the documentation of the Qt Toolkit.
-**
-** $QT_BEGIN_LICENSE:FDL$
-** 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 Free Documentation License Usage
-** Alternatively, this file may be used under the terms of the GNU Free
-** Documentation License version 1.3 as published by the Free Software
-** Foundation and appearing in the file included in the packaging of
-** this file. Please review the following information to ensure
-** the GNU Free Documentation License version 1.3 requirements
-** will be met: https://www.gnu.org/licenses/fdl-1.3.html.
-** $QT_END_LICENSE$
-**
-****************************************************************************/
-
-/*!
- \qmltype CustomTouchHandle
- \inqmlmodule QtWebEngine
- \since QtWebEngine 6.4
-
- \brief Data class for representing the touch handle QML delegate.
-
- The handle's position, opacity, and visibility are updated automatically.
- The delegate should be a QML Item or any QML type which inherits it.
-
- The following code uses a custom touch handle delegate:
-
- \code
- WebEngineView {
- // ...
- touchHandleDelegate: Rectangle {
- color: "red"
- }
- // ...
- }
- \endcode
-
- \note The bounding box which propagates the touch event is provided by
- Chromium and the text selection can be moved even if there is no handle drawn.
-*/
diff --git a/src/webenginequick/doc/src/webengineview_lgpl.qdoc b/src/webenginequick/doc/src/webengineview_lgpl.qdoc
index ae3ea1c23..6e3d9ebe3 100644
--- a/src/webenginequick/doc/src/webengineview_lgpl.qdoc
+++ b/src/webenginequick/doc/src/webengineview_lgpl.qdoc
@@ -1493,11 +1493,29 @@
*/
/*!
- \qmlproperty CustomTouchHandle WebEngineView::touchHandleDelegate
+ \qmlproperty Component WebEngineView::touchHandleDelegate
\since QtWebEngine 6.4
- If a QML Item is set, the default touch handles will not be shown and
- this item will be displayed as touch handles.
+ The \a touchHandleDelegate provides a template defining visual touch handles instantiated by the view
+ whenever touch selection handling is required.
+
+ The handle's position, opacity, and visibility are updated automatically.
+ The delegate should be a QML Item or any QML type which inherits it.
+
+ \note If no QML Item is set, the default touch handles will be shown.
+
+ The following code uses a custom touch handle delegate:
+
+ \code
+ WebEngineView {
+ // ...
+ touchHandleDelegate: Rectangle {
+ color: "red"
+ }
+ // ...
+ }
+ \endcode
+*/
\sa {WebEngine Qt Quick Custom Touch Handle Example}
*/