1/*
2 * Copyright (C) 2013 Samsung Electronics. All rights reserved.
3 *
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions
6 * are met:
7 * 1. Redistributions of source code must retain the above copyright
8 *    notice, this list of conditions and the following disclaimer.
9 * 2. Redistributions in binary form must reproduce the above copyright
10 *    notice, this list of conditions and the following disclaimer in the
11 *    documentation and/or other materials provided with the distribution.
12 *
13 * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
14 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23 * THE POSSIBILITY OF SUCH DAMAGE.
24 */
25
26/**
27 * @file    ewk_page_group.h
28 * @brief   Describes the Ewk Page Group API.
29 */
30
31#ifndef ewk_page_group_h
32#define ewk_page_group_h
33
34#include "ewk_settings.h"
35#include <Eina.h>
36
37#ifdef __cplusplus
38extern "C" {
39#endif
40
41/**
42 * Declare Ewk_Page_Group as Ewk_Object.
43 *
44 * @see Ewk_Object
45 */
46typedef struct EwkObject Ewk_Page_Group;
47
48/**
49 * Creates a new Ewk_Page_Group.
50 *
51 * The returned Ewk_Page_Group object @b should be unref'ed after use.
52 *
53 * @return Ewk_Page_Group object on success or @c NULL on failure
54 *
55 * @see ewk_object_unref
56 */
57EAPI Ewk_Page_Group *ewk_page_group_create(const char *identifier);
58
59/**
60 * Gets the Ewk_Settings of this @a page_group.
61 *
62 * @param page_group Ewk_Page_Group object to get Ewk_Settings
63 *
64 * @return the Ewk_Settings instance or @c NULL on failure
65 */
66EAPI Ewk_Settings *ewk_page_group_settings_get(const Ewk_Page_Group *page_group);
67
68/**
69 * Adds the user style sheet to this page group.
70 *
71 * @param page_group ewk_page_gorup object to add the user style sheet
72 * @param source the user style sheet
73 * @param url baseURL
74 * @param white_list url list to allow adding the user style sheet
75 * @param black_list url list to disallow adding the user style sheet
76 * @param main_frame_only a state to apply the user style sheet only to the mainframe
77 *
78 * @return @c EINA_TRUE if the user style sheet is added to the page group, or
79 *         @c EINA_FALSE otherwise
80 */
81EAPI Eina_Bool ewk_page_group_user_style_sheet_add(Ewk_Page_Group *page_group, const char *source, const char *base_url, Eina_List *white_list, Eina_List *black_list, Eina_Bool main_frame_only);
82
83/**
84 * Remove all the user style sheets from this page group.
85 *
86 * @param page_group page group object to remove all the user style sheets
87 *
88 * @return @c EINA_TRUE if all the user style sheet are removed from the page group, or
89 *         @c EINA_FALSE otherwise
90 */
91EAPI Eina_Bool ewk_page_group_user_style_sheets_remove_all(Ewk_Page_Group *page_group);
92
93#ifdef __cplusplus
94}
95#endif
96
97#endif // ewk_page_group_h
98