:right-sidebar: True

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

.. currentmodule:: gi.repository.WebKit





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


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





List of visited pages.

WebKitBackForwardList maintains a list of visited pages used to
navigate to recent pages. Items are inserted in the list in the
order they are visited.

WebKitBackForwardList also maintains the notion of the current item
(which is always at index 0), the preceding item (which is at index -1),
and the following item (which is at index 1).
Methods :func:`~gi.repository.WebKit.WebView.go_back` and :func:`~gi.repository.WebKit.WebView.go_forward` move
the current item backward or forward by one. Method
:func:`~gi.repository.WebKit.WebView.go_to_back_forward_list_item` sets the current item to the
specified item. All other methods returning :obj:`~gi.repository.WebKit.BackForwardListItem`\<!-- -->s
do not change the value of the current item, they just return the requested
item or items.




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 = None, items_removed: ~typing.Any = None) -> None

      The type of the None singleton.







      :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