WebBackForwardList Class Reference

#import <WebBackForwardList.h>

Inheritance diagram for WebBackForwardList:

Instance Methods
(void)	- addItem:
(void)	- goBack
(void)	- goForward
(void)	- goToItem:
(NSArray *)	- backListWithLimit:
(NSArray *)	- forwardListWithLimit:
(BOOL)	- containsItem:
(WebHistoryItem *)	- itemAtIndex:
(virtual HRESULT STDMETHODCALLTYPE)	- QueryInterface
(virtual ULONG STDMETHODCALLTYPE)	- AddRef
(virtual ULONG STDMETHODCALLTYPE)	- Release
(virtual HRESULT STDMETHODCALLTYPE)	- addItem
(virtual HRESULT STDMETHODCALLTYPE)	- goBack
(virtual HRESULT STDMETHODCALLTYPE)	- goForward
(virtual HRESULT STDMETHODCALLTYPE)	- goToItem
(virtual HRESULT STDMETHODCALLTYPE)	- backItem
(virtual HRESULT STDMETHODCALLTYPE)	- currentItem
(virtual HRESULT STDMETHODCALLTYPE)	- forwardItem
(virtual HRESULT STDMETHODCALLTYPE)	- backListWithLimit
(virtual HRESULT STDMETHODCALLTYPE)	- forwardListWithLimit
(virtual HRESULT STDMETHODCALLTYPE)	- capacity
(virtual HRESULT STDMETHODCALLTYPE)	- setCapacity
(virtual HRESULT STDMETHODCALLTYPE)	- backListCount
(virtual HRESULT STDMETHODCALLTYPE)	- forwardListCount
(virtual HRESULT STDMETHODCALLTYPE)	- containsItem
(virtual HRESULT STDMETHODCALLTYPE)	- itemAtIndex
(virtual HRESULT STDMETHODCALLTYPE)	- removeItem
(id)	- initWithBackForwardList: [implementation]
(void)	- setPageCacheSize:
(NSUInteger)	- pageCacheSize
(void)	- removeItem:
(void)	- _close
Instance Methods inherited from IWebBackForwardList
HRESULT	addItem ([in] IWebHistoryItem *item)
HRESULT	goToItem ([in] IWebHistoryItem *item)
HRESULT	backItem ([out, retval] IWebHistoryItem **item)
HRESULT	currentItem ([out, retval] IWebHistoryItem **item)
HRESULT	forwardItem ([out, retval] IWebHistoryItem **item)
HRESULT	backListWithLimit ([in] int limit, [out] int *listCount, [in] IWebHistoryItem **list)
HRESULT	forwardListWithLimit ([in] int limit, [out] int *listCount, [in] IWebHistoryItem **list)
HRESULT	capacity ([out, retval] int *result)
HRESULT	backListCount ([out, retval] int *count)
HRESULT	forwardListCount ([out, retval] int *sizecount)
HRESULT	containsItem ([in] IWebHistoryItem *item, [out, retval] BOOL *result)
HRESULT	itemAtIndex ([in] int index, [out, retval] IWebHistoryItem **item)

Class Methods
(static WebBackForwardList *)	+ createInstance

Protected Member Functions
()	- WebBackForwardList
()	- ~WebBackForwardList

Protected Attributes
package WebBackForwardListPrivate *	_private
ULONG	m_refCount { 0 }
RefPtr< BackForwardList >	m_backForwardList

Properties
WebHistoryItem *	backItem
WebHistoryItem *	currentItem
WebHistoryItem *	forwardItem
int	capacity
int	backListCount
int	forwardListCount

Detailed Description

WebBackForwardList holds an ordered list of WebHistoryItems that comprises the back and forward lists.

Note that the methods which modify instances of this class do not cause navigation to happen in other layers of the stack; they are only for maintaining this data structure.

Constructor & Destructor Documentation

WebBackForwardList()

- WebBackForwardList

(PassRefPtr< BackForwardList >)

backForwardList

~WebBackForwardList()

- ~WebBackForwardList

Method Documentation

_close()

- (void) _close

Provided by category WebBackForwardList(WebInternal).

addItem()

- (HRESULT) addItem

(_In_opt_ IWebHistoryItem *)

item

addItem:()

- (void) addItem:

(WebHistoryItem *)

item

addItem: Adds an entry to the list.

Parameters

item	The entry to add. The added entry is inserted immediately after the current entry. If the current position in the list is not at the end of the list, elements in the forward list will be dropped at this point. In addition, entries may be dropped to keep the size of the list within the maximum size.

AddRef()

- (ULONG) AddRef

(void)

backItem()

- (HRESULT) backItem

(_COM_Outptr_opt_ IWebHistoryItem **)

item

backListCount()

- (HRESULT) backListCount

(_Out_ int *)

count

backListWithLimit()

- (HRESULT) backListWithLimit		(int)	limit
		(_Out_ int *)	listCount
		(__deref_inout_opt IWebHistoryItem **)	list

backListWithLimit:()

- (NSArray *) backListWithLimit:

(int)

limit

backListWithLimit: Returns a portion of the list before the current entry.

Parameters

limit

A cap on the size of the array returned.

Returns

An array of items before the current entry, or nil if there are none. The entries are in the order that they were originally visited.

capacity()

- (HRESULT) capacity

(_Out_ int *)

result

containsItem()

- (HRESULT) containsItem		(_In_opt_ IWebHistoryItem *)	item
		(_Out_ BOOL *)	result

containsItem:()

- (BOOL) containsItem:

(WebHistoryItem *)

item

containsItem:

Parameters

item	The item that will be checked for presence in the WebBackForwardList.

Returns

Returns YES if the item is in the list.

createInstance()

+ (WebBackForwardList *) createInstance

(PassRefPtr< BackForwardList >)

backForwardList

currentItem()

- (HRESULT) currentItem

(_COM_Outptr_opt_ IWebHistoryItem **)

item

forwardItem()

- (HRESULT) forwardItem

(_COM_Outptr_opt_ IWebHistoryItem **)

item

forwardListCount()

- (HRESULT) forwardListCount

(_Out_ int *)

count

forwardListWithLimit()

- (HRESULT) forwardListWithLimit		(int)	limit
		(_Out_ int *)	listCount
		(__deref_inout_opt IWebHistoryItem **)	list

forwardListWithLimit:()

- (NSArray *) forwardListWithLimit:

(int)

limit

forwardListWithLimit: Returns a portion of the list after the current entry.

Parameters

limit

A cap on the size of the array returned.

Returns

An array of items after the current entry, or nil if there are none. The entries are in the order that they were originally visited.

goBack() [1/2]

- (HRESULT) goBack

goBack Move the current pointer back to the entry before the current entry.

Implements IWebBackForwardList.

goBack() [2/2]

- (virtual HRESULT STDMETHODCALLTYPE) goBack

goBack Move the current pointer back to the entry before the current entry.

• (void)goBack;

Implements IWebBackForwardList.

goForward() [1/2]

- (HRESULT) goForward

goForward Move the current pointer ahead to the entry after the current entry.

Implements IWebBackForwardList.

goForward() [2/2]

- (virtual HRESULT STDMETHODCALLTYPE) goForward

goForward Move the current pointer ahead to the entry after the current entry.

• (void)goForward;

Implements IWebBackForwardList.

goToItem()

- (HRESULT) goToItem

(_In_opt_ IWebHistoryItem *)

item

goToItem:()

- (void) goToItem:

(WebHistoryItem *)

item

goToItem: Move the current pointer to the given entry.

Parameters

item	The history item to move the pointer to

initWithBackForwardList:()

- (id) initWithBackForwardList: (Ref< BackForwardList > &&)  backForwardList

implementation

itemAtIndex()

- (HRESULT) itemAtIndex		(int)	index
		(_COM_Outptr_opt_ IWebHistoryItem **)	item

itemAtIndex:()

- (WebHistoryItem *) itemAtIndex:

(int)

index

itemAtIndex: Returns an entry the given distance from the current entry.

Parameters

index

Index of the desired list item relative to the current item; 0 is current item, -1 is back item, 1 is forward item, etc.

Returns

The entry the given distance from the current entry. If index exceeds the limits of the list, nil is returned.

pageCacheSize()

- (NSUInteger) pageCacheSize

pageCacheSize Returns the size of the shared page cache, or 0.

Returns

The size of the shared page cache (in pages), or 0 if the WebView associated with this WebBackForwardList will not use the shared page cache.

Provided by category WebBackForwardList(WebBackForwardListDeprecated).

QueryInterface()

- (HRESULT) QueryInterface		(_In_ REFIID)	riid
		(_COM_Outptr_ void **)	ppvObject

Release()

- (ULONG) Release

(void)

removeItem()

- (HRESULT) removeItem

(_In_opt_ IWebHistoryItem *)

item

removeItem:()

- (void) removeItem:

(WebHistoryItem *)

item

removeItem: Removes an entry from the list.

Parameters

entry

The entry to remove. Cannot be the current item.

Provided by category WebBackForwardList(WebBackForwardListPrivate).

setCapacity()

- (HRESULT) setCapacity

(int)

size

setCacpacity Sets the list's maximum size.

Parameters

size	The new maximum size for the list. (void)setCapacity:(int)size;

Implements IWebBackForwardList.

setPageCacheSize:()

- (void) setPageCacheSize:

(NSUInteger)

size

setPageCacheSize: The size passed to this method determines whether the WebView associated with this WebBackForwardList will use the shared page cache.

Parameters

size	If size is 0, the WebView associated with this WebBackForwardList will not use the shared page cache. Otherwise, it will.

Provided by category WebBackForwardList(WebBackForwardListDeprecated).

Member Data Documentation

_private

- (package WebBackForwardListPrivate*) _private

protected

m_backForwardList

- (RefPtr<BackForwardList>) m_backForwardList

protected

m_refCount

- (ULONG) m_refCount { 0 }

protected

Property Documentation

backItem

- (WebHistoryItem *) backItem

readnonatomicstrong

The entry right before the current entry, or nil if there isn't one.

backListCount

- (int) backListCount

readnonatomicassign

The number of items in the list.

capacity

- (int) capacity

readwritenonatomicassign

The list's maximum size.

currentItem

- (WebHistoryItem *) currentItem

readnonatomicstrong

Returns the current entry.

forwardItem

- (WebHistoryItem *) forwardItem

readnonatomicstrong

The entry right after the current entry, or nil if there isn't one.

forwardListCount

- (int) forwardListCount

readnonatomicassign

Returns

The number of items in the list.

---

The documentation for this class was generated from the following files:

• Source/WebKit/mac/History/WebBackForwardList.h
• Source/WebKit/mac/History/WebBackForwardList.mm
• Source/WebKit/win/WebBackForwardList.cpp