[M67 Dev][EWK] Classify EWK APIs by public, internal, or product
[platform/framework/web/chromium-efl.git] / tizen_src / ewk / efl_integration / public / ewk_main.h
1 /*
2     Copyright (C) 2009-2010 ProFUSION embedded systems
3     Copyright (C) 2016 Samsung Electronics
4     Copyright (C) 2012 Intel Corporation
5
6     This library is free software; you can redistribute it and/or
7     modify it under the terms of the GNU Library General Public
8     License as published by the Free Software Foundation; either
9     version 2 of the License, or (at your option) any later version.
10
11     This library is distributed in the hope that it will be useful,
12     but WITHOUT ANY WARRANTY; without even the implied warranty of
13     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14     Library General Public License for more details.
15
16     You should have received a copy of the GNU Library General Public License
17     along with this library; see the file COPYING.LIB.  If not, write to
18     the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
19     Boston, MA 02110-1301, USA.
20 */
21
22 /**
23  * @file    ewk_main.h
24  * @brief   This file is the general initialization of Chromium-efl,
25             not tied to any view object.
26  */
27
28 #ifndef ewk_main_h
29 #define ewk_main_h
30
31 #include <Eina.h>
32 #include <tizen.h>
33
34 #ifdef __cplusplus
35 extern "C" {
36 #endif
37
38 /**
39  * @addtogroup WEBVIEW
40  * @{
41  */
42
43 /**
44  * @brief Initializes Chromium's instance.
45  *
46  * - Initializes components needed by EFL,\n
47  * - Increases a reference count of Chromium's instance.
48  *
49  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
50  *
51  * @return A reference count of Chromium's instance on success,\n
52  *         otherwise @c 0 on failure
53  */
54 EXPORT_API int ewk_init(void);
55
56 /**
57  * @brief Decreases a reference count of Chromium's instance,
58  *        possibly destroying it.
59  *
60  * @details If the reference count reaches @c 0, Chromium's instance is
61  *          destroyed.
62  *
63  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
64  *
65  * @return A reference count of Chromium's instance
66  */
67 EXPORT_API int ewk_shutdown(void);
68
69 /**
70 * @}
71 */
72
73 #ifdef __cplusplus
74 }
75 #endif
76 #endif // ewk_main_h