PySide6.QtWebEngineCore.QWebEngineContextMenuRequest

class QWebEngineContextMenuRequest

The QWebEngineContextMenuRequest class provides request for populating or extending a context menu with actions.

Details

QWebEngineContextMenuRequest is returned by lastContextMenuRequest() after a context menu event, and contains information about where the context menu event took place. This is also in the context in which any context specific WebAction will be performed.

Synopsis

Properties

• acceptedᅟ - Whether the request is accepted

• editFlagsᅟ

• isContentEditableᅟ

• linkTextᅟ

• linkUrlᅟ

• mediaFlagsᅟ

• mediaTypeᅟ

• mediaUrlᅟ

• misspelledWordᅟ

• positionᅟ

• selectedTextᅟ

• spellCheckerSuggestionsᅟ

Methods

• def editFlags()

• def isAccepted()

• def isContentEditable()

• def linkText()

• def linkUrl()

• def mediaFlags()

• def mediaType()

• def mediaUrl()

• def misspelledWord()

• def position()

• def selectedText()

• def setAccepted()

• def spellCheckerSuggestions()

Note

This documentation may contain snippets that were automatically translated from C++ to Python. We always welcome contributions to the snippet translation. If you see an issue with the translation, you can also let us know by creating a ticket on https:/bugreports.qt.io/projects/PYSIDE

class MediaType

This enum describes the media type of the context menu request if any.

Constant	Description
QWebEngineContextMenuRequest.MediaType.MediaTypeNone	The context is not a media type.
QWebEngineContextMenuRequest.MediaType.MediaTypeImage	The context is an image element.
QWebEngineContextMenuRequest.MediaType.MediaTypeVideo	The context is a video element.
QWebEngineContextMenuRequest.MediaType.MediaTypeAudio	The context is an audio element.
QWebEngineContextMenuRequest.MediaType.MediaTypeCanvas	The context is a canvas element.
QWebEngineContextMenuRequest.MediaType.MediaTypeFile	The context is a file.
QWebEngineContextMenuRequest.MediaType.MediaTypePlugin	The context is a plugin element.

class MediaFlag

(inherits enum.Flag) The current media element’s status and its available operations. MediaNone if the selected web page content is not a media element.

Constant	Description
QWebEngineContextMenuRequest.MediaFlag.MediaInError	An error occurred.
QWebEngineContextMenuRequest.MediaFlag.MediaPaused	Media is paused.
QWebEngineContextMenuRequest.MediaFlag.MediaMuted	Media is muted.
QWebEngineContextMenuRequest.MediaFlag.MediaLoop	Media can be looped.
QWebEngineContextMenuRequest.MediaFlag.MediaCanSave	Media can be saved.
QWebEngineContextMenuRequest.MediaFlag.MediaHasAudio	Media has audio.
QWebEngineContextMenuRequest.MediaFlag.MediaCanToggleControls	Media can show controls.
QWebEngineContextMenuRequest.MediaFlag.MediaControls	Media controls are shown.
QWebEngineContextMenuRequest.MediaFlag.MediaCanPrint	Media is printable.
QWebEngineContextMenuRequest.MediaFlag.MediaCanRotate	Media is rotatable.

class EditFlag

(inherits enum.Flag) The available edit operations in the current context menu request.

Constant	Description
QWebEngineContextMenuRequest.EditFlag.CanUndo	Undo is available.
QWebEngineContextMenuRequest.EditFlag.CanRedo	Redo is available.
QWebEngineContextMenuRequest.EditFlag.CanCut	Cut is available.
QWebEngineContextMenuRequest.EditFlag.CanCopy	Copy is available.
QWebEngineContextMenuRequest.EditFlag.CanPaste	Paste is available.
QWebEngineContextMenuRequest.EditFlag.CanDelete	Delete is available.
QWebEngineContextMenuRequest.EditFlag.CanSelectAll	Select All is available.
QWebEngineContextMenuRequest.EditFlag.CanTranslate	Translate is available.
QWebEngineContextMenuRequest.EditFlag.CanEditRichly	Context is richly editable.

Note

Properties can be used directly when from __feature__ import true_property is used or via accessor functions otherwise.

property acceptedᅟ: bool

This property holds Whether the request is accepted..

Access functions:

• isAccepted()

• setAccepted()

property editFlagsᅟ: Combination of QWebEngineContextMenuRequest.EditFlag

Access functions:

• editFlags()

property isContentEditableᅟ: bool

Access functions:

• isContentEditable()

property linkTextᅟ: str

Access functions:

• linkText()

property linkUrlᅟ: QUrl

Access functions:

• linkUrl()

property mediaFlagsᅟ: Combination of QWebEngineContextMenuRequest.MediaFlag

Access functions:

• mediaFlags()

property mediaTypeᅟ: QWebEngineContextMenuRequest.MediaType

Access functions:

• mediaType()

property mediaUrlᅟ: QUrl

Access functions:

• mediaUrl()

property misspelledWordᅟ: str

Access functions:

• misspelledWord()

property positionᅟ: QPoint

Access functions:

• position()

property selectedTextᅟ: str

Access functions:

• selectedText()

property spellCheckerSuggestionsᅟ: list of strings

Access functions:

• spellCheckerSuggestions()

editFlags()

Return type:

Combination of EditFlag

Returns the available edit operations in the current context or CanDoNone if no actions are available.

Getter of property editFlagsᅟ .

isAccepted()

Return type:

bool

Getter of property acceptedᅟ .

isContentEditable()

Return type:

bool

Returns true if the context menu request is editable by the user; otherwise returns false.

Getter of property isContentEditableᅟ .

linkText()

Return type:

str

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

Getter of property linkTextᅟ .

linkUrl()

Return type:

QUrl

Returns the URL of a link if the menu context request is a link. It is not guaranteed to be a valid URL.

Getter of property linkUrlᅟ .

mediaFlags()

Return type:

Combination of MediaFlag

Returns the current media element’s status and its available operations. MediaNone if the selected web page content is not a media element.

Getter of property mediaFlagsᅟ .

mediaType()

Return type:

MediaType

Returns the type of the media element or MediaTypeNone if the context menu requestis not a media element.

Getter of property mediaTypeᅟ .

mediaUrl()

Return type:

QUrl

If the context menu request is a media element, returns the URL of that media.

Getter of property mediaUrlᅟ .

misspelledWord()

Return type:

str

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

For possible replacements of the word, see spellCheckerSuggestions() .

Getter of property misspelledWordᅟ .

position()

Return type:

QPoint

Returns the position of the context menu request, usually the mouse position where the context menu event was triggered.

Getter of property positionᅟ .

selectedText()

Return type:

str

Returns the selected text of the context menu request.

Getter of property selectedTextᅟ .

setAccepted(accepted)

Parameters:

accepted – bool

See also

isAccepted()

Setter of property acceptedᅟ .

spellCheckerSuggestions()

Return type:

list of strings

If the menu context request is a word considered misspelled by the spell-checker, returns a list of suggested replacements for misspelledWord() .

Getter of property spellCheckerSuggestionsᅟ .