QWebEngineHistory Class | Qt WebEngine 5.10

Qt 5.10 | Qt WebEngine | C++ Classes | QWebEngineHistory

Qt 5.10.1 Reference Documentation

# QWebEngineHistory Class

The QWebEngineHistory class represents the history of a web engine page. More...

Header: | #include <QWebEngineHistory>
qmake: | QT += webenginewidgets
Since: | Qt 5.4

- List of all members, including inherited members

## Public Functions

void | back()
QWebEngineHistoryItem | backItem() const
QList<QWebEngineHistoryItem> | backItems(int maxItems) const
bool | canGoBack() const
bool | canGoForward() const
void | clear()
int | count() const
QWebEngineHistoryItem | currentItem() const
int | currentItemIndex() const
void | forward()
QWebEngineHistoryItem | forwardItem() const
QList<QWebEngineHistoryItem> | forwardItems(int maxItems) const
void | goToItem(const QWebEngineHistoryItem &item)
QWebEngineHistoryItem | itemAt(int i) const
QList<QWebEngineHistoryItem> | items() const

## Related Non-Members

QDataStream & | operator<<(QDataStream &stream, const QWebEngineHistory &history)
QDataStream & | operator>>(QDataStream &stream, QWebEngineHistory &history)

## Detailed Description

The QWebEngineHistory class represents the history of a web engine page.

Each web engine page contains a history of visited pages that can be accessed by QWebEnginePage::history().

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.

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

See also QWebEngineHistoryItem and QWebEnginePage.

## Member Function Documentation

### void QWebEngineHistory::back()

Sets the current item to be the previous item in the history and goes to the corresponding page; that is, goes back one history item.

See also forward() and goToItem().

### QWebEngineHistoryItem QWebEngineHistory::backItem() const

Returns the item before the current item in the history.

### QList<QWebEngineHistoryItem> QWebEngineHistory::backItems(int maxItems) const

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

See also forwardItems().

### bool QWebEngineHistory::canGoBack() const

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

See also canGoForward().

### bool QWebEngineHistory::canGoForward() const

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

See also canGoBack().

### void QWebEngineHistory::clear()

Clears the history.

See also count() and items().

### int QWebEngineHistory::count() const

Returns the total number of items in the history.

### QWebEngineHistoryItem QWebEngineHistory::currentItem() const

Returns the current item in the history.

### int QWebEngineHistory::currentItemIndex() const

Returns the index of the current item in history.

### void QWebEngineHistory::forward()

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

See also back() and goToItem().

### QWebEngineHistoryItem QWebEngineHistory::forwardItem() const

Returns the item after the current item in the history.

### QList<QWebEngineHistoryItem> QWebEngineHistory::forwardItems(int maxItems) const

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

See also backItems().

### void QWebEngineHistory::goToItem(const QWebEngineHistoryItem &item)

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

See also back() and forward().

### QWebEngineHistoryItem QWebEngineHistory::itemAt(int i) const

Returns the item at index i in the history.

### QList<QWebEngineHistoryItem> QWebEngineHistory::items() const

Returns a list of all items currently in the history.

See also count() and clear().

## Related Non-Members

### QDataStream &operator<<(QDataStream &stream, const QWebEngineHistory &history)

Saves the web engine history history into stream.

### QDataStream &operator>>(QDataStream &stream, QWebEngineHistory &history)

Loads the web engine history from stream into history.