QWebHistory Class Reference

#include <mw/QtWebKit/qwebhistory.h>

class QWebHistory

The QWebHistory class represents the history of a QWebPage.

Public Member Functions
void	back()
QWebHistoryItem	backItem()
QList< QWebHistoryItem >	backItems(int)
bool	canGoBack()
bool	canGoForward()
void	clear()
int	count()
QWebHistoryItem	currentItem()
int	currentItemIndex()
void	forward()
QWebHistoryItem	forwardItem()
QList< QWebHistoryItem >	forwardItems(int)
void	goToItem(const QWebHistoryItem &)
QWebHistoryItem	itemAt(int)
QList< QWebHistoryItem >	items()
int	maximumItemCount()
void	setMaximumItemCount(int)

Detailed Description

Since: 4.4 QtWebKit

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.

QWebHistory's state can be saved to a QDataStream using the >> operator and loaded by using the << operator.

Member Function Documentation

back ( )

void

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.

backItem ( )

QWebHistoryItem

backItem

(

)

const

Returns the item before the current item in the history.

backItems ( int )

QList< QWebHistoryItem >

backItems

(

int

maxItems

)

const

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

canGoBack ( )

bool

canGoBack

(

)

const

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

canGoForward ( )

bool

canGoForward

(

)

const

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

clear ( )

void

clear

(

)

Clears the history.

count ( )

int

count

(

)

const

Returns the total number of items in the history.

currentItem ( )

QWebHistoryItem

currentItem

(

)

const

Returns the current item in the history.

currentItemIndex ( )

int

currentItemIndex

(

)

const

Since: 4.5 Returns the index of the current item in history.

forward ( )

void

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.

forwardItem ( )

QWebHistoryItem

forwardItem

(

)

const

Returns the item after the current item in the history.

forwardItems ( int )

QList< QWebHistoryItem >

forwardItems

(

int

maxItems

)

const

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

goToItem ( const QWebHistoryItem & )

void

goToItem

(

const QWebHistoryItem &

item

)

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

itemAt ( int )

QWebHistoryItem

itemAt

(

int

)

const

Returns the item at index i in the history.

items ( )

QList< QWebHistoryItem >

items

(

)

const

Returns a list of all items currently in the history.

maximumItemCount ( )

int

maximumItemCount

(

)

const

Since: 4.5 Returns the maximum number of items in the history.

setMaximumItemCount ( int )

void

setMaximumItemCount

(

int

count

)

Since: 4.5 Sets the maximum number of items in the history to count.