QWebEngineHistory Class
The QWebEngineHistory class represents the history of a web engine page. More...
| Header: | #include <QWebEngineHistory> |
| CMake: | find_package(Qt6 COMPONENTS WebEngineCore REQUIRED) target_link_libraries(mytarget PRIVATE Qt6::WebEngineCore) |
| qmake: | QT += webenginecore |
| Since: | Qt 5.4 |
| Instantiated By: | WebEngineHistory |
| Inherits: | QObject |
Public Functions
| void | back() |
| QWebEngineHistoryItem | backItem() const |
| QList<QWebEngineHistoryItem> | backItems(int maxItems) const |
| QWebEngineHistoryModel * | backItemsModel() 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 |
| QWebEngineHistoryModel * | forwardItemsModel() const |
| void | goToItem(const QWebEngineHistoryItem &item) |
| QWebEngineHistoryItem | itemAt(int i) const |
| QList<QWebEngineHistoryItem> | items() const |
| QWebEngineHistoryModel * | itemsModel() const |
Related Non-Members
| QDataStream & | operator<<(QDataStream &stream, const QWebEngineHistory &history) |
| QDataStream & | operator>>(QDataStream &stream, QWebEngineHistory &history) |
Detailed Description
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.
Also, the following QWebEngineHistoryModel data model objects are provided:
backItemsModel(), which contains the URLs of visited pages.forwardItemsModel(), which contains the URLs of the pages that were visited after visiting the current page.itemsModel(), which contains the URLs of the back and forward items, as well as the URL of the current page.
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().
QWebEngineHistoryModel *QWebEngineHistory::backItemsModel() const
Return the data model, which represents URLs of visited pages.
Note: Getter function for property backItems.
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().
[invokable] void QWebEngineHistory::clear()
Clears the history.
Note: This function can be invoked via the meta-object system and from QML. See Q_INVOKABLE.
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().
QWebEngineHistoryModel *QWebEngineHistory::forwardItemsModel() const
Return the data model, which represents URLs of the pages that were visited after visiting the current page.
Note: Getter function for property forwardItems.
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.
QWebEngineHistoryModel *QWebEngineHistory::itemsModel() const
Returns the data model, which represents URLs of back items, forward items, and the current item in the history.
Note: Getter function for property items.
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.
© 2024 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.
