IWebIconDatabase Interface Reference

import"IWebIconDatabase.idl";

Inheritance diagram for IWebIconDatabase:

Public Member Functions
HRESULT	sharedIconDatabase ([out, retval] IWebIconDatabase **result)
HRESULT	iconForURL ([in] BSTR url, [in] LPSIZE size, [in] BOOL cache, [out, retval] HBITMAP *hBitmap)
HRESULT	defaultIconWithSize ([in] LPSIZE size, [out, retval] HBITMAP *hBitmap)
HRESULT	retainIconForURL ([in] BSTR url)
HRESULT	releaseIconForURL ([in] BSTR url)
HRESULT	removeAllIcons ()
HRESULT	delayDatabaseCleanup ()
HRESULT	allowDatabaseCleanup ()
HRESULT	iconURLForURL ([in] BSTR url, [out, retval] BSTR *iconURL)
HRESULT	isEnabled ([out, retval] BOOL *result)
HRESULT	setEnabled ([in] BOOL flag)
HRESULT	hasIconForURL ([in] BSTR url, [out, retval] BOOL *result)

Member Function Documentation

allowDatabaseCleanup()

HRESULT IWebIconDatabase::allowDatabaseCleanup

(

)

allowDatabaseCleanup: Informs the database that it now can begin removing icons. allowDatabaseCleanup decrements an internal counter that when 0 begins the database clean-up. The counter equals 0 at initialization.

• (void)allowDatabaseCleanup;

Implemented in WebIconDatabase, and WebIconDatabase.

defaultIconWithSize()

HRESULT IWebIconDatabase::defaultIconWithSize	(	[in] LPSIZE	size,
		[out, retval] HBITMAP *	hBitmap
	)

defaultIconWithSize:

Parameters

size	(NSImage *)defaultIconWithSize:(NSSize)size;

delayDatabaseCleanup()

HRESULT IWebIconDatabase::delayDatabaseCleanup

(

)

delayDatabaseCleanup: Only effective if called before the database begins removing icons. delayDatabaseCleanUp increments an internal counter that when 0 begins the database clean-up. The counter equals 0 at initialization.

• (void)delayDatabaseCleanup;

Implemented in WebIconDatabase, and WebIconDatabase.

hasIconForURL()

HRESULT IWebIconDatabase::hasIconForURL	(	[in] BSTR	url,
		[out, retval] BOOL *	result
	)

hasIconForURL: Returns whether or not the icon database has an icon for this URL. url The URL to test for.

iconForURL()

HRESULT IWebIconDatabase::iconForURL	(	[in] BSTR	url,
		[in] LPSIZE	size,
		[in] BOOL	cache,
		[out, retval] HBITMAP *	hBitmap
	)

iconForURL:withSize: Calls iconForURL:withSize:cache: with YES for cache.

Parameters

URL
size	(NSImage *)iconForURL:(NSString *)URL withSize:(NSSize)size;

iconForURL:withSize:cache: Returns an icon for a web site URL from memory or disk. nil if none is found. Usually called by a UI element to determine if a site URL has an associated icon. Often called by the observer of WebIconChangedNotification after the notification is sent.

Parameters

URL
size
cache	If yes, caches the returned image in memory if not already cached (NSImage *)iconForURL:(NSString *)URL withSize:(NSSize)size cache:(BOOL)cache;

iconURLForURL:withSize:cache: Returns an icon URL for a web site URL from memory or disk. nil if none is found.

Parameters

URL	(NSString *)iconURLForURL:(NSString *)URL;

iconURLForURL()

HRESULT IWebIconDatabase::iconURLForURL	(	[in] BSTR	url,
		[out, retval] BSTR *	iconURL
	)

iconURLForURL:withSize:cache: Returns an icon URL for a web site URL from memory or disk. nil if none is found.

Parameters

URL	(NSString *)iconURLForURL:(NSString *)URL;

isEnabled()

HRESULT IWebIconDatabase::isEnabled

(

[out, retval] BOOL *

result

)

isEnabled Returns true if the icon database is currently enabled, or false if it is disabled.

• (BOOL)isEnabled;

releaseIconForURL()

HRESULT IWebIconDatabase::releaseIconForURL

(

[in] BSTR

url

)

releaseIconForURL: Decrements the retain count of the icon.

Parameters

URL	(void)releaseIconForURL:(NSString *)URL;

removeAllIcons()

HRESULT IWebIconDatabase::removeAllIcons

(

)

removeAllIcons: Emtpies the Icon Database

• (void)removeAllIcons;

Implemented in WebIconDatabase.

retainIconForURL()

HRESULT IWebIconDatabase::retainIconForURL

(

[in] BSTR

url

)

retainIconForURL: Increments the retain count of the icon.

Parameters

URL	(void)retainIconForURL:(NSString *)URL;

setEnabled()

HRESULT IWebIconDatabase::setEnabled

(

[in] BOOL

flag

)

setEnabled: Enables or disables the icon database based on the flag passed in.

Parameters

flag	Pass true to enable the icon database, or false to disable it. (void)setEnabled:(BOOL)flag;

Implemented in WebIconDatabase.

sharedIconDatabase()

HRESULT IWebIconDatabase::sharedIconDatabase

(

[out, retval] IWebIconDatabase **

result

)

sharedIconDatabase Returns a shared instance of the icon database

• (WebIconDatabase *)sharedIconDatabase;

---

The documentation for this interface was generated from the following file:

• Source/WebKit/win/Interfaces/IWebIconDatabase.idl