Initial commit

2026-04-29 07:19:21 +03:00
commit 9a8cdfa08a
5964 changed files with 1194660 additions and 0 deletions
@@ -0,0 +1,75 @@
+// @snippet qwebenginepage-async-note
+.. note:: We guarantee that the ``resultCallback`` is always called, but it
+          might be done during page destruction. When ``QWebEnginePage``
+          is deleted, the callback is triggered with an invalid value and it
+          is not safe to use the corresponding ``QWebEnginePage``,
+          ``QWebEngineFrame``, or ``QWebEngineView`` instance inside it.
+// @snippet qwebenginepage-async-note
+
+// @snippet qwebenginepage-findtext
+Finds the specified string, ``subString``, in the page, using the given
+``options``. The ``findTextFinished()`` signal is emitted when a string search
+is completed.
+
+To clear the search highlight, just pass an empty string.
+
+The ``resultCallback`` must take a ``QWebEngineFindTextResult`` parameter.
+// @snippet qwebenginepage-findtext
+
+// @snippet qwebenginepage-tohtml
+Asynchronous method to retrieve the page's content as HTML, enclosed in HTML
+and BODY tags. Upon successful completion, ``resultCallback`` is called with
+the page's content.
+// @snippet qwebenginepage-tohtml
+
+// @snippet qwebenginepage-toplaintext
+Asynchronous method to retrieve the page's content converted to plain text,
+completely stripped of all HTML formatting.
+
+Upon successful completion, ``resultCallback`` is called with the page's content.
+// @snippet qwebenginepage-toplaintext
+
+// @snippet qwebenginepage-runjavascript
+Runs the JavaScript code contained in ``scriptSource`` script on this frame,
+without checking whether the DOM of the page has been constructed.
+
+To avoid conflicts with other scripts executed on the page, the world in which
+the script is run is specified by ``worldId``. The world ID values are the same
+as provided by ``QWebEngineScript.ScriptWorldId``, and between 0 and 256. If
+you leave out the world ID, the script is run in the ``MainWorld`` (0).
+
+When the script has been executed, the callable ``resultCallback`` is called
+with the result of the last executed statement.
+
+Only plain data can be returned from JavaScript as the result value.
+
+.. note:: Do not execute lengthy routines in the callback function, because
+          it might block the rendering of the web engine page.
+// @snippet qwebenginepage-runjavascript
+
+// @snippet qwebenginepage-printtopdf
+Renders the current content of the page into a PDF document and returns a byte
+array containing the PDF data as parameter to ``resultCallback``.
+
+The page size and orientation of the produced PDF document are taken from the
+values specified in ``layout``, while the range of pages printed is taken from
+``ranges`` with the default being printing all pages.
+
+.. note:: The ``QWebEnginePage.WebAction.Stop`` web action can be used to
+          interrupt this operation.
+// @snippet qwebenginepage-printtopdf
+
+// @snippet qwebenginepage-findframebyname
+Returns the frame with the given ``name``. If there are multiple frames with
+the same name, which one is returned is arbitrary. If no frame was found,
+returns ``None``.
+// @snippet qwebenginepage-findframebyname
+
+// @snippet qwebengineframe-printtopdf
+Renders the current content of the frame into a PDF document and returns a byte
+array containing the PDF data as parameter to ``resultCallback``. Printing uses
+a page size of A4, portrait layout, and includes the full range of pages.
+
+.. note:: The ``QWebEnginePage.WebAction.Stop`` web action can be used to
+          interrupt this operation.
+// @snippet qwebengineframe-printtopdf