ContextMenuRequest QML Type | Qt WebEngine 5.10

Qt 5.10 | Qt WebEngine | QML Types | ContextMenuRequest QML Type

Qt 5.10.1 Reference Documentation

# ContextMenuRequest QML Type

A request for showing a context menu. More...

Import Statement: | import QtWebEngine 1.5
Since: | QtWebEngine 1.4

- List of all members, including inherited members

## Properties

- accepted : bool
- isContentEditable : bool
- linkText : string
- linkUrl : url
- mediaType : enumeration
- mediaUrl : url
- misspelledWord : string
- selectedText : string
- spellCheckerSuggestions : stringlist
- x : int
- y : int

## Detailed Description

A ContextMenuRequest is passed as an argument of the WebEngineView::contextMenuRequested signal. It provides further information about the context of the request. The position of the request origin can be found via the x and y properties.

The 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:

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

## Property Documentation

accepted : bool

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

If the property is `false` after any signal handlers for WebEngineView::contextMenuRequested have been executed, a default context menu will be shown. To prevent this, set `request.accepted` to `true`.

The default is `false`.

Note: The default content of the context menu depends on the web element for which the request was actually generated.

[read-only] isContentEditable : bool

Indicates whether the selected web content is editable.

[read-only] linkText : string

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

[read-only] linkUrl : url

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

[read-only] mediaType : enumeration

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

Constant | Description
--- | ---
`ContextMenuRequest.MediaTypeNone` | Not a media.
`ContextMenuRequest.MediaTypeImage` | An image.
`ContextMenuRequest.MediaTypeVideo` | A video.
`ContextMenuRequest.MediaTypeAudio` | An audio element.
`ContextMenuRequest.MediaTypeCanvas` | A canvas.
`ContextMenuRequest.MediaTypeFile` | A file.
`ContextMenuRequest.MediaTypePlugin` | A plugin.

[read-only] mediaUrl : url

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

[read-only] misspelledWord : string

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

[read-only] selectedText : string

The selected text the context menu was created for.

[read-only] spellCheckerSuggestions : stringlist

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

[read-only] x : int

The x coordinate of the user action from where the context menu request originates.

[read-only] y : int

The y coordinate of the user action from where the context menu request originates.