Qyoto  4.0.6
Qyoto is a C# language binding for Qt
 All Classes Namespaces Functions Variables Typedefs Enumerations Properties
QtWebKit.QWebHistory Class Reference

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

Inheritance diagram for QtWebKit.QWebHistory:
Collaboration diagram for QtWebKit.QWebHistory:

Public Member Functions

virtual void CreateProxy ()
 
new void Back ()
 
 
new
System.Collections.Generic.List
< QWebHistoryItem
BackItems (int maxItems)
 
 
new void Clear ()
 
 
new void Forward ()
 
 
new
System.Collections.Generic.List
< QWebHistoryItem
ForwardItems (int maxItems)
 
 
new void GoToItem (QWebHistoryItem item)
 
 
new QWebHistoryItem ItemAt (int i)
 
 

Protected Member Functions

 QWebHistory (System.Type dummy)
 

Protected Attributes

SmokeInvocation interceptor
 

Properties

int MaximumItemCount [get, set]
 
 
QWebHistoryItem BackItem [get]
 
 
bool CanGoBack [get]
 
 
bool CanGoForward [get]
 
 
int Count [get]
 
 
QWebHistoryItem CurrentItem [get]
 
 
int CurrentItemIndex [get]
 
 
QWebHistoryItem ForwardItem [get]
 
 
System.Collections.Generic.List
< QWebHistoryItem
Items [get]
 
 
virtual System.IntPtr SmokeObject [get, set]
 

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, and QWebPage.

Constructor & Destructor Documentation

QtWebKit.QWebHistory.QWebHistory ( System.Type  dummy)
protected

Member Function Documentation

new void QtWebKit.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() and goToItem().

new System.Collections.Generic.List<QWebHistoryItem> QtWebKit.QWebHistory.BackItems ( int  maxItems)

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

See also forwardItems().

new void QtWebKit.QWebHistory.Clear ( )

Clears the history.

See also count() and items().

virtual void QtWebKit.QWebHistory.CreateProxy ( )
virtual
new void QtWebKit.QWebHistory.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.

See also back() and goToItem().

new System.Collections.Generic.List<QWebHistoryItem> QtWebKit.QWebHistory.ForwardItems ( int  maxItems)

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

See also backItems().

new void QtWebKit.QWebHistory.GoToItem ( QWebHistoryItem  item)

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

See also back() and forward().

new QWebHistoryItem QtWebKit.QWebHistory.ItemAt ( int  i)

Returns the item at index i in the history.

Member Data Documentation

SmokeInvocation QtWebKit.QWebHistory.interceptor
protected

Property Documentation

QWebHistoryItem QtWebKit.QWebHistory.BackItem
get

Returns the item before the current item in the history.

bool QtWebKit.QWebHistory.CanGoBack
get

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

See also canGoForward().

bool QtWebKit.QWebHistory.CanGoForward
get

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

See also canGoBack().

int QtWebKit.QWebHistory.Count
get

Returns the total number of items in the history.

QWebHistoryItem QtWebKit.QWebHistory.CurrentItem
get

Returns the current item in the history.

int QtWebKit.QWebHistory.CurrentItemIndex
get

Returns the index of the current item in history.

This function was introduced in Qt 4.5.

QWebHistoryItem QtWebKit.QWebHistory.ForwardItem
get

Returns the item after the current item in the history.

System.Collections.Generic.List<QWebHistoryItem> QtWebKit.QWebHistory.Items
get

Returns a list of all items currently in the history.

See also count() and clear().

int QtWebKit.QWebHistory.MaximumItemCount
getset

Returns the maximum number of items in the history.

This function was introduced in Qt 4.5.

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

This function was introduced in Qt 4.5.

virtual System.IntPtr QtWebKit.QWebHistory.SmokeObject
getset