WebHistoryItem Class Reference

#import <WebHistoryItem.h>

Inheritance diagram for WebHistoryItem:

Instance Methods
(instancetype)	- initWithURLString:title:lastVisitedTimeInterval:
(virtual HRESULT STDMETHODCALLTYPE)	- QueryInterface
(virtual ULONG STDMETHODCALLTYPE)	- AddRef
(virtual ULONG STDMETHODCALLTYPE)	- Release
(virtual HRESULT STDMETHODCALLTYPE)	- initWithURLString
(virtual HRESULT STDMETHODCALLTYPE)	- originalURLString
(virtual HRESULT STDMETHODCALLTYPE)	- URLString
(virtual HRESULT STDMETHODCALLTYPE)	- title
(virtual HRESULT STDMETHODCALLTYPE)	- lastVisitedTimeInterval
(virtual HRESULT STDMETHODCALLTYPE)	- setAlternateTitle
(virtual HRESULT STDMETHODCALLTYPE)	- alternateTitle
(virtual HRESULT STDMETHODCALLTYPE)	- icon
(virtual HRESULT STDMETHODCALLTYPE)	- initFromDictionaryRepresentation
(virtual HRESULT STDMETHODCALLTYPE)	- dictionaryRepresentation
(virtual HRESULT STDMETHODCALLTYPE)	- visitCount
(virtual HRESULT STDMETHODCALLTYPE)	- setVisitCount
(virtual HRESULT STDMETHODCALLTYPE)	- hasURLString
(virtual HRESULT STDMETHODCALLTYPE)	- mergeAutoCompleteHints
(virtual HRESULT STDMETHODCALLTYPE)	- setLastVisitedTimeInterval
(virtual HRESULT STDMETHODCALLTYPE)	- setTitle
(virtual HRESULT STDMETHODCALLTYPE)	- RSSFeedReferrer
(virtual HRESULT STDMETHODCALLTYPE)	- setRSSFeedReferrer
(virtual HRESULT STDMETHODCALLTYPE)	- hasPageCache
(virtual HRESULT STDMETHODCALLTYPE)	- setHasPageCache
(virtual HRESULT STDMETHODCALLTYPE)	- target
(virtual HRESULT STDMETHODCALLTYPE)	- isTargetItem
(virtual HRESULT STDMETHODCALLTYPE)	- children
(virtual HRESULT STDMETHODCALLTYPE)	- lastVisitWasFailure
(virtual HRESULT STDMETHODCALLTYPE)	- setLastVisitWasFailure
(virtual HRESULT STDMETHODCALLTYPE)	- lastVisitWasHTTPNonGet
(virtual HRESULT STDMETHODCALLTYPE)	- setLastVisitWasHTTPNonGet
(virtual HRESULT STDMETHODCALLTYPE)	- redirectURLs
(virtual HRESULT STDMETHODCALLTYPE)	- visitedWithTitle
(virtual HRESULT STDMETHODCALLTYPE)	- getDailyVisitCounts
(virtual HRESULT STDMETHODCALLTYPE)	- getWeeklyVisitCounts
(virtual HRESULT STDMETHODCALLTYPE)	- recordInitialVisit
(WebCore::HistoryItem *)	- historyItem
(id)	- initWithURLString:title:displayTitle:lastVisitedTimeInterval: [implementation]
(id)	- initFromDictionaryRepresentation: [implementation]
(id)	- initWithWebCoreHistoryItem: [implementation]
(void)	- setTitle: [implementation]
(void)	- _visitedWithTitle: [implementation]
Instance Methods inherited from IWebHistoryItem
HRESULT	initWithURLString ([in] BSTR urlString, [in] BSTR title, [in] DATE lastVisited)
HRESULT	originalURLString ([out, retval] BSTR *url)
HRESULT	URLString ([out, retval] BSTR *url)
HRESULT	title ([out, retval] BSTR *pageTitle)
HRESULT	lastVisitedTimeInterval ([out, retval] DATE *lastVisited)
HRESULT	setAlternateTitle ([in] BSTR title)
HRESULT	alternateTitle ([out, retval] BSTR *title)
HRESULT	icon ([out, retval] HBITMAP *hBitmap)

Class Methods
(static WebHistoryItem *)	+ createInstance
(static WebHistoryItem *)	+ createInstance
(WebHistoryItem *)	+ entryWithURL: [implementation]

Protected Member Functions
()	- WebHistoryItem
()	- ~WebHistoryItem

Protected Attributes
package WebHistoryItemPrivate *	_private
ULONG	m_refCount { 0 }
RefPtr< WebCore::HistoryItem >	m_historyItem
WTF::String	m_alternateTitle

Properties
NSString *	originalURLString
NSString *	URLString
NSString *	title
NSTimeInterval	lastVisitedTimeInterval
NSString *	alternateTitle
NSImage *	icon

Detailed Description

WebHistoryItems are created by WebKit to represent pages visited. The WebBackForwardList and WebHistory classes both use WebHistoryItems to represent pages visited. With the exception of the displayTitle, the properties of WebHistoryItems are set by WebKit. WebHistoryItems are normally never created directly.

Constructor & Destructor Documentation

WebHistoryItem()

- WebHistoryItem

(PassRefPtr< WebCore::HistoryItem >)

historyItem

~WebHistoryItem()

- ~WebHistoryItem

Method Documentation

_visitedWithTitle:()

- (void) _visitedWithTitle: (NSString *)  title

implementation

AddRef()

- (ULONG) AddRef

(void)

alternateTitle()

- (HRESULT) alternateTitle

(__deref_opt_out BSTR *)

title

children()

- (HRESULT) children		(unsigned *)	childCount
		(SAFEARRAY **)	children

Implements IWebHistoryItemPrivate.

createInstance() [1/2]

+ (WebHistoryItem *) createInstance

createInstance() [2/2]

+ (WebHistoryItem *) createInstance

(PassRefPtr< WebCore::HistoryItem >)

historyItem

dictionaryRepresentation()

- (HRESULT) dictionaryRepresentation

(__deref_out_opt void **)

dictionary

entryWithURL:()

+ (WebHistoryItem *) entryWithURL: (NSURL *)  URL

implementation

getDailyVisitCounts()

- (HRESULT) getDailyVisitCounts		(_Out_ int *)	number
		(__deref_out_opt int **)	counts

getWeeklyVisitCounts()

- (HRESULT) getWeeklyVisitCounts		(_Out_ int *)	number
		(__deref_out_opt int **)	counts

hasPageCache()

- (HRESULT) hasPageCache

(_Out_ BOOL *)

hasCache

hasURLString()

- (HRESULT) hasURLString

(_Out_ BOOL *)

hasURL

historyItem()

- (HistoryItem *) historyItem

const

icon()

- (HRESULT) icon

(__deref_opt_out HBITMAP *)

hBitmap

initFromDictionaryRepresentation()

- (HRESULT) initFromDictionaryRepresentation

(_In_opt_ void *)

dictionary

initFromDictionaryRepresentation:()

- (id) initFromDictionaryRepresentation: (NSDictionary *)  dict

implementation

initWithURLString()

- (HRESULT) initWithURLString		(_In_ BSTR)	urlString
		(_In_ BSTR)	title
		(DATE)	lastVisited

initWithURLString:title:displayTitle:lastVisitedTimeInterval:()

- (id) initWithURLString: (NSString *)  URLString title: (NSString *)  title displayTitle: (NSString *)  displayTitle lastVisitedTimeInterval: (NSTimeInterval)  time

implementation

initWithURLString:title:lastVisitedTimeInterval:()

- (instancetype) initWithURLString:		(NSString *)	URLString
title:		(NSString *)	title
lastVisitedTimeInterval:		(NSTimeInterval)	time

initWithURLString:title:lastVisitedTimeInterval:

Parameters

URLString	The URL string for the item.
title	The title to use for the item. This is normally the <title> of a page.
time	The time used to indicate when the item was used. Initialize a new WebHistoryItem WebHistoryItems are normally created for you by the WebKit. You may use this method to prepopulate a WebBackForwardList, or create 'artificial' items to add to a WebBackForwardList. When first initialized the URLString and originalURLString will be the same.

initWithWebCoreHistoryItem:()

- (id) initWithWebCoreHistoryItem: (PassRefPtr< WebCore::HistoryItem >)  item

implementation

isTargetItem()

- (HRESULT) isTargetItem

(_Out_ BOOL *)

result

lastVisitedTimeInterval()

- (HRESULT) lastVisitedTimeInterval

(_Out_ DATE *)

lastVisited

lastVisitWasFailure()

- (HRESULT) lastVisitWasFailure

(_Out_ BOOL *)

wasFailure

lastVisitWasHTTPNonGet()

- (HRESULT) lastVisitWasHTTPNonGet

(_Out_ BOOL *)

HTTPNonGet

mergeAutoCompleteHints()

- (HRESULT) mergeAutoCompleteHints

(_In_opt_ IWebHistoryItem *)

originalURLString()

- (HRESULT) originalURLString

(__deref_opt_out BSTR *)

url

QueryInterface()

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

recordInitialVisit()

- (HRESULT) recordInitialVisit

Implements IWebHistoryItemPrivate.

redirectURLs()

- (HRESULT) redirectURLs

(_COM_Outptr_opt_ IEnumVARIANT **)

urls

Release()

- (ULONG) Release

(void)

RSSFeedReferrer()

- (HRESULT) RSSFeedReferrer

(__deref_out_opt BSTR *)

url

setAlternateTitle()

- (HRESULT) setAlternateTitle

(_In_ BSTR)

title

setHasPageCache()

- (HRESULT) setHasPageCache

(BOOL)

Implements IWebHistoryItemPrivate.

setLastVisitedTimeInterval()

- (HRESULT) setLastVisitedTimeInterval

(DATE)

time

Implements IWebHistoryItemPrivate.

setLastVisitWasFailure()

- (HRESULT) setLastVisitWasFailure

(BOOL)

wasFailure

Implements IWebHistoryItemPrivate.

setLastVisitWasHTTPNonGet()

- (HRESULT) setLastVisitWasHTTPNonGet

(BOOL)

Implements IWebHistoryItemPrivate.

setRSSFeedReferrer()

- (HRESULT) setRSSFeedReferrer

(_In_ BSTR)

url

setTitle()

- (HRESULT) setTitle

(_In_ BSTR)

title

setTitle:()

- (void) setTitle: (NSString *)  title

implementation

setVisitCount()

- (HRESULT) setVisitCount

(int)

count

Implements IWebHistoryItemPrivate.

target()

- (HRESULT) target

(__deref_out_opt BSTR *)

target

title()

- (HRESULT) title

(__deref_opt_out BSTR *)

pageTitle

URLString()

- (HRESULT) URLString

(__deref_opt_out BSTR *)

url

visitCount()

- (HRESULT) visitCount

(_Out_ int *)

count

visitedWithTitle()

- (HRESULT) visitedWithTitle		(_In_ BSTR)	title
		(BOOL)	increaseVisitCount

Member Data Documentation

_private

- (package WebHistoryItemPrivate*) _private

protected

m_alternateTitle

- (String) WebHistoryItem:

protected

m_historyItem

- (HistoryItem>) WebHistoryItem:

protected

m_refCount

- (ULONG) m_refCount { 0 }

protected

Property Documentation

alternateTitle

- (NSString *) alternateTitle

readwritenonatomiccopy

icon

- (NSImage *) icon

readnonatomicstrong

The favorite icon of the page represented by this item. This icon returned will be determined by the WebKit.

lastVisitedTimeInterval

- (NSTimeInterval) lastVisitedTimeInterval

readnonatomicassign

The last time the page represented by this item was visited. The interval is since the reference date as determined by NSDate. This value is normally set by the WebKit.

originalURLString

- (NSString *) originalURLString

readnonatomiccopy

The string representation of the initial URL of this item. This value is normally set by the WebKit.

title

- (NSString *) title

readnonatomiccopy

The title of the page represented by this item. This title cannot be changed by the client. This value is normally set by the WebKit when a page title for the item is received.

URLString

- (NSString *) URLString

readnonatomiccopy

The string representation of the URL represented by this item. The URLString may be different than the originalURLString if the page redirected to a new location. This value is normally set by the WebKit.

---

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

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