WebHistory Class Reference

#import <WebHistory.h>

Inheritance diagram for WebHistory:

Public Types
typedef int64_t	DateKey
typedef HashMap< DateKey, Vector< COMPtr< IWebHistoryItem > > >	DateToEntriesMap
typedef HashMap< WTF::String, COMPtr< IWebHistoryItem > >	URLToEntriesMap

Instance Methods
(BOOL)	- loadFromURL:error:
(BOOL)	- saveToURL:error:
(void)	- addItems:
(void)	- removeItems:
(void)	- removeAllItems
(NSArray *)	- orderedItemsLastVisitedOnDay:
(WebHistoryItem *)	- itemForURL:
(virtual HRESULT STDMETHODCALLTYPE)	- QueryInterface
(virtual ULONG STDMETHODCALLTYPE)	- AddRef
(virtual ULONG STDMETHODCALLTYPE)	- Release
(virtual HRESULT STDMETHODCALLTYPE)	- optionalSharedHistory
(virtual HRESULT STDMETHODCALLTYPE)	- setOptionalSharedHistory
(HRESULT STDMETHODCALLTYPE)	- unused1
(HRESULT STDMETHODCALLTYPE)	- unused2
(virtual HRESULT STDMETHODCALLTYPE)	- addItems
(virtual HRESULT STDMETHODCALLTYPE)	- removeItems
(virtual HRESULT STDMETHODCALLTYPE)	- removeAllItems
(virtual HRESULT STDMETHODCALLTYPE)	- orderedLastVisitedDays
(virtual HRESULT STDMETHODCALLTYPE)	- orderedItemsLastVisitedOnDay
(virtual HRESULT STDMETHODCALLTYPE)	- itemForURL
(virtual HRESULT STDMETHODCALLTYPE)	- setHistoryItemLimit
(virtual HRESULT STDMETHODCALLTYPE)	- historyItemLimit
(virtual HRESULT STDMETHODCALLTYPE)	- setHistoryAgeInDaysLimit
(virtual HRESULT STDMETHODCALLTYPE)	- historyAgeInDaysLimit
(virtual HRESULT STDMETHODCALLTYPE)	- allItems
(virtual HRESULT STDMETHODCALLTYPE)	- setVisitedLinkTrackingEnabled
(virtual HRESULT STDMETHODCALLTYPE)	- removeAllVisitedLinks
(void)	- visitedURL
(void)	- addVisitedLinksToVisitedLinkStore
(COMPtr< IWebHistoryItem >)	- itemForURLString
Instance Methods inherited from IWebHistory
HRESULT	optionalSharedHistory ([out, retval] IWebHistory **history)
HRESULT	setOptionalSharedHistory ([in] IWebHistory *history)
HRESULT	addItems ([in] int itemCount, [in] IWebHistoryItem **items)
HRESULT	removeItems ([in] int itemCount, [in] IWebHistoryItem **items)
HRESULT	orderedLastVisitedDays ([in, out] int *count, [in] DATE *calendarDates)
HRESULT	orderedItemsLastVisitedOnDay ([in, out] int *count, [in] IWebHistoryItem **items, [in] DATE calendarDate)
HRESULT	itemForURL ([in] BSTR url, [out, retval] IWebHistoryItem **item)
HRESULT	historyItemLimit ([out, retval] int *limit)
HRESULT	historyAgeInDaysLimit ([out, retval] int *limit)
Instance Methods inherited from IWebHistoryPrivate
HRESULT	allItems ([in, out] int *count, [out, retval] IWebHistoryItem **items)

Class Methods
(WebHistory *)	+ optionalSharedHistory
(void)	+ setOptionalSharedHistory:
(static WebHistory *)	+ createInstance
(static WebHistory *)	+ sharedHistory

Protected Attributes
package WebHistoryPrivate *	_historyPrivate

Properties
NSArray *	orderedLastVisitedDays
int	historyItemLimit
int	historyAgeInDaysLimit

Detailed Description

WebHistory is used to track pages that have been loaded by WebKit.

Member Typedef Documentation

DateKey

- (typedef int64_t) DateKey

DateToEntriesMap

- (typedef HashMap<DateKey, Vector<COMPtr<IWebHistoryItem> > >) DateToEntriesMap

URLToEntriesMap

- (typedef String, COMPtr<IWebHistoryItem> >) WebHistory:

Method Documentation

addItems()

- (HRESULT) addItems		(int)	itemCount
		(__deref_in_ecount_opt(itemCount) IWebHistoryItem **)	items

addItems:()

- (void) addItems:

(NSArray *)

newItems

addItems:

Parameters

newItems

An array of WebHistoryItems to add to the WebHistory.

AddRef()

- (ULONG) AddRef

(void)

addVisitedLinksToVisitedLinkStore()

- (void) addVisitedLinksToVisitedLinkStore

(WebVisitedLinkStore &)

visitedLinkStore

allItems()

- (HRESULT) allItems		(_Inout_ int *)	count
		(__deref_opt_out IWebHistoryItem **)	items

createInstance()

+ (WebHistory *) createInstance

historyAgeInDaysLimit()

- (HRESULT) historyAgeInDaysLimit

(_Out_ int *)

limit

historyItemLimit()

- (HRESULT) historyItemLimit

(_Out_ int *)

limit

itemForURL()

- (HRESULT) itemForURL		(_In_ BSTR)	url
		(_COM_Outptr_opt_ IWebHistoryItem **)	item

itemForURL:()

- (WebHistoryItem *) itemForURL:

(NSURL *)

URL

itemForURL: Get an item for a specific URL

Parameters

URL	The URL of the history item to search for

Returns

Returns an item matching the URL

itemForURLString()

- (COMPtr< IWebHistoryItem >) itemForURLString

(const WTF::String &)

const

loadFromURL:error:()

- (BOOL) loadFromURL:		(NSURL *)	URL
error:		(NSError **)	error

loadFromURL:error:

Parameters

URL	The URL to use to initialize the WebHistory.
error	Set to nil or an NSError instance if an error occurred. The designated initializer for WebHistory.

Returns

Returns YES if successful, NO otherwise.

optionalSharedHistory() [1/2]

- (HRESULT) optionalSharedHistory

(_COM_Outptr_opt_ IWebHistory **)

history

optionalSharedHistory() [2/2]

+ (WebHistory *) optionalSharedHistory

optionalSharedHistory Returns a shared WebHistory instance initialized with the default history file.

Returns

A WebHistory object.

orderedItemsLastVisitedOnDay()

- (HRESULT) orderedItemsLastVisitedOnDay		(_Inout_ int *)	count
		(__deref_in_opt IWebHistoryItem **)	items
		(DATE)	calendarDate

orderedItemsLastVisitedOnDay:()

- (NSArray *) orderedItemsLastVisitedOnDay:

(NSCalendarDate *)

calendarDate

orderedItemsLastVisitedOnDay: Get an array of WebHistoryItem that were last visited on the day represented by the specified NSCalendarDate, ordered from most recent to oldest.

Parameters

calendarDate

A date identifying the unique day of interest.

Returns

Returns an array of WebHistoryItems last visited on the indicated day.

orderedLastVisitedDays()

- (HRESULT) orderedLastVisitedDays		(_Inout_ int *)	count
		(_In_ DATE *)	calendarDates

QueryInterface()

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

Release()

- (ULONG) Release

(void)

removeAllItems() [1/2]

- (HRESULT) removeAllItems

removeAllItems

Implements IWebHistory.

removeAllItems() [2/2]

- (virtual HRESULT STDMETHODCALLTYPE) removeAllItems

removeAllItems

• (void)removeAllItems;

Implements IWebHistory.

removeAllVisitedLinks()

- (HRESULT) removeAllVisitedLinks

Implements IWebHistoryPrivate.

removeItems()

- (HRESULT) removeItems		(int)	itemCount
		(__deref_in_ecount_opt(itemCount) IWebHistoryItem **)	items

removeItems:()

- (void) removeItems:

(NSArray *)

items

removeItems:

Parameters

items

An array of WebHistoryItems to remove from the WebHistory.

saveToURL:error:()

- (BOOL) saveToURL:		(NSURL *)	URL
error:		(NSError **)	error

saveToURL:error: Save history to URL. It is the client's responsibility to call this at appropriate times.

Parameters

URL	The URL to use to save the WebHistory.
error	Set to nil or an NSError instance if an error occurred.

Returns

Returns YES if successful, NO otherwise.

setHistoryAgeInDaysLimit()

- (HRESULT) setHistoryAgeInDaysLimit

(int)

limit

setHistoryAgeInDaysLimit: setHistoryAgeInDaysLimit: sets the maximum number of days to be read from stored history.

Parameters

limit

The maximum number of days to be read from stored history. (void)setHistoryAgeInDaysLimit:(int)limit;

Implements IWebHistory.

setHistoryItemLimit()

- (HRESULT) setHistoryItemLimit

(int)

limit

setHistoryItemLimit: Limits the number of items that will be stored by the WebHistory.

Parameters

limit

The maximum number of items that will be stored by the WebHistory. (void)setHistoryItemLimit:(int)limit;

Implements IWebHistory.

setOptionalSharedHistory()

- (HRESULT) setOptionalSharedHistory

(_In_opt_ IWebHistory *)

history

setOptionalSharedHistory:()

+ (void) setOptionalSharedHistory:

(WebHistory *)

history

setOptionalSharedHistory:

Parameters

history

The history to use for the global WebHistory.

setVisitedLinkTrackingEnabled()

- (HRESULT) setVisitedLinkTrackingEnabled

(BOOL)

visitedLinkTrackingEnabled

Implements IWebHistoryPrivate.

sharedHistory()

+ (WebHistory *) sharedHistory

unused1()

- (HRESULT) unused1

Implements IWebHistory.

unused2()

- (HRESULT) unused2

Implements IWebHistory.

visitedURL()

- (void) visitedURL		(const WebCore::URL &)
		(const WTF::String &)	title
		(const WTF::String &)	httpMethod
		(bool)	wasFailure
		(bool)	increaseVisitCount

Member Data Documentation

_historyPrivate

- (package WebHistoryPrivate*) _historyPrivate

protected

Property Documentation

historyAgeInDaysLimit

- (int) historyAgeInDaysLimit

readwritenonatomicassign

The maximum number of days to be read from stored history.

historyItemLimit

- (int) historyItemLimit

readwritenonatomicassign

The maximum number of items that will be stored by the WebHistory.

orderedLastVisitedDays

- (NSArray *) orderedLastVisitedDays

readnonatomiccopy

An array of NSCalendarDates for which history items exist in the WebHistory. An array of NSCalendarDates, each one representing a unique day that contains one or more history items, ordered from most recent to oldest.

---

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

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