|  | Home · All Classes · Modules

# QWebHistory Class Reference
[QtWebKit module]

The QWebHistory class represents the history of a QWebPage More...

### Methods

- back (self)
- QWebHistoryItem backItem (self)
- QList<QWebHistoryItem> backItems (self, int maxItems)
- bool canGoBack (self)
- bool canGoForward (self)
- clear (self)
- int count (self)
- QWebHistoryItem currentItem (self)
- forward (self)
- QWebHistoryItem forwardItem (self)
- QList<QWebHistoryItem> forwardItems (self, int maxItems)
- goToItem (self, QWebHistoryItem item)
- QWebHistoryItem itemAt (self, int i)
- QList<QWebHistoryItem> items (self)

## Detailed Description

The QWebHistory class represents the history of a QWebPage

Each QWebPage instance contains a history of visited pages that can be accessed by QWebPage.history(). QWebHistory represents this history and makes it possible to navigate it.

The history uses the concept of a current item, dividing the pages visited into those that can be visited by navigating back and forward using the back() and forward() functions. The current item can be obtained by calling currentItem(), and an arbitrary item in the history can be made the current item by passing it to goToItem().

A list of items describing the pages that can be visited by going back can be obtained by calling the backItems() function; similarly, items describing the pages ahead of the current page can be obtained with the forwardItems() function. The total list of items is obtained with the items() function.

Just as with containers, functions are available to examine the history in terms of a list. Arbitrary items in the history can be obtained with itemAt(), the total number of items is given by count(), and the history can be cleared with the clear() function.

See also QWebHistoryItem, QWebHistoryInterface, and QWebPage.

## Method Documentation

### QWebHistory.back (self)

Set the current item to be the previous item in the history and goes to the corresponding page; i.e., goes back one history item.

See also forward() and goToItem().

### QWebHistoryItem QWebHistory.backItem (self)

Returns the item before the current item in the history.

### QList<QWebHistoryItem> QWebHistory.backItems (self, int maxItems)

Returns the list of items in the backwards history list. At most maxItems entries are returned.

See also forwardItems().

### bool QWebHistory.canGoBack (self)

Returns true if there is an item preceding the current item in the history; otherwise returns false.

See also canGoForward().

### bool QWebHistory.canGoForward (self)

Returns true if we have an item to go forward to; otherwise returns false.

See also canGoBack().

### QWebHistory.clear (self)

Clears the history.

See also count() and items().

### int QWebHistory.count (self)

Returns the total number of items in the history.

### QWebHistoryItem QWebHistory.currentItem (self)

Returns the current item in the history.

### QWebHistory.forward (self)

Sets the current item to be the next item in the history and goes to the corresponding page; i.e., goes forward one history item.

See also back() and goToItem().

### QWebHistoryItem QWebHistory.forwardItem (self)

Returns the item after the current item in the history.

### QList<QWebHistoryItem> QWebHistory.forwardItems (self, int maxItems)

Returns the list of items in the forward history list. At most maxItems entries are returned.

See also backItems().

### QWebHistory.goToItem (self, QWebHistoryItem item)

Sets the current item to be the specified item in the history and goes to the page.

See also back() and forward().

### QWebHistoryItem QWebHistory.itemAt (self, int i)

Returns the item at index i in the history.

### QList<QWebHistoryItem> QWebHistory.items (self)

Returns a list of all items currently in the history.

See also count() and clear().