Describes the Ewk Favicon Database API. More...

#include <Evas.h>

Typedefs
typedef struct EwkFaviconDatabase	Ewk_Favicon_Database

typedef void(*	Ewk_Favicon_Database_Icon_Change_Cb) (Ewk_Favicon_Database database, const char url, void *data)
	Callback type for use with ewk_favicon_database_icon_change_callback_add and ewk_favicon_database_icon_change_callback_del.

Functions
EAPI Evas_Object *	ewk_favicon_database_icon_get (Ewk_Favicon_Database database, const char url, Evas *evas)

EAPI void	ewk_favicon_database_icon_change_callback_add (Ewk_Favicon_Database database, Ewk_Favicon_Database_Icon_Change_Cb callback, void data)

EAPI void	ewk_favicon_database_icon_change_callback_del (Ewk_Favicon_Database *database, Ewk_Favicon_Database_Icon_Change_Cb callback)

EAPI void	ewk_favicon_database_clear (Ewk_Favicon_Database *database)

Detailed Description

Describes the Ewk Favicon Database API.

Typedef Documentation

Creates a type name for Ewk_Favicon_Database.

EAPI void ewk_favicon_database_clear ( Ewk_Favicon_Database * database )

Deletes all favicon data.

Parameters

database database object to clear all favicon data

EAPI void ewk_favicon_database_icon_change_callback_add	(	Ewk_Favicon_Database *	database,
		Ewk_Favicon_Database_Icon_Change_Cb	callback,
		void *	data
	)

Add (register) a callback function to a icon change event

Parameters

database	database object to register the callback
callback	callback function to be called when an icon changes
data	the data pointer that was to be passed to the callback

Note: In order to enable the favicons database, ewk_context_favicon_database_direct_set must be called.

See also: ewk_context_favicon_database_directory_set; ewk_context_favicon_database_get

EAPI void ewk_favicon_database_icon_change_callback_del	(	Ewk_Favicon_Database *	database,
		Ewk_Favicon_Database_Icon_Change_Cb	callback
	)

Delete (unregister) a callback function registered to a icon change event

Parameters

database	database object to unregister the callback.
callback	callback function to unregister

See also: ewk_favicon_database_icon_change_callback_add; ewk_context_favicon_database_directory_set; ewk_context_favicon_database_get

EAPI Evas_Object* ewk_favicon_database_icon_get	(	Ewk_Favicon_Database *	database,
		const char *	url,
		Evas *	evas
	)

Retrieves from the database the favicon for the given url

Parameters

database	database object to query
url	URL of the page to get the favicon for
evas	The canvas to add the favicon to

Returns: The favicon as an Evas_Object if successful, NULL otherwise. The returned Evas_Object needs to be freed after use.

Note: In order to enable the favicons database, ewk_context_favicon_database_direct_set must be called.

See also: ewk_context_favicon_database_directory_set; ewk_context_favicon_database_get