Add onTouchSelectionMenuRequested QML handler

Task-number: QTBUG-85043
Change-Id: Iecd2f5ae20fcf031937a1d44cc154f2e2a3ff52f
Reviewed-by: Michal Klocek <michal.klocek@qt.io>

1 files changed, 103 insertions, 0 deletions

diff --git a/src/webenginequick/doc/src/touch_selection_menu_request.qdoc b/src/webenginequick/doc/src/touch_selection_menu_request.qdoc
new file mode 100644
index 000000000..da4c2062a
--- /dev/null
+++ b/src/webenginequick/doc/src/touch_selection_menu_request.qdoc
@@ -0,0 +1,103 @@
+/****************************************************************************
+**
+** Copyright (C) 2021 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 TouchSelectionMenuRequest
+    //! \instantiates QQuickWebEngineTouchSelectionMenuRequest
+    \inqmlmodule QtWebEngine
+    \since QtWebEngine 6.3
+
+    \brief A request for showing a touch selection menu.
+
+    A TouchSelectionMenuRequest is passed as an argument of the
+    WebEngineView::touchSelectionMenuRequest signal. It provides further
+    information about the context of the request. The \l selectionBounds
+    property provides the origin of the request.
+
+    The \l accepted property of the request indicates whether the request
+    is handled by the user code or the default touch selection menu should
+    be displayed.
+
+    The following code uses a custom menu to handle the request:
+
+    \code
+    WebEngineView {
+        id: view
+        // ...
+        onTouchSelectionMenuRequested: function(request) {
+            request.accepted = true;
+            myMenu.x = request.selectionBounds.x;
+            myMenu.y = request.selectionBounds.y;
+            myMenu.trigger.connect(view.triggerWebAction);
+            myMenu.popup();
+        }
+        // ...
+    }
+    \endcode
+*/
+
+/*!
+    \qmlproperty rect TouchSelectionMenuRequest::selectionBounds
+    \readonly
+
+    The position of the bound rectangle from the touch text
+    selection.
+*/
+
+/*!
+    \qmlproperty bool TouchSelectionMenuRequest::accepted
+
+    Indicates whether the touch selection menu request has
+    been handled by the signal handler.
+
+    If the property is \c false after any signal handlers
+    for WebEngineView::touchSelectionMenuRequested have been executed,
+    a default touch selection menu will be shown.
+    To prevent this, set \c{request.accepted} to \c true.
+
+    The default is \c false.
+
+    \note The default content of the touch selection menu depends
+    on the web element for which the request was actually generated.
+*/
+
+
+/*!
+    \qmlproperty flags QQuickWebEngineTouchSelectionMenuRequest::touchSelectionCommandFlags
+    \readonly
+    \since QtWebEngine 6.3
+
+    \note In the default touch selection menu, showing the context menu
+    is always available as a separate action.
+
+    \value  QQuickWebEngineTouchSelectionMenuRequest.Cut
+            Cut is available.
+    \value  QQuickWebEngineTouchSelectionMenuRequest.Copy
+            Copy is available.
+    \value  QQuickWebEngineTouchSelectionMenuRequest.Paste
+            Paste is available.
+*/