summaryrefslogtreecommitdiffstats
path: root/src/webenginequick/doc/src/context_menu_request.qdoc
blob: e7d732d5e286311079b44f3d51192c8bd0404f31 (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
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
// Copyright (C) 2020 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only

/*!
    \qmltype ContextMenuRequest
    //! \instantiates QQuickWebEngineContextMenuRequest
    \inqmlmodule QtWebEngine
    \since QtWebEngine 1.4

    \brief A request for showing a context menu.

    A ContextMenuRequest is passed as an argument of the
    WebEngineView::contextMenuRequested signal. It provides further
    information about the context of the request. The \l position
    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 context menu should
    be displayed.

    The following code uses a custom menu to handle the request:

    \code
    WebEngineView {
        id: view
        // ...
        onContextMenuRequested: function(request) {
            request.accepted = true;
            myMenu.x = request.x;
            myMenu.y = request.y;
            myMenu.trigger.connect(view.triggerWebAction);
            myMenu.popup();
        }
        // ...
    }
    \endcode
*/

/*!
    \qmlproperty point ContextMenuRequest::position
    \readonly

    The position of the user action from where the context
    menu request originates.
*/

/*!
    \qmlproperty string ContextMenuRequest::selectedText
    \readonly

    The selected text the context menu was created for.
*/

/*!
    \qmlproperty string ContextMenuRequest::linkText
    \readonly

    The text of the link if the context menu was requested for a link.
*/

/*!
    \qmlproperty url ContextMenuRequest::linkUrl
    \readonly

    The URL of the link if the selected web page content is a link.
    It is not guaranteed to be a valid URL.
*/

/*!
    \qmlproperty url ContextMenuRequest::mediaUrl
    \readonly

    The URL of media if the selected web content is a media element.
*/

/*!
    \qmlproperty enumeration ContextMenuRequest::mediaType
    \readonly

    The type of the media element or \c MediaTypeNone if
    the selected web page content is not a media element.

    \value  ContextMenuRequest.MediaTypeNone
            Not a media.
    \value  ContextMenuRequest.MediaTypeImage
            An image.
    \value  ContextMenuRequest.MediaTypeVideo
            A video.
    \value  ContextMenuRequest.MediaTypeAudio
            An audio element.
    \value  ContextMenuRequest.MediaTypeCanvas
            A canvas.
    \value  ContextMenuRequest.MediaTypeFile
            A file.
    \value  ContextMenuRequest.MediaTypePlugin
            A plugin.
*/

/*!
    \qmlproperty bool ContextMenuRequest::isContentEditable
    \readonly

    Indicates whether the selected web content is editable.
*/

/*!
    \qmlproperty string ContextMenuRequest::misspelledWord
    \readonly

    If the context is a word considered misspelled by the spell-checker,
    returns the misspelled word.
*/

/*!
    \qmlproperty stringlist ContextMenuRequest::spellCheckerSuggestions
    \readonly

    If the context is a word considered misspelled by the spell-checker,
    returns a list of suggested replacements.
*/

/*!
    \qmlproperty bool ContextMenuRequest::accepted

    Indicates whether the context menu request has been
    handled by the signal handler.

    If the property is \c false after any signal handlers
    for WebEngineView::contextMenuRequested have been executed,
    a default context 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 context menu depends on the
    web element for which the request was actually generated.
*/

/*!
    \qmlproperty flags ContextMenuRequest::mediaFlags
    \readonly
    \since QtWebEngine 1.7

    The current media element's status and its available operations.
    \c MediaNone if the selected web page content is not a media element.

    \value  ContextMenuRequest.MediaInError
            An error occurred.
    \value  ContextMenuRequest.MediaPaused
            Media is paused.
    \value  ContextMenuRequest.MediaMuted
            Media is muted.
    \value  ContextMenuRequest.MediaLoop
            Media can be looped.
    \value  ContextMenuRequest.MediaCanSave
            Media can be saved.
    \value  ContextMenuRequest.MediaHasAudio
            Media has audio.
    \value  ContextMenuRequest.MediaCanToggleControls
            Media can show controls.
    \value  ContextMenuRequest.MediaControls
            Media controls are shown.
    \value  ContextMenuRequest.MediaCanPrint
            Media is printable.
    \value  ContextMenuRequest.MediaCanRotate
            Media is rotatable.
*/

/*!
    \qmlproperty flags ContextMenuRequest::editFlags
    \readonly
    \since QtWebEngine 1.7

    The available edit operations in the current context or \c CanDoNone if no actions are available.

    \value  ContextMenuRequest.CanUndo
            Undo is available.
    \value  ContextMenuRequest.CanRedo
            Redo is available.
    \value  ContextMenuRequest.CanCut
            Cut is available.
    \value  ContextMenuRequest.CanCopy
            Copy is available.
    \value  ContextMenuRequest.CanPaste
            Paste is available.
    \value  ContextMenuRequest.CanDelete
            Delete is available.
    \value  ContextMenuRequest.CanSelectAll
            Select All is available.
    \value  ContextMenuRequest.CanTranslate
            Translate is available.
    \value  ContextMenuRequest.CanEditRichly
            Context is richly editable.
*/