summaryrefslogtreecommitdiffstats
path: root/src/webenginequick/doc/src/touch_selection_menu_request.qdoc
blob: da4c2062ae658e84cd442015c8128bbbb233d5bc (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
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
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.
*/