<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<!-- qwebhistory.cpp -->
<head>
<title>Qt 4.6: QWebHistory Class Reference</title>
<link href="classic.css" rel="stylesheet" type="text/css" />
</head>
<body>
<a name="//apple_ref/cpp/cl//QWebHistory"></a>
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td align="left" valign="top" width="32"><a href="http://qt.nokia.com/"><img src="images/qt-logo.png" align="left" border="0" /></a></td>
<td width="1"> </td><td class="postheader" valign="center"><a href="index.html"><font color="#004faf">Home</font></a> · <a href="classes.html"><font color="#004faf">All Classes</font></a> · <a href="functions.html"><font color="#004faf">All Functions</font></a> · <a href="overviews.html"><font color="#004faf">Overviews</font></a></td></tr></table><h1 class="title">QWebHistory Class Reference<br /><span class="small-subtitle">[<a href="qtwebkit.html">QtWebKit</a> module]</span>
</h1>
<p>The QWebHistory class represents the history of a <a href="qwebpage.html">QWebPage</a> <a href="#details">More...</a></p>
<pre> #include <QWebHistory></pre><p><b>This class is not part of the Qt GUI Framework Edition.</b></p>
<p>This class was introduced in Qt 4.4.</p>
<ul>
<li><a href="qwebhistory-members.html">List of all members, including inherited members</a></li>
</ul>
<hr />
<a name="public-functions"></a>
<h2>Public Functions</h2>
<table class="alignedsummary" border="0" cellpadding="0" cellspacing="0" width="100%">
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><b><a href="qwebhistory.html#back">back</a></b> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">QWebHistoryItem </td><td class="memItemRight" valign="bottom"><b><a href="qwebhistory.html#backItem">backItem</a></b> () const</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">QList<QWebHistoryItem> </td><td class="memItemRight" valign="bottom"><b><a href="qwebhistory.html#backItems">backItems</a></b> ( int <i>maxItems</i> ) const</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><b><a href="qwebhistory.html#canGoBack">canGoBack</a></b> () const</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><b><a href="qwebhistory.html#canGoForward">canGoForward</a></b> () const</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><b><a href="qwebhistory.html#clear">clear</a></b> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><b><a href="qwebhistory.html#count">count</a></b> () const</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">QWebHistoryItem </td><td class="memItemRight" valign="bottom"><b><a href="qwebhistory.html#currentItem">currentItem</a></b> () const</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><b><a href="qwebhistory.html#currentItemIndex">currentItemIndex</a></b> () const</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><b><a href="qwebhistory.html#forward">forward</a></b> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">QWebHistoryItem </td><td class="memItemRight" valign="bottom"><b><a href="qwebhistory.html#forwardItem">forwardItem</a></b> () const</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">QList<QWebHistoryItem> </td><td class="memItemRight" valign="bottom"><b><a href="qwebhistory.html#forwardItems">forwardItems</a></b> ( int <i>maxItems</i> ) const</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><b><a href="qwebhistory.html#goToItem">goToItem</a></b> ( const QWebHistoryItem & <i>item</i> )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">QWebHistoryItem </td><td class="memItemRight" valign="bottom"><b><a href="qwebhistory.html#itemAt">itemAt</a></b> ( int <i>i</i> ) const</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">QList<QWebHistoryItem> </td><td class="memItemRight" valign="bottom"><b><a href="qwebhistory.html#items">items</a></b> () const</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><b><a href="qwebhistory.html#maximumItemCount">maximumItemCount</a></b> () const</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><b><a href="qwebhistory.html#setMaximumItemCount">setMaximumItemCount</a></b> ( int <i>count</i> )</td></tr>
</table>
<hr />
<a name="related-non-members"></a>
<h2>Related Non-Members</h2>
<table class="alignedsummary" border="0" cellpadding="0" cellspacing="0" width="100%">
<tr><td class="memItemLeft" align="right" valign="top">QDataStream & </td><td class="memItemRight" valign="bottom"><b><a href="qwebhistory.html#operator-lt-lt-85">operator<<</a></b> ( QDataStream & <i>stream</i>, const QWebHistory & <i>history</i> )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">QDataStream & </td><td class="memItemRight" valign="bottom"><b><a href="qwebhistory.html#operator-gt-gt-51">operator>></a></b> ( QDataStream & <i>stream</i>, QWebHistory & <i>history</i> )</td></tr>
</table>
<a name="details"></a>
<hr />
<h2>Detailed Description</h2>
<p>The QWebHistory class represents the history of a <a href="qwebpage.html">QWebPage</a></p>
<p>Each <a href="qwebpage.html">QWebPage</a> instance contains a history of visited pages that can be accessed by <a href="qwebpage.html#history">QWebPage::history</a>(). QWebHistory represents this history and makes it possible to navigate it.</p>
<p>The history uses the concept of a <i>current item</i>, dividing the pages visited into those that can be visited by navigating <i>back</i> and <i>forward</i> using the <a href="qwebhistory.html#back">back</a>() and <a href="qwebhistory.html#forward">forward</a>() functions. The current item can be obtained by calling <a href="qwebhistory.html#currentItem">currentItem</a>(), and an arbitrary item in the history can be made the current item by passing it to <a href="qwebhistory.html#goToItem">goToItem</a>().</p>
<p>A list of items describing the pages that can be visited by going back can be obtained by calling the <a href="qwebhistory.html#backItems">backItems</a>() function; similarly, items describing the pages ahead of the current page can be obtained with the <a href="qwebhistory.html#forwardItems">forwardItems</a>() function. The total list of items is obtained with the <a href="qwebhistory.html#items">items</a>() function.</p>
<p>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 <a href="qwebhistory.html#itemAt">itemAt</a>(), the total number of items is given by <a href="qwebhistory.html#count">count</a>(), and the history can be cleared with the <a href="qwebhistory.html#clear">clear</a>() function.</p>
<p>QWebHistory's state can be saved to a <a href="qdatastream.html">QDataStream</a> using the >> operator and loaded by using the << operator.</p>
<p>See also <a href="qwebhistoryitem.html">QWebHistoryItem</a>, <a href="qwebhistoryinterface.html">QWebHistoryInterface</a>, and <a href="qwebpage.html">QWebPage</a>.</p>
<hr />
<h2>Member Function Documentation</h2>
<a name="//apple_ref/cpp/instm/QWebHistory/back"></a>
<h3 class="fn"><a name="back"></a>void QWebHistory::back ()</h3>
<p>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.</p>
<p>See also <a href="qwebhistory.html#forward">forward</a>() and <a href="qwebhistory.html#goToItem">goToItem</a>().</p>
<a name="//apple_ref/cpp/instm/QWebHistory/backItem"></a>
<h3 class="fn"><a name="backItem"></a><a href="qwebhistoryitem.html">QWebHistoryItem</a> QWebHistory::backItem () const</h3>
<p>Returns the item before the current item in the history.</p>
<a name="//apple_ref/cpp/instm/QWebHistory/backItems"></a>
<h3 class="fn"><a name="backItems"></a><a href="qlist.html">QList</a><<a href="qwebhistoryitem.html">QWebHistoryItem</a>> QWebHistory::backItems ( int <i>maxItems</i> ) const</h3>
<p>Returns the list of items in the backwards history list. At most <i>maxItems</i> entries are returned.</p>
<p>See also <a href="qwebhistory.html#forwardItems">forwardItems</a>().</p>
<a name="//apple_ref/cpp/instm/QWebHistory/canGoBack"></a>
<h3 class="fn"><a name="canGoBack"></a>bool QWebHistory::canGoBack () const</h3>
<p>Returns true if there is an item preceding the current item in the history; otherwise returns false.</p>
<p>See also <a href="qwebhistory.html#canGoForward">canGoForward</a>().</p>
<a name="//apple_ref/cpp/instm/QWebHistory/canGoForward"></a>
<h3 class="fn"><a name="canGoForward"></a>bool QWebHistory::canGoForward () const</h3>
<p>Returns true if we have an item to go forward to; otherwise returns false.</p>
<p>See also <a href="qwebhistory.html#canGoBack">canGoBack</a>().</p>
<a name="//apple_ref/cpp/instm/QWebHistory/clear"></a>
<h3 class="fn"><a name="clear"></a>void QWebHistory::clear ()</h3>
<p>Clears the history.</p>
<p>See also <a href="qwebhistory.html#count">count</a>() and <a href="qwebhistory.html#items">items</a>().</p>
<a name="//apple_ref/cpp/instm/QWebHistory/count"></a>
<h3 class="fn"><a name="count"></a>int QWebHistory::count () const</h3>
<p>Returns the total number of items in the history.</p>
<a name="//apple_ref/cpp/instm/QWebHistory/currentItem"></a>
<h3 class="fn"><a name="currentItem"></a><a href="qwebhistoryitem.html">QWebHistoryItem</a> QWebHistory::currentItem () const</h3>
<p>Returns the current item in the history.</p>
<a name="//apple_ref/cpp/instm/QWebHistory/currentItemIndex"></a>
<h3 class="fn"><a name="currentItemIndex"></a>int QWebHistory::currentItemIndex () const</h3>
<p>Returns the index of the current item in history.</p>
<p>This function was introduced in Qt 4.5.</p>
<a name="//apple_ref/cpp/instm/QWebHistory/forward"></a>
<h3 class="fn"><a name="forward"></a>void QWebHistory::forward ()</h3>
<p>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.</p>
<p>See also <a href="qwebhistory.html#back">back</a>() and <a href="qwebhistory.html#goToItem">goToItem</a>().</p>
<a name="//apple_ref/cpp/instm/QWebHistory/forwardItem"></a>
<h3 class="fn"><a name="forwardItem"></a><a href="qwebhistoryitem.html">QWebHistoryItem</a> QWebHistory::forwardItem () const</h3>
<p>Returns the item after the current item in the history.</p>
<a name="//apple_ref/cpp/instm/QWebHistory/forwardItems"></a>
<h3 class="fn"><a name="forwardItems"></a><a href="qlist.html">QList</a><<a href="qwebhistoryitem.html">QWebHistoryItem</a>> QWebHistory::forwardItems ( int <i>maxItems</i> ) const</h3>
<p>Returns the list of items in the forward history list. At most <i>maxItems</i> entries are returned.</p>
<p>See also <a href="qwebhistory.html#backItems">backItems</a>().</p>
<a name="//apple_ref/cpp/instm/QWebHistory/goToItem"></a>
<h3 class="fn"><a name="goToItem"></a>void QWebHistory::goToItem ( const <a href="qwebhistoryitem.html">QWebHistoryItem</a> & <i>item</i> )</h3>
<p>Sets the current item to be the specified <i>item</i> in the history and goes to the page.</p>
<p>See also <a href="qwebhistory.html#back">back</a>() and <a href="qwebhistory.html#forward">forward</a>().</p>
<a name="//apple_ref/cpp/instm/QWebHistory/itemAt"></a>
<h3 class="fn"><a name="itemAt"></a><a href="qwebhistoryitem.html">QWebHistoryItem</a> QWebHistory::itemAt ( int <i>i</i> ) const</h3>
<p>Returns the item at index <i>i</i> in the history.</p>
<a name="//apple_ref/cpp/instm/QWebHistory/items"></a>
<h3 class="fn"><a name="items"></a><a href="qlist.html">QList</a><<a href="qwebhistoryitem.html">QWebHistoryItem</a>> QWebHistory::items () const</h3>
<p>Returns a list of all items currently in the history.</p>
<p>See also <a href="qwebhistory.html#count">count</a>() and <a href="qwebhistory.html#clear">clear</a>().</p>
<a name="//apple_ref/cpp/instm/QWebHistory/maximumItemCount"></a>
<h3 class="fn"><a name="maximumItemCount"></a>int QWebHistory::maximumItemCount () const</h3>
<p>Returns the maximum number of items in the history.</p>
<p>This function was introduced in Qt 4.5.</p>
<p>See also <a href="qwebhistory.html#setMaximumItemCount">setMaximumItemCount</a>().</p>
<a name="//apple_ref/cpp/instm/QWebHistory/setMaximumItemCount"></a>
<h3 class="fn"><a name="setMaximumItemCount"></a>void QWebHistory::setMaximumItemCount ( int <i>count</i> )</h3>
<p>Sets the maximum number of items in the history to <i>count</i>.</p>
<p>This function was introduced in Qt 4.5.</p>
<p>See also <a href="qwebhistory.html#maximumItemCount">maximumItemCount</a>().</p>
<hr />
<h2>Related Non-Members</h2>
<h3 class="fn"><a name="operator-lt-lt-85"></a><a href="qdatastream.html">QDataStream</a> & operator<< ( <a href="qdatastream.html">QDataStream</a> & <i>stream</i>, const QWebHistory & <i>history</i> )</h3>
<p>The operator<< function streams a history into a data stream.</p>
<p>It saves the <i>history</i> into the specified <i>stream</i>.</p>
<p>This function was introduced in Qt 4.6.</p>
<h3 class="fn"><a name="operator-gt-gt-51"></a><a href="qdatastream.html">QDataStream</a> & operator>> ( <a href="qdatastream.html">QDataStream</a> & <i>stream</i>, QWebHistory & <i>history</i> )</h3>
<p>The operator>> function loads a history from a data stream.</p>
<p>Loads a <a href="qwebhistory.html">QWebHistory</a> from the specified <i>stream</i> into the given <i>history</i>.</p>
<p>This function was introduced in Qt 4.6.</p>
<p /><address><hr /><div align="center">
<table width="100%" cellspacing="0" border="0"><tr class="address">
<td width="40%" align="left">Copyright © 2010 Nokia Corporation and/or its subsidiary(-ies)</td>
<td width="20%" align="center"><a href="trademarks.html">Trademarks</a></td>
<td width="40%" align="right"><div align="right">Qt 4.6.3</div></td>
</tr></table></div></address></body>
</html>
distrib
>
Mandriva
>
current
>
i586
>
media
>
main-updates
>
by-pkgid
>
8e6051afcdb111a0317a58fb64c2abf5
>
files
>
5465
