import"IWebBackForwardList.idl";
Inheritance diagram for IWebBackForwardList:
Public Member Functions | |
| HRESULT | addItem ([in] IWebHistoryItem *item) |
| HRESULT | goBack () |
| HRESULT | goForward () |
| 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 | setCapacity ([in] int size) |
| 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) |
Member Function Documentation
◆ addItem()
| HRESULT IWebBackForwardList::addItem | ( | [in] IWebHistoryItem * | item | ) |
addItem: Adds an entry to the list.
- Parameters
-
entry 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. - (void)addItem:(WebHistoryItem *)item;
◆ backItem()
| HRESULT IWebBackForwardList::backItem | ( | [out, retval] IWebHistoryItem ** | item | ) |
backItem Returns the entry right before the current entry.
- Returns
- The entry right before the current entry, or nil if there isn't one.
- (WebHistoryItem *)backItem;
◆ backListCount()
| HRESULT IWebBackForwardList::backListCount | ( | [out, retval] int * | count | ) |
backListCount Returns the back list's current count.
- Returns
- The number of items in the list.
- (int)backListCount;
◆ backListWithLimit()
| HRESULT IWebBackForwardList::backListWithLimit | ( | [in] int | limit, |
| [out] int * | listCount, | ||
| [in] IWebHistoryItem ** | list | ||
| ) |
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.
- (NSArray *)backListWithLimit:(int)limit;
◆ capacity()
| HRESULT IWebBackForwardList::capacity | ( | [out, retval] int * | result | ) |
capacity Returns the list's maximum size.
- Returns
- The list's maximum size.
- (int)capacity;
◆ containsItem()
| HRESULT IWebBackForwardList::containsItem | ( | [in] IWebHistoryItem * | item, |
| [out, retval] BOOL * | result | ||
| ) |
containsItem:
- Parameters
-
item The item that will be checked for presence in the WebBackForwardList.
- Returns
- Returns YES if the item is in the list.
- (BOOL)containsItem:(WebHistoryItem *)item;
◆ currentItem()
| HRESULT IWebBackForwardList::currentItem | ( | [out, retval] IWebHistoryItem ** | item | ) |
currentItem Returns the current entry.
- Returns
- The current entry.
- (WebHistoryItem *)currentItem;
◆ forwardItem()
| HRESULT IWebBackForwardList::forwardItem | ( | [out, retval] IWebHistoryItem ** | item | ) |
forwardItem Returns the entry right after the current entry.
- Returns
- The entry right after the current entry, or nil if there isn't one.
- (WebHistoryItem *)forwardItem;
◆ forwardListCount()
| HRESULT IWebBackForwardList::forwardListCount | ( | [out, retval] int * | sizecount | ) |
forwardListCount Returns the forward list's current count.
- Returns
- The number of items in the list.
- (int)forwardListCount;
◆ forwardListWithLimit()
| HRESULT IWebBackForwardList::forwardListWithLimit | ( | [in] int | limit, |
| [out] int * | listCount, | ||
| [in] IWebHistoryItem ** | list | ||
| ) |
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.
- (NSArray *)forwardListWithLimit:(int)limit;
◆ goBack()
| HRESULT IWebBackForwardList::goBack | ( | ) |
goBack Move the current pointer back to the entry before the current entry.
- (void)goBack;
Implemented in WebBackForwardList, and WebBackForwardList.
◆ goForward()
| HRESULT IWebBackForwardList::goForward | ( | ) |
goForward Move the current pointer ahead to the entry after the current entry.
- (void)goForward;
Implemented in WebBackForwardList, and WebBackForwardList.
◆ goToItem()
| HRESULT IWebBackForwardList::goToItem | ( | [in] IWebHistoryItem * | item | ) |
goToItem: Move the current pointer to the given entry.
- Parameters
-
item The history item to move the pointer to - (void)goToItem:(WebHistoryItem *)item;
◆ itemAtIndex()
| HRESULT IWebBackForwardList::itemAtIndex | ( | [in] int | index, |
| [out, retval] IWebHistoryItem ** | item | ||
| ) |
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.
- (WebHistoryItem *)itemAtIndex:(int)index;
◆ setCapacity()
| HRESULT IWebBackForwardList::setCapacity | ( | [in] int | size | ) |
setCacpacity Sets the list's maximum size.
- Parameters
-
size The new maximum size for the list. - (void)setCapacity:(int)size;
Implemented in WebBackForwardList.
The documentation for this interface was generated from the following file:
- Source/WebKit/win/Interfaces/IWebBackForwardList.idl
