QWebHistory

Synopsis

Functions

• def back ()
• def backItem ()
• def backItems (maxItems)
• def canGoBack ()
• def canGoForward ()
• def clear ()
• def count ()
• def currentItem ()
• def currentItemIndex ()
• def forward ()
• def forwardItem ()
• def forwardItems (maxItems)
• def goToItem (item)
• def itemAt (i)
• def items ()
• def maximumItemCount ()
• def setMaximumItemCount (count)

Detailed Description

The PySide.QtWebKit.QWebHistory class represents the history of a PySide.QtWebKit.QWebPage

Each PySide.QtWebKit.QWebPage instance contains a history of visited pages that can be accessed by QWebPage.history() . PySide.QtWebKit.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 PySide.QtWebKit.QWebHistory.back() and PySide.QtWebKit.QWebHistory.forward() functions. The current item can be obtained by calling PySide.QtWebKit.QWebHistory.currentItem() , and an arbitrary item in the history can be made the current item by passing it to PySide.QtWebKit.QWebHistory.goToItem() .

A list of items describing the pages that can be visited by going back can be obtained by calling the PySide.QtWebKit.QWebHistory.backItems() function; similarly, items describing the pages ahead of the current page can be obtained with the PySide.QtWebKit.QWebHistory.forwardItems() function. The total list of items is obtained with the PySide.QtWebKit.QWebHistory.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 PySide.QtWebKit.QWebHistory.itemAt() , the total number of items is given by PySide.QtWebKit.QWebHistory.count() , and the history can be cleared with the PySide.QtWebKit.QWebHistory.clear() function.

PySide.QtWebKit.QWebHistory ‘s state can be saved to a PySide.QtCore.QDataStream using the >> operator and loaded by using the << operator.

See also

PySide.QtWebKit.QWebHistoryItem PySide.QtWebKit.QWebHistoryInterface PySide.QtWebKit.QWebPage

PySide.QtWebKit.QWebHistory.back()

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

PySide.QtWebKit.QWebHistory.forward() PySide.QtWebKit.QWebHistory.goToItem()

PySide.QtWebKit.QWebHistory.backItem()

Return type:PySide.QtWebKit.QWebHistoryItem

Returns the item before the current item in the history.

PySide.QtWebKit.QWebHistory.backItems(maxItems)

Parameters:maxItems – PySide.QtCore.int Return type:

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

See also

PySide.QtWebKit.QWebHistory.forwardItems()

PySide.QtWebKit.QWebHistory.canGoBack()

Return type:PySide.QtCore.bool

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

See also

PySide.QtWebKit.QWebHistory.canGoForward()

PySide.QtWebKit.QWebHistory.canGoForward()

Return type:PySide.QtCore.bool

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

See also

PySide.QtWebKit.QWebHistory.canGoBack()

PySide.QtWebKit.QWebHistory.clear()

Clears the history.

See also

PySide.QtWebKit.QWebHistory.count() PySide.QtWebKit.QWebHistory.items()

PySide.QtWebKit.QWebHistory.count()

Return type:PySide.QtCore.int

Returns the total number of items in the history.

PySide.QtWebKit.QWebHistory.currentItem()

Return type:PySide.QtWebKit.QWebHistoryItem

Returns the current item in the history.

PySide.QtWebKit.QWebHistory.currentItemIndex()

Return type:PySide.QtCore.int

Returns the index of the current item in history.

PySide.QtWebKit.QWebHistory.forward()

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

PySide.QtWebKit.QWebHistory.back() PySide.QtWebKit.QWebHistory.goToItem()

PySide.QtWebKit.QWebHistory.forwardItem()

Return type:PySide.QtWebKit.QWebHistoryItem

Returns the item after the current item in the history.

PySide.QtWebKit.QWebHistory.forwardItems(maxItems)

Parameters:maxItems – PySide.QtCore.int Return type:

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

See also

PySide.QtWebKit.QWebHistory.backItems()

PySide.QtWebKit.QWebHistory.goToItem(item)

Parameters:item – PySide.QtWebKit.QWebHistoryItem

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

See also

PySide.QtWebKit.QWebHistory.back() PySide.QtWebKit.QWebHistory.forward()

PySide.QtWebKit.QWebHistory.itemAt(i)

Parameters:i – PySide.QtCore.int Return type:PySide.QtWebKit.QWebHistoryItem

Returns the item at index i in the history.

PySide.QtWebKit.QWebHistory.items()

Return type:

Returns a list of all items currently in the history.

See also

PySide.QtWebKit.QWebHistory.count() PySide.QtWebKit.QWebHistory.clear()

PySide.QtWebKit.QWebHistory.maximumItemCount()

Return type:PySide.QtCore.int

Returns the maximum number of items in the history.

See also

PySide.QtWebKit.QWebHistory.setMaximumItemCount()

PySide.QtWebKit.QWebHistory.setMaximumItemCount(count)

Parameters:count – PySide.QtCore.int

Sets the maximum number of items in the history to count .

See also

PySide.QtWebKit.QWebHistory.maximumItemCount()