CopperSpice API  1.7.2
QWebHistory Class Reference

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

Public Methods

void back ()
 
QWebHistoryItem backItem () const
 
QList< QWebHistoryItembackItems (int maxItems) const
 
bool canGoBack () const
 
bool canGoForward () const
 
void clear ()
 
int count () const
 
QWebHistoryItem currentItem () const
 
int currentItemIndex () const
 
void forward ()
 
QWebHistoryItem forwardItem () const
 
QList< QWebHistoryItemforwardItems (int maxItems) const
 
void goToItem (const QWebHistoryItem &item)
 
QWebHistoryItem itemAt (int i) const
 
QList< QWebHistoryItemitems () const
 
int maximumItemCount () const
 
void setMaximumItemCount (int count)
 

Friends

QWEBKIT_EXPORT QDataStreamoperator<< (QDataStream &, const QWebHistory &)
 
QWEBKIT_EXPORT QDataStreamoperator>> (QDataStream &, QWebHistory &)
 
class QWebPage
 

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.

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

See also
QWebHistoryItem, QWebHistoryInterface, QWebPage

Method Documentation

void 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
forward(), goToItem()
QWebHistoryItem QWebHistory::backItem ( ) const

Returns the item before the current item in the history.

QList< QWebHistoryItem > QWebHistory::backItems ( int  maxItems) const

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

See also
forwardItems()
bool QWebHistory::canGoBack ( ) const

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

See also
canGoForward()
bool QWebHistory::canGoForward ( ) const

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

See also
canGoBack()
void QWebHistory::clear ( )

Clears the history.

See also
count(), items()
int QWebHistory::count ( ) const

Returns the total number of items in the history.

QWebHistoryItem QWebHistory::currentItem ( ) const

Returns the current item in the history.

int QWebHistory::currentItemIndex ( ) const

Returns the index of the current item in history.

void QWebHistory::forward ( )

Sets the current item to the next item in the history and loads the corresponding page.

See also
back(), goToItem()
QWebHistoryItem QWebHistory::forwardItem ( ) const

Returns the item after the current item in the history.

QList< QWebHistoryItem > QWebHistory::forwardItems ( int  maxItems) const

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

See also
backItems()
void QWebHistory::goToItem ( const QWebHistoryItem item)

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

See also
back(), forward()
QWebHistoryItem QWebHistory::itemAt ( int  i) const

Returns the item at index i in the history.

QList< QWebHistoryItem > QWebHistory::items ( ) const

Returns a list of all items currently in the history.

See also
count(), clear()
int QWebHistory::maximumItemCount ( ) const

Returns the maximum number of items in the history.

See also
setMaximumItemCount()
void QWebHistory::setMaximumItemCount ( int  count)

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

See also
maximumItemCount()

Friends And Related Function Documentation

QDataStream & operator<< ( QDataStream stream,
const QWebHistory &  history 
)
friend

This function streams a history into a data stream. It saves the history into the specified stream.

QDataStream & operator>> ( QDataStream stream,
QWebHistory &  history 
)
friend

This function loads a history from a data stream. Loads a QWebHistory from the specified stream into the given history.