:right-sidebar: True

WebPage
===================================================================

.. currentmodule:: gi.repository.WebKitWebProcessExtension





.. class:: WebPage(**properties: ~typing.Any)
   :no-contents-entry:


Superclasses: :class:`~gi.repository.GObject.Object`





A loaded web page.




Methods
-------

.. rst-class:: interim-class

.. class:: WebPage
   :no-index:


   .. method:: get_editor() -> ~gi.repository.WebKitWebProcessExtension.WebEditor

      Gets the :obj:`~gi.repository.WebKitWebProcessExtension.WebEditor` of a :obj:`~gi.repository.WebKitWebProcessExtension.WebPage`\.


      .. versionadded:: 2.10








   .. method:: get_form_manager(world: ~gi.repository.WebKitWebProcessExtension.ScriptWorld | None = None) -> ~gi.repository.WebKitWebProcessExtension.WebFormManager

      Get the :obj:`~gi.repository.WebKitWebProcessExtension.WebFormManager` of ``web_page`` in ``world``\.


      .. versionadded:: 2.40





      :param world: a :obj:`~gi.repository.WebKitWebProcessExtension.ScriptWorld`




   .. method:: get_id() -> int

      Get the identifier of the :obj:`~gi.repository.WebKitWebProcessExtension.WebPage`









   .. method:: get_main_frame() -> ~gi.repository.WebKitWebProcessExtension.Frame

      Returns the main frame of a :obj:`~gi.repository.WebKitWebProcessExtension.WebPage`\.


      .. versionadded:: 2.2








   .. method:: get_uri() -> str

      Returns the current active URI of ``web_page``\.

      You can monitor the active URI by connecting to the notify::uri
      signal of ``web_page``\.









   .. method:: send_message_to_view(message: ~gi.repository.WebKit.UserMessage, cancellable: ~gi.repository.Gio.Cancellable | None = None, callback: ~typing.Callable[[~gi.repository.GObject.Object | None, ~gi.repository.Gio.AsyncResult, ~typing.Any], None] | None = None, user_data: ~typing.Any = None) -> None

      Send ``message`` to the ``WebKitWebView`` corresponding to ``web_page``\. If ``message`` is floating, it's consumed.

      If you don't expect any reply, or you simply want to ignore it, you can pass :const:`None` as ``callback``\.
      When the operation is finished, ``callback`` will be called. You can then call
      :func:`~gi.repository.WebKitWebProcessExtension.WebPage.send_message_to_view_finish` to get the message reply.


      .. versionadded:: 2.28





      :param message: a :obj:`~gi.repository.WebKitWebProcessExtension.UserMessage`

      :param cancellable: a :obj:`~gi.repository.Gio.Cancellable` or :const:`None` to ignore

      :param callback: A :obj:`~gi.repository.Gio.AsyncReadyCallback` to call when the request is satisfied or :const:`None`

      :param user_data: the data to pass to callback function




   .. method:: send_message_to_view_finish(result: ~gi.repository.Gio.AsyncResult) -> ~gi.repository.WebKit.UserMessage

      Finish an asynchronous operation started with :func:`~gi.repository.WebKitWebProcessExtension.WebPage.send_message_to_view`.


      .. versionadded:: 2.28





      :param result: a :obj:`~gi.repository.Gio.AsyncResult`








Properties
----------

.. rst-class:: interim-class

.. class:: WebPage
   :no-index:
   

   .. attribute:: props.uri
      :type: str

      The type of the None singleton.











Signals
-------

.. rst-class:: interim-class

.. class:: WebPage.signals
   :no-index:
   

   .. method:: console_message_sent(console_message: ~gi.repository.WebKitWebProcessExtension.ConsoleMessage) -> None

      The type of the None singleton.



      .. versionadded:: 2.12





      :param console_message: the :obj:`~gi.repository.WebKitWebProcessExtension.ConsoleMessage`




   .. method:: context_menu(context_menu: ~gi.repository.WebKit.ContextMenu, hit_test_result: ~gi.repository.WebKitWebProcessExtension.WebHitTestResult) -> bool

      The type of the None singleton.



      .. versionadded:: 2.8





      :param context_menu: the proposed :obj:`~gi.repository.WebKitWebProcessExtension.ContextMenu`

      :param hit_test_result: a :obj:`~gi.repository.WebKitWebProcessExtension.WebHitTestResult`




   .. method:: document_loaded() -> None

      The type of the None singleton.










   .. method:: send_request(request: ~gi.repository.WebKit.URIRequest, redirected_response: ~gi.repository.WebKit.URIResponse) -> bool

      The type of the None singleton.







      :param request: a :obj:`~gi.repository.WebKitWebProcessExtension.URIRequest`

      :param redirected_response: a :obj:`~gi.repository.WebKitWebProcessExtension.URIResponse`\, or :const:`None`




   .. method:: user_message_received(message: ~gi.repository.WebKit.UserMessage) -> bool

      The type of the None singleton.



      .. versionadded:: 2.28





      :param message: the :obj:`~gi.repository.WebKitWebProcessExtension.UserMessage` received