:right-sidebar: True

NavigationAction
===================================================================

.. currentmodule:: gi.repository.WebKit





.. class:: NavigationAction(*args, **kwargs)
   :no-contents-entry:






Provides details about interaction resulting in a resource load.




Methods
-------

.. rst-class:: interim-class

.. class:: NavigationAction
   :no-index:


   .. method:: free() -> None

      Free the :obj:`~gi.repository.WebKit.NavigationAction`


      .. versionadded:: 2.6








   .. method:: get_frame_name() -> str | None

      Gets the ``navigation`` target frame name. For example if navigation was triggered by clicking a
      link with a target attribute equal to "_blank", this will return the value of that attribute.
      In all other cases this function will return :const:`None`.


      .. versionadded:: 2.40








   .. method:: get_modifiers() -> int

      Return the modifier keys.

      Return a bitmask of :obj:`~gi.repository.Gdk.ModifierType` values describing the modifier keys that were in effect
      when the navigation was requested


      .. versionadded:: 2.6








   .. method:: get_mouse_button() -> int

      Return the number of the mouse button that triggered the navigation.

      Return the number of the mouse button that triggered the navigation, or 0 if
      the navigation was not started by a mouse event.


      .. versionadded:: 2.6








   .. method:: get_navigation_type() -> ~gi.repository.WebKit.NavigationType

      Return the type of action that triggered the navigation.


      .. versionadded:: 2.6








   .. method:: get_request() -> ~gi.repository.WebKit.URIRequest

      Return the :obj:`~gi.repository.WebKit.URIRequest` associated with the navigation action.

      Modifications to the returned object are <emphasis>not</emphasis> taken
      into account when the request is sent over the network, and is intended
      only to aid in evaluating whether a navigation action should be taken or
      not. To modify requests before they are sent over the network the
      ``WebKitPage``::send-request signal can be used instead.


      .. versionadded:: 2.6








   .. method:: is_redirect() -> bool

      Returns whether the ``navigation`` was redirected.


      .. versionadded:: 2.20








   .. method:: is_user_gesture() -> bool

      Return whether the navigation was triggered by a user gesture like a mouse click.


      .. versionadded:: 2.6