WebKit2.BackForwardList¶

Subclasses:: None

Methods¶

Inherited:: GObject.Object (37)
Structs:: GObject.ObjectClass (5)

	`get_back_item` ()
	`get_back_list` ()
	`get_back_list_with_limit` (limit)
	`get_current_item` ()
	`get_forward_item` ()
	`get_forward_list` ()
	`get_forward_list_with_limit` (limit)
	`get_length` ()
	`get_nth_item` (index)

Virtual Methods¶

Inherited:: GObject.Object (7)

Properties¶

None

Signals¶

Inherited:: GObject.Object (1)

Name	Short Description
`changed`	This signal is emitted when back_forward_list changes.

Fields¶

Inherited:: GObject.Object (1)

Name	Type	Access	Description
parent	`GObject.Object`	r

Class Details¶

class WebKit2.BackForwardList(**kwargs)¶

Bases:: GObject.Object
Abstract:: No
Structure:: WebKit2.BackForwardListClass

List of visited pages.

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

WebKit2.BackForwardList 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 WebKit2.WebView.go_back() and WebKit2.WebView.go_forward() move the current item backward or forward by one. Method WebKit2.WebView.go_to_back_forward_list_item() sets the current item to the specified item. All other methods returning WebKit2.BackForwardListItem s do not change the value of the current item, they just return the requested item or items.

get_back_item()¶

Returns:: the WebKit2.BackForwardListItem preceding the current item or None.
Return type:: WebKit2.BackForwardListItem or None

Returns the item that precedes the current item.

get_back_list()¶

Returns:: a GLib.List of items preceding the current item.
Return type:: [WebKit2.BackForwardListItem]

Obtain the list of items preceding the current one.

get_back_list_with_limit(limit)¶

Parameters:: limit (int) – the number of items to retrieve
Returns:: a GLib.List of items preceding the current item limited by limit.
Return type:: [WebKit2.BackForwardListItem]

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

get_current_item()¶

Returns:: a WebKit2.BackForwardListItem or None if self is empty.
Return type:: WebKit2.BackForwardListItem or None

Returns the current item in self.

get_forward_item()¶

Returns:: the WebKit2.BackForwardListItem following the current item or None.
Return type:: WebKit2.BackForwardListItem or None

Returns the item that follows the current item.

get_forward_list()¶

Returns:: a GLib.List of items following the current item.
Return type:: [WebKit2.BackForwardListItem]

Obtain the list of items following the current one.

get_forward_list_with_limit(limit)¶

Parameters:: limit (int) – the number of items to retrieve
Returns:: a GLib.List of items following the current item limited by limit.
Return type:: [WebKit2.BackForwardListItem]

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

get_length()¶

Returns:: the length of self.
Return type:: int

Obtain the amount of items in the list.

get_nth_item(index)¶

Parameters:: index (int) – the index of the item
Returns:: the WebKit2.BackForwardListItem located at the specified index relative to the current item or None.
Return type:: WebKit2.BackForwardListItem or None

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

Signal Details¶

WebKit2.BackForwardList.signals.changed(back_forward_list, item_added, items_removed)¶

Signal Name:

changed

Flags:

RUN_LAST

Parameters:

back_forward_list (WebKit2.BackForwardList) – The object which received the signal
item_added (WebKit2.BackForwardListItem or None) – the WebKit2.BackForwardListItem added or None
items_removed (object or None) – a GLib.List of WebKit2.BackForwardListItem s

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 None when only the current item is updated. Items are only removed when the list is cleared or the maximum items limit is reached.