:right-sidebar: True

BackForwardList
===================================================================

.. currentmodule:: gi.repository.WebKit





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


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





:Constructors:

::

    BackForwardList(**properties)





Methods
-------

.. rst-class:: interim-class

.. class:: BackForwardList
   :no-index:


   .. method:: get_back_item() -> ~gi.repository.WebKit.BackForwardListItem | None

      Returns the item that precedes the current item.










   .. method:: get_back_list() -> list[~gi.repository.WebKit.BackForwardListItem]

      Obtain the list of items preceding the current one.










   .. method:: get_back_list_with_limit(limit: int) -> list[~gi.repository.WebKit.BackForwardListItem]

      Obtain a list up to some number of items preceding the current one.







      :param limit: the number of items to retrieve





   .. method:: get_current_item() -> ~gi.repository.WebKit.BackForwardListItem | None

      Returns the current item in ``back_forward_list``.










   .. method:: get_forward_item() -> ~gi.repository.WebKit.BackForwardListItem | None

      Returns the item that follows the current item.










   .. method:: get_forward_list() -> list[~gi.repository.WebKit.BackForwardListItem]

      Obtain the list of items following the current one.










   .. method:: get_forward_list_with_limit(limit: int) -> list[~gi.repository.WebKit.BackForwardListItem]

      Obtain a list up to some number of items following the current one.







      :param limit: the number of items to retrieve





   .. method:: get_length() -> int

      Obtain the amount of items in the list.










   .. method:: get_nth_item(index: int) -> ~gi.repository.WebKit.BackForwardListItem | None

      Returns the item at a given index relative to the current item.







      :param index: the index of the item











Signals
-------

.. rst-class:: interim-class

.. class:: BackForwardList.signals
   :no-index:
   

   .. method:: changed(item_added: ~gi.repository.WebKit.BackForwardListItem | None, items_removed: None) -> None

      This signal is emitted when ``back_forward_list`` changes. This happens
      when the current item is updated, a new item is added or one or more
      items are removed. Note that both ``item_added`` and ``items_removed`` can
      :const:`None` when only the current item is updated. Items are only removed
      when the list is cleared or the maximum items limit is reached.







      :param item_added: the :obj:`~gi.repository.WebKit.BackForwardListItem` added or :const:`None`


      :param items_removed: a :obj:`~gi.repository.GLib.List` of :obj:`~gi.repository.WebKit.BackForwardListItem`<!-- -->s