Tizen Native API
|
Functions | |
Ewk_Back_Forward_List_Item * | ewk_back_forward_list_current_item_get (const Ewk_Back_Forward_List *list) |
Returns the current item in the list. | |
Ewk_Back_Forward_List_Item * | ewk_back_forward_list_previous_item_get (const Ewk_Back_Forward_List *list) |
Returns the item that precedes the current item in the list. | |
Ewk_Back_Forward_List_Item * | ewk_back_forward_list_next_item_get (const Ewk_Back_Forward_List *list) |
Returns the item that follows the current item in the list. | |
Ewk_Back_Forward_List_Item * | ewk_back_forward_list_item_at_index_get (const Ewk_Back_Forward_List *list, int index) |
Returns the item at a given index relative to the current item. | |
unsigned | ewk_back_forward_list_count (Ewk_Back_Forward_List *list) |
Returns the length of the back-forward list including the current item. | |
Eina_List * | ewk_back_forward_list_n_back_items_copy (const Ewk_Back_Forward_List *list, int limit) |
Creates a list containing the items preceding the current item limited by limit. | |
Eina_List * | ewk_back_forward_list_n_forward_items_copy (const Ewk_Back_Forward_List *list, int limit) |
Creates the list containing the items following the current item limited by limit. | |
Ewk_Back_Forward_List_Item * | ewk_back_forward_list_item_ref (Ewk_Back_Forward_List_Item *item) |
Increases the reference count of the given object. | |
void | ewk_back_forward_list_item_unref (Ewk_Back_Forward_List_Item *item) |
Decreases the reference count of the given object, possibly freeing it. | |
const char * | ewk_back_forward_list_item_url_get (const Ewk_Back_Forward_List_Item *item) |
Returns the URL of the item. | |
const char * | ewk_back_forward_list_item_title_get (const Ewk_Back_Forward_List_Item *item) |
Returns the title of the item. | |
const char * | ewk_back_forward_list_item_original_url_get (const Ewk_Back_Forward_List_Item *item) |
Returns the original URL of the item. | |
Ewk_Cookie_Manager * | ewk_context_cookie_manager_get (const Ewk_Context *context) |
Gets the cookie manager instance for this context. | |
Eina_Bool | ewk_context_cache_model_set (Ewk_Context *context, Ewk_Cache_Model model) |
Requests to set the cache model. | |
Ewk_Cache_Model | ewk_context_cache_model_get (const Ewk_Context *context) |
Returns the cache model type. | |
void | ewk_context_resource_cache_clear (Ewk_Context *context) |
Clears HTTP caches in the local storage and all resources cached in memory such as images, CSS, JavaScript, XSL, and fonts for context. | |
void | ewk_context_preferred_languages_set (Eina_List *languages) |
Sets the list of preferred languages. | |
unsigned | ewk_context_menu_item_count (Ewk_Context_Menu *menu) |
Counts the number of context menu items. | |
Ewk_Context_Menu_Item * | ewk_context_menu_nth_item_get (Ewk_Context_Menu *menu, unsigned int n) |
Returns the nth item in a context menu. | |
Eina_Bool | ewk_context_menu_item_remove (Ewk_Context_Menu *menu, Ewk_Context_Menu_Item *item) |
Removes the context menu item from the context menu object. | |
Eina_Bool | ewk_context_menu_item_append_as_action (Ewk_Context_Menu *menu, Ewk_Context_Menu_Item_Tag tag, const char *title, Eina_Bool enabled) |
Adds the context menu item to the context menu object. | |
Eina_Bool | ewk_context_menu_item_append (Ewk_Context_Menu *menu, Ewk_Context_Menu_Item_Tag tag, const char *title, const char *icon_file, Eina_Bool enabled) |
Adds the context menu item to the context menu object. | |
Ewk_Context_Menu_Item_Tag | ewk_context_menu_item_tag_get (Ewk_Context_Menu_Item *item) |
Returns the tag of the context menu item. | |
const char * | ewk_context_menu_item_link_url_get (Ewk_Context_Menu_Item *item) |
Returns the link URL string of the context menu item. | |
const char * | ewk_context_menu_item_image_url_get (Ewk_Context_Menu_Item *item) |
Returns the image URL string of the context menu item. | |
void | ewk_cookie_manager_accept_policy_set (Ewk_Cookie_Manager *manager, Ewk_Cookie_Accept_Policy policy) |
Sets policy as the cookie acceptance policy for manager. | |
void | ewk_cookie_manager_accept_policy_async_get (const Ewk_Cookie_Manager *manager, Ewk_Cookie_Manager_Policy_Async_Get_Cb callback, void *data) |
Gets the cookie acceptance policy of manager asynchronously. | |
void | ewk_cookie_manager_cookies_clear (Ewk_Cookie_Manager *manager) |
Deletes all the cookies of manager. | |
const char * | ewk_error_url_get (const Ewk_Error *error) |
Query failing URL for this error. | |
int | ewk_error_code_get (const Ewk_Error *error) |
Query the error code. | |
const char * | ewk_error_description_get (const Ewk_Error *error) |
Query description for this error. | |
Eina_Bool | ewk_error_cancellation_get (const Ewk_Error *error) |
Query if error should be treated as a cancellation. | |
int | ewk_init (void) |
Initializes WebKit's instance. | |
int | ewk_shutdown (void) |
Decreases a reference count of WebKit's instance, possibly destroying it. | |
const char * | ewk_policy_decision_cookie_get (Ewk_Policy_Decision *policy_decision) |
Returns a cookie from the Policy Decision object. | |
const char * | ewk_policy_decision_url_get (Ewk_Policy_Decision *policy_decision) |
Returns a URL from the Policy Decision object. | |
const char * | ewk_policy_decision_scheme_get (Ewk_Policy_Decision *policy_decision) |
Returns a scheme from the Policy Decision object. | |
const char * | ewk_policy_decision_host_get (Ewk_Policy_Decision *policy_decision) |
Returns a host from the Policy Decision object. | |
const char * | ewk_policy_decision_http_method_get (Ewk_Policy_Decision *policy_decision) |
Returns an HTTP method from the Policy Decision object. | |
const char * | ewk_policy_decision_response_mime_get (Ewk_Policy_Decision *policy_decision) |
Returns a MIME type for response data from the Policy Decision object. | |
const Eina_Hash * | ewk_policy_decision_response_headers_get (Ewk_Policy_Decision *policy_decision) |
Returns HTTP headers for response data from the Policy Decision object. | |
int | ewk_policy_decision_response_status_code_get (Ewk_Policy_Decision *policy_decision) |
Returns an HTTP status code from the Policy Decision object. | |
Ewk_Policy_Decision_Type | ewk_policy_decision_type_get (const Ewk_Policy_Decision *policy_decision) |
Returns a policy type from the Policy Decision object. | |
Eina_Bool | ewk_policy_decision_use (Ewk_Policy_Decision *policy_decision) |
Accepts the action which triggers this decision. | |
Eina_Bool | ewk_policy_decision_ignore (Ewk_Policy_Decision *policy_decision) |
Ignores the action which triggers this decision. | |
Ewk_Policy_Navigation_Type | ewk_policy_decision_navigation_type_get (Ewk_Policy_Decision *policy_decision) |
Returns a navigation type from the Policy Decision object. | |
Eina_Bool | ewk_settings_auto_fitting_set (Ewk_Settings *settings, Eina_Bool enable) |
Requests setting of auto fit. | |
Eina_Bool | ewk_settings_auto_fitting_get (const Ewk_Settings *settings) |
Returns the auto fit status. | |
Eina_Bool | ewk_settings_javascript_enabled_set (Ewk_Settings *settings, Eina_Bool enable) |
Enables/disables JavaScript executing. | |
Eina_Bool | ewk_settings_javascript_enabled_get (const Ewk_Settings *settings) |
Returns whether JavaScript can be executable. | |
Eina_Bool | ewk_settings_loads_images_automatically_set (Ewk_Settings *settings, Eina_Bool automatic) |
Enables/disables auto loading of images. | |
Eina_Bool | ewk_settings_loads_images_automatically_get (const Ewk_Settings *settings) |
Returns whether images can be loaded automatically. | |
Eina_Bool | ewk_settings_default_text_encoding_name_set (Ewk_Settings *settings, const char *encoding) |
Sets the default text encoding name. | |
const char * | ewk_settings_default_text_encoding_name_get (const Ewk_Settings *settings) |
Gets the default text encoding name. | |
Eina_Bool | ewk_settings_default_font_size_set (Ewk_Settings *settings, int size) |
Sets the default font size. | |
int | ewk_settings_default_font_size_get (const Ewk_Settings *settings) |
Returns the default font size. | |
Eina_Bool | ewk_settings_private_browsing_enabled_set (Ewk_Settings *settings, Eina_Bool enable) |
Requests to enable/disable private browsing. | |
Eina_Bool | ewk_settings_private_browsing_enabled_get (const Ewk_Settings *settings) |
Enables/disables private browsing. | |
Eina_Bool | ewk_settings_scripts_can_open_windows_set (Ewk_Settings *settings, Eina_Bool enable) |
Enables/disables if the scripts can open new windows. | |
Eina_Bool | ewk_settings_scripts_can_open_windows_get (const Ewk_Settings *settings) |
Returns whether the scripts can open new windows. | |
Evas_Object * | ewk_view_add (Evas *e) |
Creates a new EFL WebKit view object. | |
Ewk_Context * | ewk_view_context_get (const Evas_Object *o) |
Gets the Ewk_Context of this view. | |
Eina_Bool | ewk_view_url_set (Evas_Object *o, const char *url) |
Asks the object to load the given URL. | |
const char * | ewk_view_url_get (const Evas_Object *o) |
Returns the current URL string of the view object. | |
Eina_Bool | ewk_view_reload (Evas_Object *o) |
Asks the main frame to reload the current document. | |
Eina_Bool | ewk_view_stop (Evas_Object *o) |
Asks the main frame to stop loading. | |
Ewk_Settings * | ewk_view_settings_get (const Evas_Object *o) |
Gets the Ewk_Settings of this view. | |
Eina_Bool | ewk_view_back (Evas_Object *o) |
Asks the main frame to navigate back in history. | |
Eina_Bool | ewk_view_forward (Evas_Object *o) |
Asks the main frame to navigate forward in history. | |
Eina_Bool | ewk_view_back_possible (Evas_Object *o) |
Checks whether it is possible to navigate backwards one item in history. | |
Eina_Bool | ewk_view_forward_possible (Evas_Object *o) |
Checks whether it is possible to navigate forwards one item in history. | |
Ewk_Back_Forward_List * | ewk_view_back_forward_list_get (const Evas_Object *o) |
Gets the back-forward list associated with this view. | |
void | ewk_view_back_forward_list_clear (const Evas_Object *o) |
Clears the back-forward list of a page. | |
const char * | ewk_view_title_get (const Evas_Object *o) |
Gets the current title of the main frame. | |
double | ewk_view_load_progress_get (const Evas_Object *o) |
Gets the current load progress of the page. | |
Eina_Bool | ewk_view_user_agent_set (Evas_Object *o, const char *user_agent) |
Requests to set the user agent string. | |
const char * | ewk_view_user_agent_get (const Evas_Object *o) |
Returns the user agent string. | |
Eina_Bool | ewk_view_contents_size_get (const Evas_Object *o, Evas_Coord *width, Evas_Coord *height) |
Gets the last known content's size. | |
Eina_Bool | ewk_view_script_execute (Evas_Object *o, const char *script, Ewk_View_Script_Execute_Cb callback, void *user_data) |
Requests the execution of the given script. | |
Eina_Bool | ewk_view_scale_set (Evas_Object *o, double scale_factor, int cx, int cy) |
Scales the current page, centered at the given point. | |
double | ewk_view_scale_get (const Evas_Object *o) |
Gets the current scale factor of the page. | |
Eina_Bool | ewk_view_fullscreen_exit (Evas_Object *o) |
Exits fullscreen when the back key is pressed. | |
void | ewk_view_suspend (Evas_Object *o) |
Suspends the operation associated with the view object. | |
void | ewk_view_resume (Evas_Object *o) |
Resumes the operation associated with the view object after calling ewk_view_suspend(). | |
Eina_Bool | ewk_view_url_request_set (Evas_Object *o, const char *url, Ewk_Http_Method method, Eina_Hash *headers, const char *body) |
Requests loading of the given request data. | |
Eina_Bool | ewk_view_contents_set (Evas_Object *o, const char *contents, size_t contents_size, char *mime_type, char *encoding, char *base_uri) |
Requests loading the given contents by MIME type into the view object. | |
void | ewk_view_scroll_by (Evas_Object *o, int dx, int dy) |
Scrolls the webpage of view by dx and dy. | |
Eina_Bool | ewk_view_scroll_pos_get (Evas_Object *o, int *x, int *y) |
Gets the current scroll position of the given view. | |
Eina_Bool | ewk_view_scroll_set (Evas_Object *o, int x, int y) |
Sets an absolute scroll of the given view. | |
Eina_Bool | ewk_view_text_find (Evas_Object *o, const char *text, Ewk_Find_Options options, unsigned max_match_count) |
Searches and highlights the given string in the document. | |
Typedefs | |
typedef struct Ewk_Context | Ewk_Context |
The structure type that creates a type name for Ewk_Context. | |
typedef struct Ewk_Settings | Ewk_Settings |
The structure type that creates a type name for Ewk_Settings. | |
typedef enum Ewk_Find_Options | Ewk_Find_Options |
Enumeration that creates a type name for the Ewk_Find_Options. | |
typedef struct _Ewk_Policy_Decision | Ewk_Policy_Decision |
The structure type that creates a type name for Ewk_Policy_Decision. | |
typedef struct Ewk_Error | Ewk_Error |
The structure type that creates a type name for Ewk_Error. | |
typedef struct Ewk_Back_Forward_List | Ewk_Back_Forward_List |
The structure type that creates a type name for Ewk_Back_Forward_List. | |
typedef struct Ewk_Back_Forward_List_Item | Ewk_Back_Forward_List_Item |
The structure type that creates a type name for Ewk_Back_Forward_List_Item. | |
typedef enum Ewk_Cache_Model | Ewk_Cache_Model |
Enumeration that creates a type name for the Ewk_Cache_Model. | |
typedef uint32_t | Ewk_Context_Menu_Item_Tag |
The structure type that creates a type name for _Ewk_Context_Menu_Item_Tag. | |
typedef struct _Ewk_Context_Menu | Ewk_Context_Menu |
The structure type that creates a type name for Ewk_Context_Menu. | |
typedef struct _Ewk_Context_Menu_Item | Ewk_Context_Menu_Item |
The structure type that creates a type name for Ewk_Context_Menu_Item. | |
typedef struct Ewk_Cookie_Manager | Ewk_Cookie_Manager |
The structure type that creates a type name for Ewk_Cookie_Manager. | |
typedef enum Ewk_Cookie_Accept_Policy | Ewk_Cookie_Accept_Policy |
Enumeration that creates a type name for the Ewk_Cookie_Accept_Policy. | |
typedef void(* | Ewk_Cookie_Manager_Policy_Async_Get_Cb )(Ewk_Cookie_Accept_Policy policy, void *event_info) |
Called for use with ewk_cookie_manager_accept_policy_async_get(). | |
typedef enum _Ewk_Policy_Decision_Type | Ewk_Policy_Decision_Type |
Enumeration that creates a type name for the Ewk_Policy_Decision_Type. | |
typedef enum _Ewk_Policy_Navigation_Type | Ewk_Policy_Navigation_Type |
Enumeration that creates a type name for Ewk_Policy_Navigation_Type. | |
typedef void(* | Ewk_View_Script_Execute_Cb )(Evas_Object *o, const char *result_value, void *user_data) |
Callback for ewk_view_script_execute(). | |
typedef enum Ewk_Http_Method | Ewk_Http_Method |
Enumeration that creates a type name for the Ewk_Http_Method. |
The WebView API provides functions to display web pages and control web pages.
#include <EWebKit.h>
The WebView API provides functions to display web pages and control web pages. It is based on the WebKit engine, which is one of the most popular layout engines to render web pages.
It is WebKit main smart object. This object provides view related APIs of WebKit2 to EFL object.
The following signals (see evas_object_smart_callback_add()) are emitted:
Signals | Type | Description |
---|---|---|
close,window | void | Window is closed |
contextmenu,customize | Ewk_Context_Menu* | Requested context menu items can be customized by app side |
contextmenu,selected | Ewk_Context_Menu_Item* | A context menu item is selected |
create,window | Evas_Object** | A new window is created |
fullscreen,enterfullscreen | bool* | Reports to enter fullscreen |
fullscreen,exitfullscreen | void | Reports to exit fullscreen |
load,committed | void | Reports load committed |
load,error | Ewk_Error* | Reports load error |
load,finished | void | Reports load finished |
load,progress | double* | Load progress has changed |
load,started | void | Reports load started |
policy,navigation,decide | Ewk_Policy_Decision* | A navigation policy decision should be taken |
policy,newwindow,decide | Ewk_Policy_Decision* | A new window policy decision should be taken |
policy,response,decide | Ewk_Policy_Decision* | A response policy decision should be taken |
text,found | unsigned* | The requested text was found and it gives the number of matches |
title,changed | const char* | Title of the main frame was changed |
url,changed | const char* | Url of the main frame was changed |
typedef struct Ewk_Back_Forward_List Ewk_Back_Forward_List |
The structure type that creates a type name for Ewk_Back_Forward_List.
typedef struct Ewk_Back_Forward_List_Item Ewk_Back_Forward_List_Item |
The structure type that creates a type name for Ewk_Back_Forward_List_Item.
typedef enum Ewk_Cache_Model Ewk_Cache_Model |
Enumeration that creates a type name for the Ewk_Cache_Model.
typedef struct Ewk_Context Ewk_Context |
The structure type that creates a type name for Ewk_Context.
typedef struct _Ewk_Context_Menu Ewk_Context_Menu |
The structure type that creates a type name for Ewk_Context_Menu.
typedef struct _Ewk_Context_Menu_Item Ewk_Context_Menu_Item |
The structure type that creates a type name for Ewk_Context_Menu_Item.
typedef uint32_t Ewk_Context_Menu_Item_Tag |
The structure type that creates a type name for _Ewk_Context_Menu_Item_Tag.
typedef enum Ewk_Cookie_Accept_Policy Ewk_Cookie_Accept_Policy |
Enumeration that creates a type name for the Ewk_Cookie_Accept_Policy.
typedef struct Ewk_Cookie_Manager Ewk_Cookie_Manager |
The structure type that creates a type name for Ewk_Cookie_Manager.
typedef void(* Ewk_Cookie_Manager_Policy_Async_Get_Cb)(Ewk_Cookie_Accept_Policy policy, void *event_info) |
Called for use with ewk_cookie_manager_accept_policy_async_get().
[in] | policy | A Ewk_Cookie_Accept_Policy |
[in] | event_info | The user data that will be passsed when ewk_cookie_manager_accept_policy_async_get() is called |
The structure type that creates a type name for Ewk_Error.
typedef enum Ewk_Find_Options Ewk_Find_Options |
Enumeration that creates a type name for the Ewk_Find_Options.
typedef struct _Ewk_Policy_Decision Ewk_Policy_Decision |
The structure type that creates a type name for Ewk_Policy_Decision.
typedef enum _Ewk_Policy_Decision_Type Ewk_Policy_Decision_Type |
Enumeration that creates a type name for the Ewk_Policy_Decision_Type.
typedef enum _Ewk_Policy_Navigation_Type Ewk_Policy_Navigation_Type |
Enumeration that creates a type name for Ewk_Policy_Navigation_Type.
typedef struct Ewk_Settings Ewk_Settings |
The structure type that creates a type name for Ewk_Settings.
typedef void(* Ewk_View_Script_Execute_Cb)(Evas_Object *o, const char *result_value, void *user_data) |
Callback for ewk_view_script_execute().
[in] | o | The view object |
[in] | result_value | The value returned by the script |
[in] | user_data | The user_data will be passsed when ewk_view_script_execute() is called |
Enumeration that provides the tags of items in the context menu.
EWK_CONTEXT_MENU_ITEM_TAG_OPEN_LINK_IN_NEW_WINDOW |
Open link in new window |
EWK_CONTEXT_MENU_ITEM_TAG_DOWNLOAD_LINK_TO_DISK |
Download link to disk |
EWK_CONTEXT_MENU_ITEM_TAG_COPY_LINK_TO_CLIPBOARD |
Copy link to clipboard |
EWK_CONTEXT_MENU_ITEM_TAG_OPEN_IMAGE_IN_NEW_WINDOW |
Open image in new window |
EWK_CONTEXT_MENU_ITEM_TAG_DOWNLOAD_IMAGE_TO_DISK |
Download image to disk |
EWK_CONTEXT_MENU_ITEM_TAG_COPY_IMAGE_TO_CLIPBOARD |
Copy image to clipboard |
EWK_CONTEXT_MENU_ITEM_TAG_COPY |
Copy |
EWK_CONTEXT_MENU_ITEM_TAG_CUT |
Cut |
EWK_CONTEXT_MENU_ITEM_TAG_PASTE |
Paste |
EWK_CONTEXT_MENU_ITEM_TAG_SEARCH_WEB |
Search web |
EWK_CONTEXT_MENU_ITEM_TAG_OPEN_LINK |
Open link |
EWK_CONTEXT_MENU_ITEM_TAG_INSPECT_ELEMENT |
Inspect element |
EWK_CONTEXT_MENU_ITEM_TAG_SELECT_ALL |
Select all |
EWK_CONTEXT_MENU_ITEM_TAG_SELECT_WORD |
Select word |
EWK_CONTEXT_MENU_ITEM_TAG_TEXT_SELECTION_MODE |
Text selection mode |
EWK_CONTEXT_MENU_ITEM_TAG_CLIPBOARD |
Clipboard |
EWK_CONTEXT_MENU_ITEM_TAG_COPY_LINK_DATA |
Copy link data |
EWK_CONTEXT_MENU_ITEM_BASE_APPLICATION_TAG |
If app want to add customized item, use enum value after EWK_CONTEXT_MENU_ITEM_BASE_APPLICATION_TAG |
Enumeration that provides an option to policy navigation types.
enum Ewk_Cache_Model |
Enumeration that contains option for the cache model.
enum Ewk_Error_Code |
Enumeration that provides an option to error codes.
enum Ewk_Find_Options |
Enumeration that provides the option to find text.
Enum values used to specify search options.
It contains enum values used to specify search options.
enum Ewk_Http_Method |
unsigned ewk_back_forward_list_count | ( | Ewk_Back_Forward_List * | list | ) |
Returns the length of the back-forward list including the current item.
[in] | list | The back-forward list instance |
0
in case of an error Ewk_Back_Forward_List_Item* ewk_back_forward_list_current_item_get | ( | const Ewk_Back_Forward_List * | list | ) |
Returns the current item in the list.
[in] | list | The back-forward list instance |
NULL
in case of an error Ewk_Back_Forward_List_Item* ewk_back_forward_list_item_at_index_get | ( | const Ewk_Back_Forward_List * | list, |
int | index | ||
) |
Returns the item at a given index relative to the current item.
[in] | list | The back-forward list instance |
[in] | index | The index of the item |
NULL
in case of an error const char* ewk_back_forward_list_item_original_url_get | ( | const Ewk_Back_Forward_List_Item * | item | ) |
Returns the original URL of the item.
[in] | item | The back-forward list item instance |
NULL
in case of an errorIncreases the reference count of the given object.
[in] | item | The back-forward list item instance to increase the reference count |
NULL
const char* ewk_back_forward_list_item_title_get | ( | const Ewk_Back_Forward_List_Item * | item | ) |
Returns the title of the item.
[in] | item | The back-forward list item instance |
NULL
in case of an errorvoid ewk_back_forward_list_item_unref | ( | Ewk_Back_Forward_List_Item * | item | ) |
Decreases the reference count of the given object, possibly freeing it.
When the reference count reaches 0
, the item is freed.
[in] | item | The back-forward list item instance to decrease the reference count |
const char* ewk_back_forward_list_item_url_get | ( | const Ewk_Back_Forward_List_Item * | item | ) |
Returns the URL of the item.
The returned URL may differ from the original URL (For example, if the page is redirected).
[in] | item | The back-forward list item instance |
NULL
in case of an errorEina_List* ewk_back_forward_list_n_back_items_copy | ( | const Ewk_Back_Forward_List * | list, |
int | limit | ||
) |
Creates a list containing the items preceding the current item limited by limit.
The Ewk_Back_Forward_List_Item
elements are located in the result list starting with the oldest one.
If limit is equal to -1
all the items preceding the current item are returned.
[in] | list | The back-forward list instance |
[in] | limit | The number of items to retrieve |
Eina_List
containing Ewk_Back_Forward_List_Item
elements,NULL
in case of an errorEina_List* ewk_back_forward_list_n_forward_items_copy | ( | const Ewk_Back_Forward_List * | list, |
int | limit | ||
) |
Creates the list containing the items following the current item limited by limit.
The Ewk_Back_Forward_List_Item
elements are located in the result list starting with the oldest one.
If limit is equal to -1
all the items preceding the current item are returned.
[in] | list | The back-forward list instance |
[in] | limit | The number of items to retrieve |
Eina_List
containing Ewk_Back_Forward_List_Item
elements,NULL
in case of an error,Ewk_Back_Forward_List_Item* ewk_back_forward_list_next_item_get | ( | const Ewk_Back_Forward_List * | list | ) |
Returns the item that follows the current item in the list.
[in] | list | The back-forward list instance |
NULL
in case of an error Ewk_Back_Forward_List_Item* ewk_back_forward_list_previous_item_get | ( | const Ewk_Back_Forward_List * | list | ) |
Returns the item that precedes the current item in the list.
[in] | list | The back-forward list instance |
NULL
in case of an error Ewk_Cache_Model ewk_context_cache_model_get | ( | const Ewk_Context * | context | ) |
Returns the cache model type.
[in] | context | The context object |
Eina_Bool ewk_context_cache_model_set | ( | Ewk_Context * | context, |
Ewk_Cache_Model | model | ||
) |
Requests to set the cache model.
[in] | context | The context object |
[in] | model | The cache model |
EINA_TRUE
on success,EINA_FALSE
Ewk_Cookie_Manager* ewk_context_cookie_manager_get | ( | const Ewk_Context * | context | ) |
Gets the cookie manager instance for this context.
[in] | context | The context object to query |
NULL
in case of failure Eina_Bool ewk_context_menu_item_append | ( | Ewk_Context_Menu * | menu, |
Ewk_Context_Menu_Item_Tag | tag, | ||
const char * | title, | ||
const char * | icon_file, | ||
Eina_Bool | enabled | ||
) |
Adds the context menu item to the context menu object.
[in] | menu | The context menu object |
[in] | tag | The tag of the context menu item |
[in] | title | The title of the context menu item |
[in] | icon_file | The path of the icon to be set on the context menu item |
[in] | enabled | If true the context menu item is enabled,otherwise false |
EINA_TRUE
on a successful request,EINA_FALSE
on failure Eina_Bool ewk_context_menu_item_append_as_action | ( | Ewk_Context_Menu * | menu, |
Ewk_Context_Menu_Item_Tag | tag, | ||
const char * | title, | ||
Eina_Bool | enabled | ||
) |
Adds the context menu item to the context menu object.
[in] | menu | The context menu object |
[in] | tag | The tag of the context menu item |
[in] | title | The title of the context menu item |
[in] | enabled | If true the context menu item is enabled,otherwise false |
EINA_TRUE
on a successful request,EINA_FALSE
on failure unsigned ewk_context_menu_item_count | ( | Ewk_Context_Menu * | menu | ) |
Counts the number of context menu items.
[in] | menu | The context menu object |
const char* ewk_context_menu_item_image_url_get | ( | Ewk_Context_Menu_Item * | item | ) |
Returns the image URL string of the context menu item.
[in] | item | The context menu item object |
0
on failure const char* ewk_context_menu_item_link_url_get | ( | Ewk_Context_Menu_Item * | item | ) |
Returns the link URL string of the context menu item.
[in] | item | The context menu item object |
0
on failure Eina_Bool ewk_context_menu_item_remove | ( | Ewk_Context_Menu * | menu, |
Ewk_Context_Menu_Item * | item | ||
) |
Removes the context menu item from the context menu object.
[in] | menu | The context menu object |
[in] | item | The context menu item to remove |
EINA_TRUE
on a successful request,EINA_FALSE
on failure Returns the tag of the context menu item.
[in] | item | The context menu item object |
Ewk_Context_Menu_Item* ewk_context_menu_nth_item_get | ( | Ewk_Context_Menu * | menu, |
unsigned int | n | ||
) |
Returns the nth item in a context menu.
[in] | menu | The context menu object |
[in] | n | The number of the item |
void ewk_context_preferred_languages_set | ( | Eina_List * | languages | ) |
Sets the list of preferred languages.
This function sets the list of preferred langages.
This list will be used to build the "Accept-Language" header that will be included in the network requests.
The client can pass NULL
for languages to clear what is set before.
[in] | languages | The list of preferred languages (char* as data), otherwise NULL |
void ewk_context_resource_cache_clear | ( | Ewk_Context * | context | ) |
Clears HTTP caches in the local storage and all resources cached in memory
such as images, CSS, JavaScript, XSL, and fonts for context.
[in] | context | The context object to clear all resource caches |
void ewk_cookie_manager_accept_policy_async_get | ( | const Ewk_Cookie_Manager * | manager, |
Ewk_Cookie_Manager_Policy_Async_Get_Cb | callback, | ||
void * | data | ||
) |
Gets the cookie acceptance policy of manager asynchronously.
By default, only cookies set by the main document loaded are accepted.
[in] | manager | The cookie manager to query |
[in] | callback | The function to call when the policy is received |
[in] | data | The user data (may be NULL ) |
void ewk_cookie_manager_accept_policy_set | ( | Ewk_Cookie_Manager * | manager, |
Ewk_Cookie_Accept_Policy | policy | ||
) |
Sets policy as the cookie acceptance policy for manager.
By default, only cookies set by the main document loaded are accepted.
[in] | manager | The cookie manager to update |
[in] | policy | A Ewk_Cookie_Accept_Policy |
void ewk_cookie_manager_cookies_clear | ( | Ewk_Cookie_Manager * | manager | ) |
Deletes all the cookies of manager.
[in] | manager | The cookie manager to update |
Eina_Bool ewk_error_cancellation_get | ( | const Ewk_Error * | error | ) |
Query if error should be treated as a cancellation.
[in] | error | The error object to query |
EINA_TRUE
if this error should be treated as a cancellationEINA_FALSE
int ewk_error_code_get | ( | const Ewk_Error * | error | ) |
Query the error code.
[in] | error | The error object to query |
const char* ewk_error_description_get | ( | const Ewk_Error * | error | ) |
Query description for this error.
[in] | error | The error object to query |
NULL
. This pointer isconst char* ewk_error_url_get | ( | const Ewk_Error * | error | ) |
Query failing URL for this error.
URL that failed loading.
[in] | error | The error object to query |
NULL
. This pointer isint ewk_init | ( | void | ) |
Initializes WebKit's instance.
0
on failure const char* ewk_policy_decision_cookie_get | ( | Ewk_Policy_Decision * | policy_decision | ) |
Returns a cookie from the Policy Decision object.
[in] | policy_decision | The policy decision object |
const char* ewk_policy_decision_host_get | ( | Ewk_Policy_Decision * | policy_decision | ) |
Returns a host from the Policy Decision object.
[in] | policy_decision | The policy decision object |
const char* ewk_policy_decision_http_method_get | ( | Ewk_Policy_Decision * | policy_decision | ) |
Returns an HTTP method from the Policy Decision object.
[in] | policy_decision | The policy decision object |
Eina_Bool ewk_policy_decision_ignore | ( | Ewk_Policy_Decision * | policy_decision | ) |
Ignores the action which triggers this decision.
[in] | policy_decision | The policy decision object |
EINA_TRUE
on success,EINA_FALSE
on failure Ewk_Policy_Navigation_Type ewk_policy_decision_navigation_type_get | ( | Ewk_Policy_Decision * | policy_decision | ) |
Returns a navigation type from the Policy Decision object.
[in] | policy_decision | The policy decision object |
const Eina_Hash* ewk_policy_decision_response_headers_get | ( | Ewk_Policy_Decision * | policy_decision | ) |
Returns HTTP headers for response data from the Policy Decision object.
[in] | policy_decision | The policy decision object |
NULL
on failure const char* ewk_policy_decision_response_mime_get | ( | Ewk_Policy_Decision * | policy_decision | ) |
Returns a MIME type for response data from the Policy Decision object.
[in] | policy_decision | policy decision object |
int ewk_policy_decision_response_status_code_get | ( | Ewk_Policy_Decision * | policy_decision | ) |
Returns an HTTP status code from the Policy Decision object.
[in] | policy_decision | The policy decision object |
const char* ewk_policy_decision_scheme_get | ( | Ewk_Policy_Decision * | policy_decision | ) |
Returns a scheme from the Policy Decision object.
[in] | policy_decision | The policy decision object |
Ewk_Policy_Decision_Type ewk_policy_decision_type_get | ( | const Ewk_Policy_Decision * | policy_decision | ) |
Returns a policy type from the Policy Decision object.
[in] | policy_decision | The policy decision object |
const char* ewk_policy_decision_url_get | ( | Ewk_Policy_Decision * | policy_decision | ) |
Returns a URL from the Policy Decision object.
[in] | policy_decision | The policy decision object |
Eina_Bool ewk_policy_decision_use | ( | Ewk_Policy_Decision * | policy_decision | ) |
Accepts the action which triggers this decision.
[in] | policy_decision | The policy decision object |
EINA_TRUE
on success,EINA_FALSE
on failure Eina_Bool ewk_settings_auto_fitting_get | ( | const Ewk_Settings * | settings | ) |
Returns the auto fit status.
[in] | settings | The settings object to fit to width |
EINA_TRUE
if auto fit is enabled,EINA_FALSE
Eina_Bool ewk_settings_auto_fitting_set | ( | Ewk_Settings * | settings, |
Eina_Bool | enable | ||
) |
Requests setting of auto fit.
[in] | settings | The settings object to fit to width |
[in] | enable | If true the settings object is fit to width,otherwise false |
EINA_TRUE
on success,EINA_FALSE
on failure int ewk_settings_default_font_size_get | ( | const Ewk_Settings * | settings | ) |
Returns the default font size.
[in] | settings | The settings object to get the default font size |
0
on failure Eina_Bool ewk_settings_default_font_size_set | ( | Ewk_Settings * | settings, |
int | size | ||
) |
Sets the default font size.
By default, the default font size is 16
.
[in] | settings | The settings object to set the default font size |
[in] | size | A new default font size to set |
EINA_TRUE
on success,EINA_FALSE
on failure const char* ewk_settings_default_text_encoding_name_get | ( | const Ewk_Settings * | settings | ) |
Gets the default text encoding name.
The returned string is guaranteed to be stringshared.
[in] | settings | The settings object to query the default text encoding name |
Eina_Bool ewk_settings_default_text_encoding_name_set | ( | Ewk_Settings * | settings, |
const char * | encoding | ||
) |
Sets the default text encoding name.
[in] | settings | The settings object to set the default text encoding name |
[in] | encoding | The default text encoding name |
EINA_TRUE
on success,EINA_FALSE
on failure Eina_Bool ewk_settings_javascript_enabled_get | ( | const Ewk_Settings * | settings | ) |
Returns whether JavaScript can be executable.
[in] | settings | The settings object to query if JavaScript can be executed |
EINA_TRUE
if JavaScript can be executed,EINA_FALSE
if not or on failure Eina_Bool ewk_settings_javascript_enabled_set | ( | Ewk_Settings * | settings, |
Eina_Bool | enable | ||
) |
Enables/disables JavaScript executing.
[in] | settings | The settings object to set JavaScript executing |
[in] | enable | If EINA_TRUE JavaScript executing is enabled,otherwise EINA_FALSE to disable it |
EINA_TRUE
on success,EINA_FALSE
on failure Eina_Bool ewk_settings_loads_images_automatically_get | ( | const Ewk_Settings * | settings | ) |
Returns whether images can be loaded automatically.
[in] | settings | The settings object to get auto loading of images |
EINA_TRUE
if images are loaded automatically,EINA_FALSE
if not or on failure Eina_Bool ewk_settings_loads_images_automatically_set | ( | Ewk_Settings * | settings, |
Eina_Bool | automatic | ||
) |
Enables/disables auto loading of images.
[in] | settings | The settings object to set auto loading of images |
[in] | automatic | If EINA_TRUE auto loading of images is enabled,otherwise EINA_FALSE to disable it |
EINA_TRUE
on success,EINA_FALSE
on failure Eina_Bool ewk_settings_private_browsing_enabled_get | ( | const Ewk_Settings * | settings | ) |
Enables/disables private browsing.
[in] | settings | The settings object to query if private browsing is enabled |
EINA_TRUE
if private browsing is enabled,EINA_FALSE
if not or on failure Eina_Bool ewk_settings_private_browsing_enabled_set | ( | Ewk_Settings * | settings, |
Eina_Bool | enable | ||
) |
Requests to enable/disable private browsing.
[in] | settings | The settings object to set private browsing |
[in] | enable | If EINA_TRUE private browsing is enabledotherwise EINA_FALSE to disable it |
EINA_TRUE
on success,EINA_FALSE
on failure Eina_Bool ewk_settings_scripts_can_open_windows_get | ( | const Ewk_Settings * | settings | ) |
Returns whether the scripts can open new windows.
[in] | settings | The settings object to query whether the scripts can open new windows |
EINA_TRUE
if the scripts can open new windowsEINA_FALSE
if not or on failure (scripts are disabled) Eina_Bool ewk_settings_scripts_can_open_windows_set | ( | Ewk_Settings * | settings, |
Eina_Bool | enable | ||
) |
Enables/disables if the scripts can open new windows.
By default, the scripts can open new windows.
[in] | settings | The settings object to set if the scripts can open new windows |
[in] | enable | If EINA_TRUE the scripts can open new windowsotherwise EINA_FALSE if not |
EINA_TRUE
on success,EINA_FALSE
on failure (scripts are disabled) int ewk_shutdown | ( | void | ) |
Decreases a reference count of WebKit's instance, possibly destroying it.
If the reference count reaches 0
, WebKit's instance is destroyed.
Evas_Object* ewk_view_add | ( | Evas * | e | ) |
Creates a new EFL WebKit view object.
[in] | e | The canvas object where to create the view object |
NULL
on failure Eina_Bool ewk_view_back | ( | Evas_Object * | o | ) |
Asks the main frame to navigate back in history.
[in] | o | The view object to navigate back |
EINA_TRUE
on success,EINA_FALSE
void ewk_view_back_forward_list_clear | ( | const Evas_Object * | o | ) |
Clears the back-forward list of a page.
[in] | o | The view object to clear the back-forward list |
Ewk_Back_Forward_List* ewk_view_back_forward_list_get | ( | const Evas_Object * | o | ) |
Gets the back-forward list associated with this view.
The returned instance is unique for this view and thus multiple calls
to this function with the same view as a parameter returns the same handle.
This handle is alive while the view is alive, thus one might want
to listen for EVAS_CALLBACK_DEL on a given view (o) to know
when to stop using the returned handle.
[in] | o | The view object to get the back-forward navigation list |
Checks whether it is possible to navigate backwards one item in history.
[in] | o | The view object to query if backward navigation is possible |
EINA_TRUE
if it is possible to navigate backwards in history,EINA_FALSE
Eina_Bool ewk_view_contents_set | ( | Evas_Object * | o, |
const char * | contents, | ||
size_t | contents_size, | ||
char * | mime_type, | ||
char * | encoding, | ||
char * | base_uri | ||
) |
Requests loading the given contents by MIME type into the view object.
[in] | o | The view object to load |
[in] | contents | The content to load |
[in] | contents_size | The size of contents (in bytes) |
[in] | mime_type | The type of contents, if 0 is given "text/html" is assumed |
[in] | encoding | The encoding for contents, if 0 is given "UTF-8" is assumed |
[in] | base_uri | The base URI to use for relative resources, may be 0 ,if provided must be an absolute URI |
EINA_TRUE
on a successful request,EINA_FALSE
on errors Eina_Bool ewk_view_contents_size_get | ( | const Evas_Object * | o, |
Evas_Coord * | width, | ||
Evas_Coord * | height | ||
) |
Gets the last known content's size.
[in] | o | The view object to get the content's size |
[in] | width | The width pointer to store the content's size width, may be 0 |
[in] | height | The height pointer to store the content's size height, may be 0 |
EINA_TRUE
on success,EINA_FALSE
on failure andEwk_Context* ewk_view_context_get | ( | const Evas_Object * | o | ) |
Gets the Ewk_Context of this view.
[in] | o | The view object to get the Ewk_Context |
NULL
on failure Eina_Bool ewk_view_forward | ( | Evas_Object * | o | ) |
Asks the main frame to navigate forward in history.
[in] | o | The view object to navigate forward |
EINA_TRUE
on success,EINA_FALSE
Checks whether it is possible to navigate forwards one item in history.
[in] | o | The view object to query if forward navigation is possible |
EINA_TRUE
if it is possible to navigate forwards in history,EINA_FALSE
Exits fullscreen when the back key is pressed.
[in] | o | The view object to exit the fullscreen mode |
EINA_TRUE
on success,EINA_FALSE
double ewk_view_load_progress_get | ( | const Evas_Object * | o | ) |
Gets the current load progress of the page.
The progress estimation from 0.0
to 1.0
.
[in] | o | The view object to get the current progress |
0.0
to 1.0
,-1.0
on failure Eina_Bool ewk_view_reload | ( | Evas_Object * | o | ) |
Asks the main frame to reload the current document.
[in] | o | The view object to reload the current document |
EINA_TRUE
on success,EINA_FALSE
void ewk_view_resume | ( | Evas_Object * | o | ) |
Resumes the operation associated with the view object after calling ewk_view_suspend().
[in] | o | The view object to resume |
double ewk_view_scale_get | ( | const Evas_Object * | o | ) |
Gets the current scale factor of the page.
It returns the previous scale factor after ewk_view_scale_set() is called immediately
until the scale factor of the page is really changed.
[in] | o | The view object to get the scale factor of |
-1.0
on failure Eina_Bool ewk_view_scale_set | ( | Evas_Object * | o, |
double | scale_factor, | ||
int | cx, | ||
int | cy | ||
) |
Scales the current page, centered at the given point.
[in] | o | The view object to set the zoom level |
[in] | scale_factor | A new level to set |
[in] | cx | The x value of the center coordinate |
[in] | cy | The y value of the center coordinate |
EINA_TRUE
on success,Eina_Bool ewk_view_script_execute | ( | Evas_Object * | o, |
const char * | script, | ||
Ewk_View_Script_Execute_Cb | callback, | ||
void * | user_data | ||
) |
Requests the execution of the given script.
NULL
for the callback parameter.NULL
might be used for the callback parameter.[in] | o | The view object to execute the script |
[in] | script | The JavaScript to execute |
[in] | callback | The result callback |
[in] | user_data | The user data |
EINA_TRUE
on success,EINA_FALSE
void ewk_view_scroll_by | ( | Evas_Object * | o, |
int | dx, | ||
int | dy | ||
) |
Scrolls the webpage of view by dx and dy.
[in] | o | The view object to scroll |
[in] | dx | The horizontal offset to scroll |
[in] | dy | The vertical offset to scroll |
Eina_Bool ewk_view_scroll_pos_get | ( | Evas_Object * | o, |
int * | x, | ||
int * | y | ||
) |
Gets the current scroll position of the given view.
[in] | o | The view object to get the current scroll position |
[in] | x | The pointer to store the horizontal position, may be 0 |
[in] | y | The pointer to store the vertical position, may be 0 |
EINA_TRUE
on success,EINA_FALSE
andEina_Bool ewk_view_scroll_set | ( | Evas_Object * | o, |
int | x, | ||
int | y | ||
) |
Sets an absolute scroll of the given view.
Both values are from zero to the contents size minus the viewport size.
[in] | o | The view object to scroll |
[in] | x | The horizontal position to scroll |
[in] | y | The vertical position to scroll |
EINA_TRUE
on success,EINA_FALSE
Ewk_Settings* ewk_view_settings_get | ( | const Evas_Object * | o | ) |
Gets the Ewk_Settings of this view.
[in] | o | The view object to get the Ewk_Settings |
NULL
on failure Eina_Bool ewk_view_stop | ( | Evas_Object * | o | ) |
Asks the main frame to stop loading.
[in] | o | The view object to stop loading |
EINA_TRUE
on success,EINA_FALSE
void ewk_view_suspend | ( | Evas_Object * | o | ) |
Suspends the operation associated with the view object.
[in] | o | The view object to suspend |
Eina_Bool ewk_view_text_find | ( | Evas_Object * | o, |
const char * | text, | ||
Ewk_Find_Options | options, | ||
unsigned | max_match_count | ||
) |
Searches and highlights the given string in the document.
[in] | o | The view object to find text |
[in] | text | The text to find |
[in] | options | The options to find |
[in] | max_match_count | The maximum match count to find, unlimited if 0 |
EINA_TRUE
on success,const char* ewk_view_title_get | ( | const Evas_Object * | o | ) |
Gets the current title of the main frame.
It returns an internal string that should not be modified.
The string is guaranteed to be stringshared.
[in] | o | The view object to get the current title |
NULL
on failure const char* ewk_view_url_get | ( | const Evas_Object * | o | ) |
Returns the current URL string of the view object.
It returns an internal string that should not be modified.
The string is guaranteed to be stringshared.
[in] | o | The view object to get the current URL |
NULL
on failure Eina_Bool ewk_view_url_request_set | ( | Evas_Object * | o, |
const char * | url, | ||
Ewk_Http_Method | method, | ||
Eina_Hash * | headers, | ||
const char * | body | ||
) |
Requests loading of the given request data.
[in] | o | The view object to load |
[in] | url | The uniform resource identifier to load |
[in] | method | The http method |
[in] | headers | The http headers |
[in] | body | The http body data |
EINA_TRUE
on a successful request,EINA_FALSE
on failure Eina_Bool ewk_view_url_set | ( | Evas_Object * | o, |
const char * | url | ||
) |
Asks the object to load the given URL.
[in] | o | The view object to load url |
[in] | url | The uniform resource identifier to load |
EINA_TRUE
if o is valid, irrespective of load,EINA_FALSE
on failure const char* ewk_view_user_agent_get | ( | const Evas_Object * | o | ) |
Returns the user agent string.
[in] | o | The view object to get the user agent string |
Eina_Bool ewk_view_user_agent_set | ( | Evas_Object * | o, |
const char * | user_agent | ||
) |
Requests to set the user agent string.
[in] | o | The view object to set the user agent string |
[in] | user_agent | The user agent string to set, otherwise NULL to restore the default one |
EINA_TRUE
on success,EINA_FALSE
on failure