7e5ed5369ed0c033a424eafcfcd925a263ddced4
[platform/framework/web/chromium-efl.git] / tizen_src / ewk / efl_integration / public / ewk_frame.h
1 // Copyright 2012 Samsung Electronics. All rights reserved.
2 // Use of this source code is governed by a BSD-style license that can be
3 // found in the LICENSE file.
4
5 #ifndef ewk_frame_h
6 #define ewk_frame_h
7
8 #include <Eina.h>
9 #include <tizen.h>
10
11 #ifdef __cplusplus
12 extern "C" {
13 #endif
14
15 typedef struct _Ewk_Frame _Ewk_Frame;
16 typedef _Ewk_Frame* Ewk_Frame_Ref;
17
18 /**
19  * Callback for ewk_frame_source_get
20  *
21  * @param frame frame object to get the frame source
22  * @param source frame source on success, or NULL on failure
23  * @param user_data user data
24  */
25 typedef void (*Ewk_Frame_Source_Get_Callback)(Ewk_Frame_Ref frame, const char* source, void* user_data);
26
27 /**
28  * Gets whether a MIME type can be displayed in the frame.
29  *
30  * @param frame frame object
31  * @param mime_type a mime type
32  *
33  * @return @c EINA_TRUE if the MIME type can be displayed or @c EINA_FALSE otherwise
34  */
35 EXPORT_API Eina_Bool ewk_frame_can_show_mime_type(Ewk_Frame_Ref frame, char* mime_type);
36
37 /**
38  * Gets whether the frame is main frame.
39  *
40  * @param frame frame object
41  *
42  * @return @c EINA_TRUE if the frame is main frame or @c EINA_FALSE otherwise
43  */
44 EXPORT_API Eina_Bool ewk_frame_is_main_frame(Ewk_Frame_Ref frame);
45
46 #ifdef __cplusplus
47 }
48 #endif
49 #endif // ewk_frame_h