1/*
2 * Copyright (C) 2012 Intel Corporation. All rights reserved.
3 * Copyright (C) 2013 Samsung Electronics. All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 * 1. Redistributions of source code must retain the above copyright
9 *    notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 *    notice, this list of conditions and the following disclaimer in the
12 *    documentation and/or other materials provided with the distribution.
13 *
14 * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
15 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
16 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
17 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
18 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
19 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
20 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
21 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
22 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
23 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
24 * THE POSSIBILITY OF SUCH DAMAGE.
25 */
26
27/**
28 * @file    ewk_favicon_database.h
29 * @brief   Describes the Ewk Favicon Database API.
30 */
31
32#ifndef ewk_favicon_database_h
33#define ewk_favicon_database_h
34
35#include <Evas.h>
36
37#ifdef __cplusplus
38extern "C" {
39#endif
40
41/** Creates a type name for @a Ewk_Favicon_Database. */
42typedef struct EwkFaviconDatabase Ewk_Favicon_Database;
43
44/**
45 * @typedef Ewk_Favicon_Database_Icon_Change_Cb Ewk_Favicon_Database_Icon_Change_Cb
46 * @brief Callback type for use with ewk_favicon_database_icon_change_callback_add and ewk_favicon_database_icon_change_callback_del
47 */
48typedef void (*Ewk_Favicon_Database_Icon_Change_Cb)(const char *page_url, void *event_info);
49
50/**
51 * Retrieves from the database the favicon for the given @a page_url
52 *
53 * @param database database object to query
54 * @param page_url URL of the page to get the favicon for
55 * @param evas The canvas to add the favicon to
56 *
57 * @return The favicon as an Evas_Object if successful, @c NULL otherwise.
58 * The returned Evas_Object needs to be freed after use.
59 */
60EAPI Evas_Object *ewk_favicon_database_icon_get(Ewk_Favicon_Database *database, const char *page_url, Evas *evas);
61
62/**
63 * Add (register) a callback function to a icon change event
64 *
65 * @param database database object to register the callback
66 * @param callback callback function to be called when an icon changes
67 * @param data the data pointer that was to be passed to the callback
68 */
69EAPI void ewk_favicon_database_icon_change_callback_add(Ewk_Favicon_Database *database, Ewk_Favicon_Database_Icon_Change_Cb callback, void *data);
70
71/**
72 * Delete (unregister) a callback function registered to a icon change event
73 *
74 * @param database database object to unregister the callback.
75 * @param callback callback function to unregister
76 */
77EAPI void ewk_favicon_database_icon_change_callback_del(Ewk_Favicon_Database *database, Ewk_Favicon_Database_Icon_Change_Cb callback);
78
79#ifdef __cplusplus
80}
81#endif
82
83#endif // ewk_favicon_database_h
84