QWebEngineFullScreenRequest#

The QWebEngineFullScreenRequest class enables accepting or rejecting requests for entering and exiting the fullscreen mode. More…

Synopsis#

Properties#

  • origin - URL to be opened in the fullscreen mode

  • toggleOn - Whether the web page has issued a request to enter fullscreen mode

Functions#

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

Detailed Description#

To allow elements such as videos to be shown in the fullscreen mode, applications must set FullScreenSupportEnabled and connect to fullScreenRequested , which takes a QWebEngineFullScreenRequest instance as an argument.

If an element of a web page requests to be shown in the fullscreen mode, fullScreenRequested will be emitted with an QWebEngineFullScreenRequest instance as an argument where toggleOn() returns true. The signal handler needs to then either call accept() or reject() .

If the request to enter the fullscreen mode is accepted, the element requesting fullscreen mode will fill the viewport, but it is up to the application to make the view fullscreen or to move the page to a view that is in the fullscreen mode.

Likewise, a fullScreenRequested will be emitted when the user wants to leave the full screen mode (that is, through the ExitFullScreen context menu action). In this case, toggleOn() will return false, and the signal handler again needs to accept() or reject() the request. If it is accepted, the applicaton needs to make sure that the global window state is restored.

class PySide6.QtWebEngineCore.QWebEngineFullScreenRequest(other)#
Parameters:

other – PySide6.QtWebEngineCore.QWebEngineFullScreenRequest

Note

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

property PᅟySide6.QtWebEngineCore.QWebEngineFullScreenRequest.origin: PySide6.QtCore.QUrl#

This property holds The URL to be opened in the fullscreen mode..

Access functions:
property PᅟySide6.QtWebEngineCore.QWebEngineFullScreenRequest.toggleOn: bool#

This property holds Whether the web page has issued a request to enter fullscreen mode..

Access functions:
PySide6.QtWebEngineCore.QWebEngineFullScreenRequest.accept()#

Accepts the request to enter or exit the fullscreen mode.

PySide6.QtWebEngineCore.QWebEngineFullScreenRequest.origin()#
Return type:

PySide6.QtCore.QUrl

Returns the URL to be opened in the fullscreen mode.

Getter of property origin .

PySide6.QtWebEngineCore.QWebEngineFullScreenRequest.reject()#

Rejects a request to enter or exit the fullscreen mode.

PySide6.QtWebEngineCore.QWebEngineFullScreenRequest.toggleOn()#
Return type:

bool

Returns true if the web page has issued a request to enter the fullscreen mode, otherwise returns false.

Getter of property toggleOn .