:right-sidebar: True

Frame
===================================================================

.. currentmodule:: gi.repository.WebKitWebProcessExtension


.. versionadded:: 2.26




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


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





A web page frame.

Each ``WebKitWebPage`` has at least one main frame, and can have any number
of subframes.




Methods
-------

.. rst-class:: interim-class

.. class:: Frame
   :no-index:


   .. method:: get_id() -> int

      Gets the process-unique identifier of this :obj:`~gi.repository.WebKitWebProcessExtension.Frame`\. No other
      frame in the same web process will have the same ID; however, frames
      in other web processes may.


      .. versionadded:: 2.26








   .. method:: get_js_context() -> ~gi.repository.JavaScriptCore.Context

      Get the JavaScript execution context of ``frame``\. Use this function to bridge
      between the WebKit and JavaScriptCore APIs.


      .. versionadded:: 2.22








   .. method:: get_js_context_for_script_world(world: ~gi.repository.WebKitWebProcessExtension.ScriptWorld) -> ~gi.repository.JavaScriptCore.Context

      Get the JavaScript execution context of ``frame`` for the given :obj:`~gi.repository.WebKitWebProcessExtension.ScriptWorld`\.


      .. versionadded:: 2.22





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




   .. method:: get_uri() -> str

      Gets the current active URI of ``frame``\.


      .. versionadded:: 2.2








   .. method:: is_main_frame() -> bool

      Gets whether ``frame`` is the main frame of a :obj:`~gi.repository.WebKitWebProcessExtension.WebPage`


      .. versionadded:: 2.2