Tizen Native API
5.5
|
The WebView API provides functions to display web pages and control web pages.
Required Header
#include <EWebKit.h>
Overview
The WebView API provides functions to display web pages and control web pages. It is based on the Chromium engine, which is one of the most popular layout engines to render web pages.
Smart object
It is Chromium main smart object. This object provides view related APIs of Chromium 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 |
geolocation,permission,request | Ewk_Geolocation_Permission_Request* | Requests geolocation permission |
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 |
did,not,allow,script | void | Javascript did not allowed |
Functions | |
Ewk_Autofill_Profile * | ewk_autofill_profile_new (void) |
Creates a new profile. | |
void | ewk_autofill_profile_delete (Ewk_Autofill_Profile *profile) |
Deletes a given profile. | |
void | ewk_autofill_profile_data_set (Ewk_Autofill_Profile *profile, Ewk_Autofill_Profile_Data_Type name, const char *value) |
Sets the data in the profile created by ewk_autofill_profile_new. | |
unsigned | ewk_autofill_profile_id_get (Ewk_Autofill_Profile *profile) |
Gets the id attribute value from a given profile. | |
const char * | ewk_autofill_profile_data_get (Ewk_Autofill_Profile *profile, Ewk_Autofill_Profile_Data_Type name) |
Gets the attribute value from a given profile. | |
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_application_cache_delete_all (Ewk_Context *context) |
Requests for deleting all web application caches. | |
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. | |
Eina_Bool | ewk_context_form_autofill_profile_add (Ewk_Context *context, Ewk_Autofill_Profile *profile) |
Saves the created profile into permanent storage. | |
Ewk_Autofill_Profile * | ewk_context_form_autofill_profile_get (Ewk_Context *context, unsigned id) |
Gets the existing profile for given index. | |
Eina_List * | ewk_context_form_autofill_profile_get_all (Ewk_Context *context) |
Gets a list of all existing profiles. | |
Eina_Bool | ewk_context_form_autofill_profile_set (Ewk_Context *context, unsigned id, Ewk_Autofill_Profile *profile) |
Sets the given profile for the given id. | |
Eina_Bool | ewk_context_form_autofill_profile_remove (Ewk_Context *context, unsigned id) |
Removes Autofill Form profile completely. | |
void | ewk_context_form_candidate_data_delete_all (Ewk_Context *context) |
Deletes all candidate form data from DB. | |
void | ewk_context_form_password_data_delete_all (Ewk_Context *context) |
Deletes whole password data from DB. | |
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. | |
Evas_Object * | ewk_context_icon_database_icon_object_add (Ewk_Context *context, const char *uri, Evas *canvas) |
Requests to get image representing the given URL. | |
Eina_Bool | ewk_context_web_indexed_database_delete_all (Ewk_Context *context) |
Requests for deleting all web indexed databases. | |
Eina_Bool | ewk_context_web_storage_delete_all (Ewk_Context *context) |
Deletes web storage. | |
void | ewk_context_intercept_request_callback_set (Ewk_Context *ewk_context, Ewk_Context_Intercept_Request_Callback callback, void *user_data) |
Sets Ewk_Context_Intercept_Request_Callback. | |
Eina_Bool | ewk_context_background_music_get (Ewk_Context *context) |
Gets the enabled state of background music. | |
Eina_Bool | ewk_context_background_music_set (Ewk_Context *context, Eina_Bool enable) |
Sets the enabled state of background music. | |
Eina_Bool | ewk_context_block_multimedia_on_call_get (Ewk_Context *context) |
Gets the enabled state of blocking multimedia on call. | |
Eina_Bool | ewk_context_block_multimedia_on_call_set (Ewk_Context *context, Eina_Bool enable) |
Sets the enabled state of blocking multimedia on call. | |
Eina_Bool | ewk_context_rotation_lock_get (Ewk_Context *context) |
Gets the enabled state of rotation lock. | |
Eina_Bool | ewk_context_rotation_lock_set (Ewk_Context *context, Eina_Bool enable) |
Sets the enabled state of rotation lock. | |
Eina_Bool | ewk_context_sound_overlap_get (Ewk_Context *context) |
Gets the enabled state of sound overlap. | |
Eina_Bool | ewk_context_sound_overlap_set (Ewk_Context *context, Eina_Bool enable) |
Sets the enabled state of sound overlap. | |
unsigned | ewk_context_menu_item_count (Ewk_Context_Menu *menu) |
Counts the number of the context menu item. | |
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 context menu item. | |
const char * | ewk_context_menu_item_link_url_get (Ewk_Context_Menu_Item *item) |
Returns the link url string of context menu item. | |
const char * | ewk_context_menu_item_image_url_get (Ewk_Context_Menu_Item *item) |
Returns the image url string of 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. | |
Eina_Bool | ewk_cookie_manager_file_scheme_cookies_allow_get (Ewk_Cookie_Manager *manager) |
Queries if the cookie manager allows cookies for file scheme URLs. | |
void | ewk_cookie_manager_file_scheme_cookies_allow_set (Ewk_Cookie_Manager *manager, Eina_Bool allow) |
Sets whether cookie manager allows cookies for file scheme URLs. | |
void | ewk_cookie_manager_persistent_storage_set (Ewk_Cookie_Manager *manager, const char *path, Ewk_Cookie_Persistent_Storage storage) |
Sets the path where non-session cookies are stored persistently using storage as the format to read/write the cookies. | |
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. | |
const Ewk_Security_Origin * | ewk_geolocation_permission_request_origin_get (const Ewk_Geolocation_Permission_Request *request) |
Requests for getting origin of geolocation permission request. | |
const char * | ewk_intercept_request_url_get (Ewk_Intercept_Request *intercept_request) |
Returns request url from Intercept Request object. | |
const char * | ewk_intercept_request_http_method_get (Ewk_Intercept_Request *intercept_request) |
Returns request method from Intercept Request object. | |
const Eina_Hash * | ewk_intercept_request_headers_get (Ewk_Intercept_Request *intercept_request) |
Returns request headers from Intercept Request object. | |
Eina_Bool | ewk_intercept_request_ignore (Ewk_Intercept_Request *intercept_request) |
Ignores request so engine will handle it normally. | |
Eina_Bool | ewk_intercept_request_response_set (Ewk_Intercept_Request *intercept_request, const char *headers, const char *body, size_t length) |
Writes whole response with headers at once. | |
Eina_Bool | ewk_intercept_request_response_status_set (Ewk_Intercept_Request *intercept_request, int status_code, const char *custom_status_text) |
Sets status code and status text of response for intercepted request. | |
Eina_Bool | ewk_intercept_request_response_header_add (Ewk_Intercept_Request *intercept_request, const char *field_name, const char *field_value) |
Adds HTTP header to response for intercepted request. | |
Eina_Bool | ewk_intercept_request_response_header_map_add (Ewk_Intercept_Request *intercept_request, const Eina_Hash *headers) |
Adds HTTP headers to response for intercepted request. | |
Eina_Bool | ewk_intercept_request_response_body_set (Ewk_Intercept_Request *intercept_request, const char *body, size_t length) |
Writes whole response body at once. | |
Eina_Bool | ewk_intercept_request_response_write_chunk (Ewk_Intercept_Request *intercept_request, const char *chunk, size_t length) |
Writes a part of response body. | |
int | ewk_init (void) |
Initializes Chromium's instance. | |
int | ewk_shutdown (void) |
Decreases a reference count of Chromium's instance, possibly destroying it. | |
const char * | ewk_manifest_short_name_get (Ewk_View_Request_Manifest *manifest) |
Get the short name of the manifest. | |
const char * | ewk_manifest_name_get (Ewk_View_Request_Manifest *manifest) |
Get the name of the manifest. | |
const char * | ewk_manifest_start_url_get (Ewk_View_Request_Manifest *manifest) |
Get the start url of the manifest. | |
Ewk_View_Orientation_Type | ewk_manifest_orientation_type_get (Ewk_View_Request_Manifest *manifest) |
Get the orientation type of the manifest. | |
Ewk_View_Web_Display_Mode | ewk_manifest_web_display_mode_get (Ewk_View_Request_Manifest *manifest) |
Get the web display mode of the manifest. | |
Eina_Bool | ewk_manifest_theme_color_get (Ewk_View_Request_Manifest *manifest, uint8_t *r, uint8_t *g, uint8_t *b, uint8_t *a) |
Get the theme color of the manifest. | |
Eina_Bool | ewk_manifest_background_color_get (Ewk_View_Request_Manifest *manifest, uint8_t *r, uint8_t *g, uint8_t *b, uint8_t *a) |
Get the background color of the manifest. | |
size_t | ewk_manifest_icons_count_get (Ewk_View_Request_Manifest *manifest) |
Get the count of icon of the manifest. | |
const char * | ewk_manifest_icons_src_get (Ewk_View_Request_Manifest *manifest, size_t number) |
Get the src of icon of the manifest. | |
const char * | ewk_manifest_icons_type_get (Ewk_View_Request_Manifest *manifest, size_t number) |
Get the type of icon of the manifest. | |
size_t | ewk_manifest_icons_sizes_count_get (Ewk_View_Request_Manifest *manifest, size_t number) |
Get the count of the icon's sizes. | |
int | ewk_manifest_icons_width_get (Ewk_View_Request_Manifest *manifest, size_t number, size_t sizes_number) |
Get the width of icon of the manifest. | |
int | ewk_manifest_icons_height_get (Ewk_View_Request_Manifest *manifest, size_t number, size_t sizes_number) |
Get the height of icon of the manifest. | |
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) |
Return 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_Stringshare * | ewk_security_origin_host_get (const Ewk_Security_Origin *origin) |
Requests for getting host of security origin. | |
Eina_Stringshare * | ewk_security_origin_protocol_get (const Ewk_Security_Origin *origin) |
Requests for getting host of security origin. | |
Eina_Bool | ewk_settings_autofill_password_form_enabled_set (Ewk_Settings *settings, Eina_Bool enable) |
Requests enable/disable password form autofill. | |
Eina_Bool | ewk_settings_form_candidate_data_enabled_set (Ewk_Settings *settings, Eina_Bool enable) |
Requests enable/disable form candidate data for autofill. | |
Eina_Bool | ewk_settings_form_profile_data_enabled_set (Ewk_Settings *settings, Eina_Bool enable) |
Enables/disables form autofill profile feature. | |
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_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. | |
Eina_Bool | ewk_settings_viewport_meta_tag_set (Ewk_Settings *settings, Eina_Bool enable) |
Eina_Bool | ewk_settings_viewport_meta_tag_get (const Ewk_Settings *settings) |
Eina_Bool | ewk_view_visibility_set (Evas_Object *o, Eina_Bool enable) |
Request to set the current page's visibility. | |
void | ewk_view_orientation_send (Evas_Object *o, int orientation) |
Sends the orientation of the device. | |
const char * | ewk_view_text_selection_text_get (Evas_Object *o) |
Returns the selection text. | |
Eina_Bool | ewk_view_text_selection_clear (Evas_Object *o) |
Clears the current selection. | |
Evas_Object * | ewk_view_add (Evas *e) |
Creates a new EFL Chromium view object. | |
Evas_Object * | ewk_view_add_in_incognito_mode (Evas *e) |
Creates a new EFL web view object in incognito mode. | |
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. | |
const char * | ewk_view_original_url_get (const Evas_Object *o) |
Returns the original 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. | |
Eina_Bool | ewk_view_html_string_load (Evas_Object *o, const char *html, const char *base_url, const char *unreachable_url) |
Loads the specified html string as the content of the view. | |
Eina_Bool | ewk_view_javascript_message_handler_add (Evas_Object *o, Ewk_View_Script_Message_Cb callback, const char *name) |
Injects the supplied javascript message handler into webview. | |
Eina_Bool | ewk_view_evaluate_javascript (Evas_Object *o, const char *name, const char *result) |
Requests the execution of given name & result to the JavaScript runtime. | |
Eina_Bool | ewk_view_focus_set (const Evas_Object *o, Eina_Bool focused) |
Requests to set or unset a web view as the currently focused one. | |
Eina_Bool | ewk_view_focus_get (const Evas_Object *o) |
Checks whether a web view has the focus. | |
void | ewk_view_request_manifest (Evas_Object *o, Ewk_View_Request_Manifest_Callback callback, void *user_data) |
Requests the manifest data of current's page. | |
Typedefs | |
typedef enum _Ewk_Autofill_Profile_Data_Type | Ewk_Autofill_Profile_Data_Type |
Enumeration that creates a type name for the Ewk_Autofill_Profile_Data_Type. | |
typedef struct _Ewk_Autofill_Profile | Ewk_Autofill_Profile |
The structure type that creates a type name for Ewk_Autofill_Profile. | |
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 struct Ewk_Context | Ewk_Context |
The structure type that creates a type name for Ewk_Context. | |
typedef enum _Ewk_Cache_Model | Ewk_Cache_Model |
The structure type that creates a type name for Ewk_Cache_Model. | |
typedef void(* | Ewk_Context_Intercept_Request_Callback )(Ewk_Context *ewk_context, Ewk_Intercept_Request *intercept_request, void *user_data) |
Callback for intercept request feature. | |
typedef Ewk_Context_Intercept_Request_Callback | Ewk_Context_Intercept_Request_Cancel_Callback |
Sets Ewk_Context_Intercept_Request_Cancel_Callback. | |
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_Cookie_Persistent_Storage | Ewk_Cookie_Persistent_Storage |
The enum type that creates a type name for Ewk_Cookie_Persistent_Storage. | |
typedef struct _Ewk_Error | Ewk_Error |
The structure type that creates a type name for Ewk_Error. | |
typedef struct _Ewk_Geolocation_Permission_Request | Ewk_Geolocation_Permission_Request |
The structure type that creates a type name for Ewk_Geolocation_Permission_Request. | |
typedef struct _Ewk_Intercept_Request | Ewk_Intercept_Request |
Handle for intercepted request. Used for getting information about request and writing custom response. | |
typedef struct _Ewk_View_Request_Manifest | Ewk_View_Request_Manifest |
Get for web page manifest. Used for getting information about the manifest of web page. | |
typedef enum _Ewk_View_Orientation_Type | Ewk_View_Orientation_Type |
Enumeration that creates a type name for the _Ewk_View_Orientation_Type. | |
typedef enum _Ewk_View_Web_Display_Mode | Ewk_View_Web_Display_Mode |
Enumeration that creates a type name for the _Ewk_View_Web_Display_Mode. | |
typedef enum _Ewk_Policy_Decision_Type | Ewk_Policy_Decision_Type |
Enumeration that creates a type name for the Ewk_Policy_Decision_Type. | |
typedef struct _Ewk_Policy_Decision | Ewk_Policy_Decision |
The structure type that creates a type name for Ewk_Policy_Decision. | |
typedef enum _Ewk_Policy_Navigation_Type | Ewk_Policy_Navigation_Type |
Enumeration that creates a type name for Ewk_Policy_Navigation_Type. | |
typedef struct _Ewk_Security_Origin | Ewk_Security_Origin |
The structure type that creates a type name for Ewk_Security_Origin. | |
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(). | |
typedef enum Ewk_Http_Method | Ewk_Http_Method |
Enumeration that creates a type name for the Ewk_Http_Method. | |
typedef enum Ewk_Find_Options | Ewk_Find_Options |
Enumeration that creates a type name for the Ewk_Find_Options. | |
typedef struct _Ewk_Script_Message | Ewk_Script_Message |
A struct that creates a type name for the Ewk_Script_Message. | |
typedef void(* | Ewk_View_Script_Message_Cb )(Evas_Object *o, Ewk_Script_Message message) |
Callback for ewk_view_javascript_message_handler_add(). | |
typedef void(* | Ewk_View_Request_Manifest_Callback )(Evas_Object *o, Ewk_View_Request_Manifest *manifest, void *user_data) |
Callback invoked when requested manifest inform is responded. |
Typedef Documentation
typedef struct _Ewk_Autofill_Profile Ewk_Autofill_Profile |
The structure type that creates a type name for Ewk_Autofill_Profile.
- Since :
- 2.4
Enumeration that creates a type name for the Ewk_Autofill_Profile_Data_Type.
- Since :
- 2.4
typedef struct _Ewk_Back_Forward_List Ewk_Back_Forward_List |
The structure type that creates a type name for Ewk_Back_Forward_List.
- Since :
- 2.3
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.
- Since :
- 2.3
typedef enum _Ewk_Cache_Model Ewk_Cache_Model |
The structure type that creates a type name for Ewk_Cache_Model.
- Since :
- 2.3
typedef struct Ewk_Context Ewk_Context |
The structure type that creates a type name for Ewk_Context.
- Since :
- 2.3
typedef void(* Ewk_Context_Intercept_Request_Callback)(Ewk_Context *ewk_context, Ewk_Intercept_Request *intercept_request, void *user_data) |
Callback for intercept request feature.
Ewk_Context_Intercept_Request_Callback callback allows host application to intercept a resource request and write custom response.
- Warning:
- Callback is not called on UI thread, so user should be cautious when accessing their data also used on UI thread. No ewk api other than ewk_intercept_request_* api should be used in the callback.
- Remarks:
- Inside the callback user can use the following EWK API calls on a given Ewk_Intercept_Request instance to decide if request should be intercepted or handled normally:
- ewk_intercept_request_url_get
- ewk_intercept_request_http_method_get
- ewk_intercept_request_headers_get
To let engine handle the request normally, use ewk_intercept_request_ignore *inside* the callback. Using it later results in undefined behavior.
To respond to a request with a custom response, use ewk_intercept_request_response_set or ewk_intercept_request_response_body_set inside or outside the callback. Using it outside of the callback is advised for better responsiveness. If your responses take too much time to prepare, it would block handling other requests. You can also use ewk_intercept_request_response_write outside the callback to write response in chunks.
Handling a request is done after using either ewk_intercept_request_ignore, ewk_intercept_request_response_set, ewk_intercept_request_response_body_set, and in some cases after ewk_intercept_request_response_write_chunk.
Further EWK API calls on this Ewk_Intercept_Request instance result in undefined behavior.
Failing to call one of these functions results in leaking Ewk_Intercept_Request object.
- Since :
- 3.0
- Parameters:
-
[in] ewk_context Ewk_Context for which callback was set [in] intercept_request Intercept request object for reading request info and writing response data [in] user_data User data passed to ewk_context_intercept_request_callback_set
Sets Ewk_Context_Intercept_Request_Cancel_Callback.
Sets Ewk_Context_Intercept_Request_Cancel_Callback to give a chance to notify intercept resource request to client when url request is cancelled.
- Remarks:
- Pass NULL pointer as callback to reset current callback.
- Parameters:
-
[in] ewk_context Ewk_Context object to intercept requests [in] callback New callback, NULL resets current callback [in] user_data User data passed to callback
typedef struct _Ewk_Context_Menu Ewk_Context_Menu |
The structure type that creates a type name for _Ewk_Context_Menu.
- Since :
- 2.3
typedef struct _Ewk_Context_Menu_Item Ewk_Context_Menu_Item |
The structure type that creates a type name for _Ewk_Context_Menu_Item.
- Since :
- 2.3
typedef uint32_t Ewk_Context_Menu_Item_Tag |
The structure type that creates a type name for Ewk_Context_Menu_Item_Tag.
- Since :
- 2.3
typedef enum Ewk_Cookie_Accept_Policy Ewk_Cookie_Accept_Policy |
Enumeration that creates a type name for the Ewk_Cookie_Accept_Policy.
- Since :
- 2.3
typedef struct Ewk_Cookie_Manager Ewk_Cookie_Manager |
The structure type that creates a type name for Ewk_Cookie_Manager.
- Since :
- 2.3
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().
- Since :
- 2.3
- Parameters:
-
[in] policy A Ewk_Cookie_Accept_Policy [in] event_info The user data that will be passed when ewk_cookie_manager_accept_policy_async_get() is called
The enum type that creates a type name for Ewk_Cookie_Persistent_Storage.
- Since :
- 3.0
typedef struct _Ewk_Error Ewk_Error |
The structure type that creates a type name for Ewk_Error.
- Since :
- 2.3
typedef enum Ewk_Find_Options Ewk_Find_Options |
Enumeration that creates a type name for the Ewk_Find_Options.
- Since :
- 2.3
typedef struct _Ewk_Geolocation_Permission_Request Ewk_Geolocation_Permission_Request |
The structure type that creates a type name for Ewk_Geolocation_Permission_Request.
- Since :
- 2.4
typedef enum Ewk_Http_Method Ewk_Http_Method |
Enumeration that creates a type name for the Ewk_Http_Method.
- Since :
- 2.3
typedef struct _Ewk_Intercept_Request Ewk_Intercept_Request |
Handle for intercepted request. Used for getting information about request and writing custom response.
- Since :
- 3.0
typedef struct _Ewk_Policy_Decision Ewk_Policy_Decision |
The structure type that creates a type name for Ewk_Policy_Decision.
- Since :
- 2.3
typedef enum _Ewk_Policy_Decision_Type Ewk_Policy_Decision_Type |
Enumeration that creates a type name for the Ewk_Policy_Decision_Type.
- Since :
- 2.3
typedef enum _Ewk_Policy_Navigation_Type Ewk_Policy_Navigation_Type |
Enumeration that creates a type name for Ewk_Policy_Navigation_Type.
- Since :
- 2.3
typedef struct _Ewk_Script_Message Ewk_Script_Message |
A struct that creates a type name for the Ewk_Script_Message.
- Since :
- 3.0
typedef struct _Ewk_Security_Origin Ewk_Security_Origin |
The structure type that creates a type name for Ewk_Security_Origin.
- Since :
- 2.4
typedef struct Ewk_Settings Ewk_Settings |
The structure type that creates a type name for Ewk_Settings.
- Since :
- 2.3
typedef enum _Ewk_View_Orientation_Type Ewk_View_Orientation_Type |
Enumeration that creates a type name for the _Ewk_View_Orientation_Type.
- Since :
- 3.0
typedef struct _Ewk_View_Request_Manifest Ewk_View_Request_Manifest |
Get for web page manifest. Used for getting information about the manifest of web page.
- Since :
- 3.0
typedef void(* Ewk_View_Request_Manifest_Callback)(Evas_Object *o, Ewk_View_Request_Manifest *manifest, void *user_data) |
Callback invoked when requested manifest inform is responded.
- Since :
- 3.0
- Parameters:
-
[in] o View object for which callback was set [in] manifest Received manifest object of current's page This object is valid after callback data is received. If the manifest file is empty, it is returned NULL. [in] user_data User data passed to ewk_view_request_manifest
- See also:
- ewk_view_request_manifest
typedef void(* Ewk_View_Script_Execute_Cb)(Evas_Object *o, const char *result_value, void *user_data) |
Callback for ewk_view_script_execute().
- Since :
- 2.3
- Parameters:
-
[in] o The view object [in] result_value The value returned by the script
If executed script returns a value, it would be result_value,
otherwiseNULL
if there is no value returned by the script[in] user_data The user_data will be passed when ewk_view_script_execute() is called
typedef void(* Ewk_View_Script_Message_Cb)(Evas_Object *o, Ewk_Script_Message message) |
Callback for ewk_view_javascript_message_handler_add().
- Since :
- 3.0
- Parameters:
-
[in] o The view object [in] message The ScriptMessage returned by the script.
It will be passed when ewk_view_javascript_message_handler_add() is called.
typedef enum _Ewk_View_Web_Display_Mode Ewk_View_Web_Display_Mode |
Enumeration that creates a type name for the _Ewk_View_Web_Display_Mode.
- Since :
- 3.0
Enumeration Type Documentation
Enumeration that provides an option to autofill profile data types.
- Since :
- 2.4
- Enumerator:
enum _Ewk_Cache_Model |
Enumeration that provides the tags of items for the context menu.
- Since :
- 2.3
- Enumerator:
EWK_CONTEXT_MENU_ITEM_TAG_NO_ACTION No action
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_OPEN_IMAGE_IN_CURRENT_WINDOW Open image in current 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_OPEN_FRAME_IN_NEW_WINDOW Open frame in new window
EWK_CONTEXT_MENU_ITEM_TAG_COPY Copy
EWK_CONTEXT_MENU_ITEM_TAG_GO_BACK Go back
EWK_CONTEXT_MENU_ITEM_TAG_GO_FORWARD Go forward
EWK_CONTEXT_MENU_ITEM_TAG_STOP Stop
EWK_CONTEXT_MENU_ITEM_TAG_SHARE Share
EWK_CONTEXT_MENU_ITEM_TAG_RELOAD Reload
EWK_CONTEXT_MENU_ITEM_TAG_CUT Cut
EWK_CONTEXT_MENU_ITEM_TAG_PASTE Paste
EWK_CONTEXT_MENU_ITEM_TAG_SPELLING_GUESS Spelling guess
EWK_CONTEXT_MENU_ITEM_TAG_NO_GUESSES_FOUND Guess found
EWK_CONTEXT_MENU_ITEM_TAG_IGNORE_SPELLING Ignore spelling
EWK_CONTEXT_MENU_ITEM_TAG_LEARN_SPELLING Learn spelling
EWK_CONTEXT_MENU_ITEM_TAG_OTHER Other
EWK_CONTEXT_MENU_ITEM_TAG_SEARCH_IN_SPOTLIGHT Search in spotlight
EWK_CONTEXT_MENU_ITEM_TAG_SEARCH_WEB Search web
EWK_CONTEXT_MENU_ITEM_TAG_LOOK_UP_IN_DICTIONARY Look up in dictionary
EWK_CONTEXT_MENU_ITEM_TAG_OPEN_WITH_DEFAULT_APPLICATION Open with default application
EWK_CONTEXT_MENU_ITEM_TAG_PDF_ACTUAL_SIZE PDF actual size
EWK_CONTEXT_MENU_ITEM_TAG_PDF_ZOOM_IN PDF zoom in
EWK_CONTEXT_MENU_ITEM_TAG_PDF_ZOOM_OUT PDF zoom out
EWK_CONTEXT_MENU_ITEM_TAG_PDF_AUTO_SIZE PDF auto size
EWK_CONTEXT_MENU_ITEM_TAG_PDF_SINGLE_PAGE PDF single page
EWK_CONTEXT_MENU_ITEM_TAG_PDF_FACTING_PAGES PDF facting page
EWK_CONTEXT_MENU_ITEM_TAG_PDF_CONTINUOUS PDF continuous
EWK_CONTEXT_MENU_ITEM_TAG_PDF_NEXT_PAGE PDF next page
EWK_CONTEXT_MENU_ITEM_TAG_PDF_PREVIOUS_PAGE PDF previous page
EWK_CONTEXT_MENU_ITEM_TAG_OPEN_LINK Open link
EWK_CONTEXT_MENU_ITEM_TAG_IGNORE_GRAMMAR Ignore grammar
EWK_CONTEXT_MENU_ITEM_TAG_SPELLING_MENU Spelling menu
EWK_CONTEXT_MENU_ITEM_TAG_SHOW_SPELLING_PANEL Show spelling panel
EWK_CONTEXT_MENU_ITEM_TAG_CHECK_SPELLING Check spelling
EWK_CONTEXT_MENU_ITEM_TAG_CHECK_SPELLING_WHILE_TYPING Check spelling white typing
EWK_CONTEXT_MENU_ITEM_TAG_CHECK_GRAMMAR_WITH_SPELLING Check grammar with spelling
EWK_CONTEXT_MENU_ITEM_TAG_FONT_MENU Font menu
EWK_CONTEXT_MENU_ITEM_TAG_SHOW_FONTS Show fonts
EWK_CONTEXT_MENU_ITEM_TAG_BOLD Bold
EWK_CONTEXT_MENU_ITEM_TAG_ITALIC Italic
EWK_CONTEXT_MENU_ITEM_TAG_UNDERLINE Underline
EWK_CONTEXT_MENU_ITEM_TAG_OUTLINE Outline
EWK_CONTEXT_MENU_ITEM_TAG_STYLES Style
EWK_CONTEXT_MENU_ITEM_TAG_SHOW_COLORS Show colors
EWK_CONTEXT_MENU_ITEM_TAG_SPEECH_MENU Speech menu
EWK_CONTEXT_MENU_ITEM_TAG_START_SPEAKING Start speaking
EWK_CONTEXT_MENU_ITEM_TAG_STOP_SPEAKING Stop speaking
EWK_CONTEXT_MENU_ITEM_TAG_WRITING_DIRECTION_MENU Writing direction menu
EWK_CONTEXT_MENU_ITEM_TAG_DEFAULT_DIRECTION Default direction
EWK_CONTEXT_MENU_ITEM_TAG_LEFT_TO_RIGHT Left to right
EWK_CONTEXT_MENU_ITEM_TAG_RIGHT_TO_LEFT Right to left
EWK_CONTEXT_MENU_ITEM_TAG_PDF_SINGLE_PAGE_SCROLLING PDF single page scrolling
EWK_CONTEXT_MENU_ITEM_TAG_PDF_FACING_PAGES_SCROLLING PDF facing page scrolling
EWK_CONTEXT_MENU_ITEM_TAG_INSPECT_ELEMENT Inspect element
EWK_CONTEXT_MENU_ITEM_TAG_TEXT_DIRECTION_MENU Text direction menu
EWK_CONTEXT_MENU_ITEM_TAG_TEXT_DIRECTION_DEFAULT Text direction default
EWK_CONTEXT_MENU_ITEM_TAG_TEXT_DIRECTION_LEFT_TO_RIGHT Text direction left to right
EWK_CONTEXT_MENU_ITEM_TAG_TEXT_DIRECTION_RIGHT_TO_LEFT Text direction right to left
EWK_CONTEXT_MENU_ITEM_TAG_CORRECT_SPELLING_AUTOMATICALLY Correct spelling automatically
EWK_CONTEXT_MENU_ITEM_TAG_SUBSTITUTIONS_MENU Substitutions menu
EWK_CONTEXT_MENU_ITEM_TAG_SHOW_SUBSTITUTIONS Show substitutions
EWK_CONTEXT_MENU_ITEM_TAG_SMART_COPY_PASTE Smart copy paste
EWK_CONTEXT_MENU_ITEM_TAG_SMART_QUOTES Smart quotes
EWK_CONTEXT_MENU_ITEM_TAG_SMART_DASHES Smart dashes
EWK_CONTEXT_MENU_ITEM_TAG_SMART_LINKS Smart links
EWK_CONTEXT_MENU_ITEM_TAG_TEXT_REPLACEMENT Text replacement
EWK_CONTEXT_MENU_ITEM_TAG_TRANSFORMATIONS_MENU Transformation menu
EWK_CONTEXT_MENU_ITEM_TAG_MAKE_UPPER_CASE Make upper case
EWK_CONTEXT_MENU_ITEM_TAG_MAKE_LOWER_CASE Make lower case
EWK_CONTEXT_MENU_ITEM_TAG_CAPITALIZE Capitalize
EWK_CONTEXT_MENU_ITEM_TAG_CHANGE_BACK Change back
EWK_CONTEXT_MENU_ITEM_TAG_OPEN_MEDIA_IN_NEW_WINDOW Open media in new window
EWK_CONTEXT_MENU_ITEM_TAG_COPY_MEDIA_LINK_TO_CLIPBOARD Copy media link to clipboard
EWK_CONTEXT_MENU_ITEM_TAG_TOGGLE_MEDIA_CONTROLS Toggle media controls
EWK_CONTEXT_MENU_ITEM_TAG_TOGGLE_MEDIA_LOOP Toggle media loop
EWK_CONTEXT_MENU_ITEM_TAG_ENTER_VIDEO_FULLSCREEN Enter video fullscreen
EWK_CONTEXT_MENU_ITEM_TAG_MEDIA_PLAY_PAUSE Media play pause
EWK_CONTEXT_MENU_ITEM_TAG_MEDIA_MUTE Media mute
EWK_CONTEXT_MENU_ITEM_TAG_DICTATION_ALTERNATIVE Dictation alternative
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_DRAG Drag
EWK_CONTEXT_MENU_ITEM_TAG_TRANSLATE Translate
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.
- Since :
- 2.3
- Enumerator:
Enumeration that provides the type of orientation. These are attributes locking the screen orientation.
It contains enum values used to specify orientation types.
- Since :
- 3.0
- Enumerator:
Enumeration that provides the mode of web display. These are attributes representing how the web application is being presented within the context.
It contains enum values used to specify web display mode.
- Since :
- 3.0
Enumeration that creates a type name for the Ewk_Cookie_Persistent_Storage.
- Since :
- 3.0
enum Ewk_Error_Code |
Enumeration that provides an option to error codes.
- Since :
- 2.3
- Enumerator:
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.
- Since :
- 2.3
- Enumerator:
enum Ewk_Http_Method |
Function Documentation
const char* ewk_autofill_profile_data_get | ( | Ewk_Autofill_Profile * | profile, |
Ewk_Autofill_Profile_Data_Type | name | ||
) |
Gets the attribute value from a given profile.
The profile obtained from ewk_context_form_autofill_profile_get will be used to get the data
- Since :
- 2.4
- Parameters:
-
[in] profile name of profile [in] name name of attribute
- Returns:
Value
of attribute (char*),NULL
otherwise
void ewk_autofill_profile_data_set | ( | Ewk_Autofill_Profile * | profile, |
Ewk_Autofill_Profile_Data_Type | name, | ||
const char * | value | ||
) |
Sets the data in the profile created by ewk_autofill_profile_new.
The data set by this function is set locally. To save it to database use ewk_context_form_autofill_profile_add
- Since :
- 2.4
- Parameters:
-
[in] profile contains the profile data [in] name type of attribute to be set [in] value value of the attribute
void ewk_autofill_profile_delete | ( | Ewk_Autofill_Profile * | profile | ) |
Deletes a given profile.
The API will delete the a particular profile only from the memory. To remove the profile permanently use ewk_context_form_autofill_profile_remove
- Since :
- 2.4
- Parameters:
-
[in] profile name
unsigned ewk_autofill_profile_id_get | ( | Ewk_Autofill_Profile * | profile | ) |
Gets the id attribute value from a given profile.
The profile obtained from ewk_context_form_autofill_profile_get will be used to get the profile id
- Parameters:
-
[in] profile name of profile
- Since :
- 2.4
- Returns:
Value
of attribute (unsigned),0
otherwise
Ewk_Autofill_Profile* ewk_autofill_profile_new | ( | void | ) |
Creates a new profile.
The created profile must be deleted by ewk_autofill_profile_delete
- Since :
- 2.4
- Returns:
Ewk_Autofill_Profile
if new profile is successfully created,NULL
otherwise
unsigned ewk_back_forward_list_count | ( | Ewk_Back_Forward_List * | list | ) |
Returns the length of the back-forward list including the current item.
- Since :
- 2.3
- Parameters:
-
[in] list The back-forward list instance
- Returns:
- The length of the back-forward list including the current item,
otherwise0
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.
- Since :
- 2.3
- Parameters:
-
[in] list The back-forward list instance
- Returns:
- The current item in the list,
otherwiseNULL
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.
- Since :
- 2.3
- Parameters:
-
[in] list The back-forward list instance [in] index The index of the item
- Returns:
- The item at a given index relative to the current item,
otherwiseNULL
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.
- Since :
- 2.3
- Parameters:
-
[in] item The back-forward list item instance
- Returns:
- The original URL of the item,
otherwiseNULL
in case of an error
This pointer is guaranteed to be eina_stringshare,
so whenever possible save yourself some CPU cycles and
use eina_stringshare_ref() instead of eina_stringshare_add() or strdup()
- See also:
- ewk_back_forward_list_item_url_get()
Increases the reference count of the given object.
- Since :
- 2.3
- Parameters:
-
[in] item The back-forward list item instance to increase the reference count
- Returns:
- A pointer to the object on success,
otherwiseNULL
const char* ewk_back_forward_list_item_title_get | ( | const Ewk_Back_Forward_List_Item * | item | ) |
Returns the title of the item.
- Since :
- 2.3
- Parameters:
-
[in] item The back-forward list item instance
- Returns:
- The title of the item,
otherwiseNULL
in case of an error
This pointer is guaranteed to be eina_stringshare,
so whenever possible save yourself some CPU cycles and
use eina_stringshare_ref() instead of eina_stringshare_add() or strdup()
void 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.
- Since :
- 2.3
- Parameters:
-
[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).
- Since :
- 2.3
- Parameters:
-
[in] item The back-forward list item instance
- Returns:
- The URL of the item,
otherwiseNULL
in case of an error
This pointer is guaranteed to be eina_stringshare,
so whenever possible save yourself some CPU cycles and
use eina_stringshare_ref() instead of eina_stringshare_add() or strdup()
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.
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.
- Since :
- 2.3
- Parameters:
-
[in] list The back-forward list instance [in] limit The number of items to retrieve
- Returns:
Eina_List
containingEwk_Back_Forward_List_Item
elements,
otherwiseNULL
in case of an error
The Eina_List and its items should be freed after use
Use ewk_back_forward_list_item_unref() to free the items
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.
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.
- Since :
- 2.3
- Parameters:
-
[in] list The back-forward list instance [in] limit The number of items to retrieve
- Returns:
Eina_List
containingEwk_Back_Forward_List_Item
elements,
otherwiseNULL
in case of an error,
The Eina_List and its items should be freed after use
Use ewk_back_forward_list_item_unref() to free the items
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.
- Since :
- 2.3
- Parameters:
-
[in] list The back-forward list instance
- Returns:
- The item that follows the current item in the list,
otherwiseNULL
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.
- Since :
- 2.3
- Parameters:
-
[in] list The back-forward list instance
- Returns:
- The item that precedes the current item in the list,
otherwiseNULL
in case of an error
Eina_Bool ewk_context_application_cache_delete_all | ( | Ewk_Context * | context | ) |
Requests for deleting all web application caches.
- Since :
- 2.4
- Parameters:
-
[in] context Context object
- Returns:
EINA_TRUE
on success, otherwiseEINA
FALSE
Eina_Bool ewk_context_background_music_get | ( | Ewk_Context * | context | ) |
Gets the enabled state of background music.
- Since :
- 4.0
- Parameters:
-
[in] context The context object
- Returns:
EINA_TRUE
if background music is enabled,EINA_FALSE
otherwise
Eina_Bool ewk_context_background_music_set | ( | Ewk_Context * | context, |
Eina_Bool | enable | ||
) |
Sets the enabled state of background music.
This function allows the application to continue playing instead of pausing when it moves to the background.
- Since :
- 4.0
- Parameters:
-
[in] context The context object [in] enable Enable or disable background music
- Returns:
EINA_TRUE
on success,EINA_FALSE
otherwise
Eina_Bool ewk_context_block_multimedia_on_call_get | ( | Ewk_Context * | context | ) |
Gets the enabled state of blocking multimedia on call.
- Since :
- 4.0
- Parameters:
-
[in] context The context object
- Returns:
EINA_TRUE
if blocking multimedia on call is enabled,EINA_FALSE
otherwise
Eina_Bool ewk_context_block_multimedia_on_call_set | ( | Ewk_Context * | context, |
Eina_Bool | enable | ||
) |
Sets the enabled state of blocking multimedia on call.
The application can set the flag to allow or disallow media playback during active call.
- Since :
- 4.0
- Parameters:
-
[in] context The context object [in] enable Enable or disable blocking multimedia on call
- Returns:
EINA_TRUE
on success,EINA_FALSE
otherwise
Ewk_Cache_Model ewk_context_cache_model_get | ( | const Ewk_Context * | context | ) |
Returns the cache model type.
- Since :
- 2.3
- Parameters:
-
[in] context The context object
- Returns:
- Ewk_Cache_Model
Eina_Bool ewk_context_cache_model_set | ( | Ewk_Context * | context, |
Ewk_Cache_Model | model | ||
) |
Requests to set the cache model.
The default cache option is EWK_CACHE_MODEL_DOCUMENT_VIEWER.
- Since :
- 2.3
- Parameters:
-
[in] context The context object [in] model The cache model
- Returns:
EINA_TRUE
on success,
otherwiseEINA_FALSE
Ewk_Cookie_Manager* ewk_context_cookie_manager_get | ( | const Ewk_Context * | context | ) |
Gets the cookie manager instance for this context.
- Since :
- 2.3
- Parameters:
-
[in] context The context object to query
- Returns:
- The Ewk_Cookie_Manager object instance,
otherwiseNULL
in case of failure
Eina_Bool ewk_context_form_autofill_profile_add | ( | Ewk_Context * | context, |
Ewk_Autofill_Profile * | profile | ||
) |
Saves the created profile into permanent storage.
The profile used to save must be created by ewk_autofill_profile_new. Data can be added to the created profile by ewk_autofill_profile_data_set.
- Since :
- 2.4
- Parameters:
-
[in] context Context object [in] profile Ewk_Autofill_Profile
- Returns:
EINA_TRUE
if the profile data is saved successfully, otherwiseEINA_FALSE
- See also:
- ewk_autofill_profile_new
Ewk_Autofill_Profile* ewk_context_form_autofill_profile_get | ( | Ewk_Context * | context, |
unsigned | id | ||
) |
Gets the existing profile for given index.
- Since :
- 2.4
- Parameters:
-
[in] context Context object [in] id Profile
- Returns:
Ewk_Autofill_Profile
if profile exists, otherwiseNULL
- See also:
- ewk_autofill_profile_delete
Eina_List* ewk_context_form_autofill_profile_get_all | ( | Ewk_Context * | context | ) |
Gets a list of all existing profiles.
The obtained profile must be deleted by ewk_autofill_profile_delete.
- Since :
- 2.4
- Parameters:
-
[in] context Context object
- Returns:
Eina_List
of Ewk_Autofill_Profile, otherwiseNULL
- See also:
- ewk_autofill_profile_delete
Eina_Bool ewk_context_form_autofill_profile_remove | ( | Ewk_Context * | context, |
unsigned | id | ||
) |
Removes Autofill Form profile completely.
- Since :
- 2.4
- Parameters:
-
[in] context Context object [in] id Profile
- Returns:
EINA_TRUE
if the profile data is removed successfully, otherwiseEINA_FALSE
Eina_Bool ewk_context_form_autofill_profile_set | ( | Ewk_Context * | context, |
unsigned | id, | ||
Ewk_Autofill_Profile * | profile | ||
) |
Sets the given profile for the given id.
Data can be added to the created profile by ewk_autofill_profile_data_set.
- Since :
- 2.4
- Parameters:
-
[in] context Context object [in] id Profile [in] profile Ewk_Autofill_Profile
- Returns:
EINA_TRUE
if the profile data is set successfully, otherwiseEINA_FALSE
void ewk_context_form_candidate_data_delete_all | ( | Ewk_Context * | context | ) |
Deletes all candidate form data from DB.
- Since :
- 2.4
- Parameters:
-
[in] context Context object
void ewk_context_form_password_data_delete_all | ( | Ewk_Context * | context | ) |
Deletes whole password data from DB.
- Since :
- 2.4
- Parameters:
-
context Context object
Evas_Object* ewk_context_icon_database_icon_object_add | ( | Ewk_Context * | context, |
const char * | uri, | ||
Evas * | canvas | ||
) |
Requests to get image representing the given URL.
- Since :
- 2.4
- Parameters:
-
[in] context Context object [in] uri Which url to query icon, must not be 0
[in] canvas Evas instance where to add resulting object, must not be 0
- Returns:
Evas_Object
instance, otherwise0
void ewk_context_intercept_request_callback_set | ( | Ewk_Context * | ewk_context, |
Ewk_Context_Intercept_Request_Callback | callback, | ||
void * | user_data | ||
) |
Sets Ewk_Context_Intercept_Request_Callback.
Sets Ewk_Context_Intercept_Request_Callback to give a chance to intercept resource request before sending it and return a custom response.
- Remarks:
- Pass NULL pointer as callback to reset current callback.
- Since :
- 3.0
- Parameters:
-
[in] ewk_context Ewk_Context object to intercept requests [in] callback New callback, NULL resets current callback [in] user_data User data passed to callback
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.
- Since :
- 2.3
- Parameters:
-
[in] menu The context menu object [in] tag The tag of context menu item [in] title The title of context menu item [in] icon_file The path of icon to be set on context menu item [in] enabled If true
the context menu item is enabled,
otherwisefalse
- Returns:
EINA_TRUE
on successful request,
otherwiseEINA_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.
- Since :
- 2.3
- Parameters:
-
[in] menu The context menu object [in] tag The tag of context menu item [in] title The title of context menu item [in] enabled If true
the context menu item is enabled,
otherwisefalse
- Returns:
EINA_TRUE
on successful request,
otherwiseEINA_FALSE
on failure
unsigned ewk_context_menu_item_count | ( | Ewk_Context_Menu * | menu | ) |
Counts the number of the context menu item.
- Since :
- 2.3
- Parameters:
-
[in] menu The context menu object
- Returns:
- The number of current context menu item
const char* ewk_context_menu_item_image_url_get | ( | Ewk_Context_Menu_Item * | item | ) |
Returns the image url string of context menu item.
- Since :
- 2.3
- Parameters:
-
[in] item The context menu item object
- Returns:
- The current image url string on success,
otherwise0
on failure
const char* ewk_context_menu_item_link_url_get | ( | Ewk_Context_Menu_Item * | item | ) |
Returns the link url string of context menu item.
- Since :
- 2.3
- Parameters:
-
[in] item The context menu item object
- Returns:
- The current link url string on success,
otherwise0
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.
- Remarks:
- If all context menu items are removed, neither context menu nor
selection handles will be shown.
- Since :
- 2.3
- Parameters:
-
[in] menu The context menu object [in] item The context menu item to remove
- Returns:
EINA_TRUE
on successful request,
otherwiseEINA_FALSE
on failure
Returns the tag of context menu item.
- Since :
- 2.3
- Parameters:
-
[in] item The context menu item object
- Returns:
- The tag of context menu item
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.
- Since :
- 2.3
- Parameters:
-
[in] menu The context menu object [in] n The number of the item
- Returns:
- The nth item of context menu
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.
- Since :
- 2.3
- Parameters:
-
[in] context The context object to clear all resource caches
Eina_Bool ewk_context_rotation_lock_get | ( | Ewk_Context * | context | ) |
Gets the enabled state of rotation lock.
- Since :
- 4.0
- Parameters:
-
[in] context The context object
- Returns:
EINA_TRUE
if rotation lock is enabled,EINA_FALSE
otherwise
Eina_Bool ewk_context_rotation_lock_set | ( | Ewk_Context * | context, |
Eina_Bool | enable | ||
) |
Sets the enabled state of rotation lock.
The application can use this function to lock the auto screen rotation feature.
- Since :
- 4.0
- Parameters:
-
[in] context The context object [in] enable Enable or disable rotation lock
- Returns:
EINA_TRUE
on success,EINA_FALSE
otherwise
Eina_Bool ewk_context_sound_overlap_get | ( | Ewk_Context * | context | ) |
Gets the enabled state of sound overlap.
- Since :
- 4.0
- Parameters:
-
[in] context The context object
- Returns:
EINA_TRUE
if sound overlap is enabled,EINA_FALSE
otherwise
Eina_Bool ewk_context_sound_overlap_set | ( | Ewk_Context * | context, |
Eina_Bool | enable | ||
) |
Sets the enabled state of sound overlap.
The application can set the flag to allow or disallow the sound overlap with other apps.
- Since :
- 4.0
- Parameters:
-
[in] context The context object [in] enable Enable or disable sound overlap
- Returns:
EINA_TRUE
on success,EINA_FALSE
otherwise
Requests for deleting all web indexed databases.
- Since :
- 2.4
- Parameters:
-
[in] context Context object
- Returns:
EINA_TRUE
on success, otherwiseEINA_FALSE
Eina_Bool ewk_context_web_storage_delete_all | ( | Ewk_Context * | context | ) |
Deletes web storage.
This function does not ensure that all data will be removed. Should be used to extend free physical memory.
- Since :
- 2.4
- Parameters:
-
[in] context Context object
- Returns:
EINA_TRUE
on success, otherwiseEINA_FALSE
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.
- Since :
- 2.3
- Parameters:
-
[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.
- Since :
- 2.3
- Parameters:
-
[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.
- Since :
- 2.3
- Parameters:
-
[in] manager The cookie manager to update
Queries if the cookie manager allows cookies for file scheme URLs.
- Since :
- 3.0
- Parameters:
-
[in] manager The cookie manager to query
- Returns:
EINA_TRUE
if cookies for file scheme are allowed orEINA_FALSE
otherwise
void ewk_cookie_manager_file_scheme_cookies_allow_set | ( | Ewk_Cookie_Manager * | manager, |
Eina_Bool | allow | ||
) |
Sets whether cookie manager allows cookies for file scheme URLs.
- Since :
- 3.0
- Parameters:
-
[in] manager The cookie manager to allow file scheme for cookies [in] allow A state to set
void ewk_cookie_manager_persistent_storage_set | ( | Ewk_Cookie_Manager * | manager, |
const char * | path, | ||
Ewk_Cookie_Persistent_Storage | storage | ||
) |
Sets the path where non-session cookies are stored persistently using storage as the format to read/write the cookies.
Cookies are initially read from path/Cookies to create an initial set of cookies. Then, non-session cookies will be written to path/Cookies. By default, manager doesn't store the cookies persistently, so you need to call this method to keep cookies saved across sessions. If path does not exist it will be created.
- Remarks:
- http://tizen.org/privilege/mediastorage is needed if input or output path is relevant to media storage.
http://tizen.org/privilege/externalstorage is needed if input or output path is relevant to external storage.
- Since :
- 3.0
- Parameters:
-
[in] manager The cookie manager to update [in] path The path where to read/write Cookies [in] storage The type of storage
Eina_Bool ewk_error_cancellation_get | ( | const Ewk_Error * | error | ) |
Query if error should be treated as a cancellation.
- Since :
- 2.3
- Parameters:
-
[in] error The error object to query
- Returns:
EINA_TRUE
if this error should be treated as a cancellation
otherwiseEINA_FALSE
int ewk_error_code_get | ( | const Ewk_Error * | error | ) |
Query the error code.
- Since :
- 2.3
- Parameters:
-
[in] error The error object to query
- Returns:
- The error code Ewk_Error_Code
const char* ewk_error_description_get | ( | const Ewk_Error * | error | ) |
Query description for this error.
- Since :
- 2.3
- Parameters:
-
[in] error The error object to query
- Returns:
- The description pointer, that may be
NULL
. This pointer is
guaranteed to be eina_stringshare, so whenever possible
save yourself some cpu cycles and use
eina_stringshare_ref() instead of eina_stringshare_add() or
strdup()
const char* ewk_error_url_get | ( | const Ewk_Error * | error | ) |
Query failing URL for this error.
URL that failed loading.
- Since :
- 2.3
- Parameters:
-
[in] error The error object to query
- Returns:
- The URL pointer, that may be
NULL
. This pointer is
guaranteed to be eina_stringshare, so whenever possible
save yourself some cpu cycles and use
eina_stringshare_ref() instead of eina_stringshare_add() or
strdup()
const Ewk_Security_Origin* ewk_geolocation_permission_request_origin_get | ( | const Ewk_Geolocation_Permission_Request * | request | ) |
Requests for getting origin of geolocation permission request.
- Since :
- 2.4
- Parameters:
-
[in] request Ewk_Geolocation_Permission_Request object to get origin
- Returns:
- security origin of geolocation permission data
int ewk_init | ( | void | ) |
Initializes Chromium's instance.
- Initializes components needed by EFL,
- Increases a reference count of Chromium's instance.
- Since :
- 2.3
- Returns:
- A reference count of Chromium's instance on success,
otherwise0
on failure
const Eina_Hash* ewk_intercept_request_headers_get | ( | Ewk_Intercept_Request * | intercept_request | ) |
Returns request headers from Intercept Request object.
- Remarks:
- Returned hash map is owned by Intercept Request object, you have to make a copy if you want to use it past owner lifetime.
- Since :
- 3.0
- Parameters:
-
[in] intercept_request intercept request instance received from Ewk_Context_Intercept_Request_Callback ewk_context callback
- Returns:
Eina_Hash
mapping from header name string to header value string on success or NULL on failure
const char* ewk_intercept_request_http_method_get | ( | Ewk_Intercept_Request * | intercept_request | ) |
Returns request method from Intercept Request object.
- Remarks:
- Returned string is owned by Intercept Request object, you have to make a copy if you want to use it past owner lifetime.
- Since :
- 3.0
- Parameters:
-
[in] intercept_request intercept request instance received from Ewk_Context_Intercept_Request_Callback ewk_context callback
- Returns:
method
string on success or NULL on failure
Eina_Bool ewk_intercept_request_ignore | ( | Ewk_Intercept_Request * | intercept_request | ) |
Ignores request so engine will handle it normally.
When application doesn't have a response for intercepted request url, it calls this function, which notifies engine to proceed with normal resource loading.
- Remarks:
- After this call, handling the request is done. Any further calls on the Ewk_Intercept_Request instance result in undefined behavior.
Only use this function from inside the Ewk_Context_Intercept_Request_Callback.
- Since :
- 3.0
- Parameters:
-
[in] intercept_request Intercept Request instance received in Ewk_Context_Intercept_Request_Callback
- Returns:
EINA_TRUE
on success orEINA_FALSE
on failure
Eina_Bool ewk_intercept_request_response_body_set | ( | Ewk_Intercept_Request * | intercept_request, |
const char * | body, | ||
size_t | length | ||
) |
Writes whole response body at once.
This function can be used to write response body. To call it, application should have full response body ready for the intercepted request.
- Remarks:
- It is allowed to use this function both inside and outside the Ewk_Context_Intercept_Request_Callback.
After this call, handling the request is done. Any further calls on the Ewk_Intercept_Request instance result in undefined behavior.
You can't use this call after you started writing response in chunks with ewk_intercept_request_response_write_chunk.
- Since :
- 3.0
- Parameters:
-
[in] intercept_request Intercept Request instance received from Ewk_Context_Intercept_Request_Callback ewk_context callback [in] body Response body for the intercept request [in] length Length of response body
- Returns:
EINA_TRUE
on success or EINA_FALSE on failure
- Precondition:
- Before writing response body, you should set response status and headers using the following functions:
Eina_Bool ewk_intercept_request_response_header_add | ( | Ewk_Intercept_Request * | intercept_request, |
const char * | field_name, | ||
const char * | field_value | ||
) |
Adds HTTP header to response for intercepted request.
- Remarks:
- It is allowed to use this function both inside and outside the Ewk_Context_Intercept_Request_Callback.
In case of failure of this function finish writing for this intercept request.
- Since :
- 3.0
- Parameters:
-
[in] intercept_request Intercept Request instance received from Ewk_Context_Intercept_Request_Callback ewk_context callback [in] field_name HTTP header field name [in] field_value HTTP header field value
- Returns:
EINA_TRUE
on success or EINA_FALSE on failure
Eina_Bool ewk_intercept_request_response_header_map_add | ( | Ewk_Intercept_Request * | intercept_request, |
const Eina_Hash * | headers | ||
) |
Adds HTTP headers to response for intercepted request.
- Remarks:
- It is allowed to use this function both inside and outside the Ewk_Context_Intercept_Request_Callback.
In case of failure of this function finish writing for this intercept request.
- Since :
- 3.0
- Parameters:
-
[in] intercept_request Intercept Request instance received from Ewk_Context_Intercept_Request_Callback ewk_context callback. [in] headers Map from HTTP header field names to field values, both represented as null terminated strings
- Returns:
EINA_TRUE
on success or EINA_FALSE on failure
Eina_Bool ewk_intercept_request_response_set | ( | Ewk_Intercept_Request * | intercept_request, |
const char * | headers, | ||
const char * | body, | ||
size_t | length | ||
) |
Writes whole response with headers at once.
This function can be used to write whole response at once. To call it, application should have full response headers and body ready for the intercepted request.
- Remarks:
- It is allowed to use this function both inside and outside the Ewk_Context_Intercept_Request_Callback.
After this call, handling the request is done. Any further calls on the Ewk_Intercept_Request instance result in undefined behavior.
You can't use this call after you started writing response in chunks with ewk_intercept_request_response_write_chunk.
Alternatively you can use following functions which are more convenient:
- ewk_intercept_request_response_status_set()
- ewk_intercept_request_response_header_add()
- ewk_intercept_request_response_header_map_add()
- ewk_intercept_request_response_body_set()
- ewk_intercept_request_response_write_chunk()
Using this function overrides status and headers set with functions listed above.
- Since :
- 3.0
- Parameters:
-
[in] intercept_request Intercept Request instance received from Ewk_Context_Intercept_Request_Callback ewk_context callback [in] headers Null-terminated string representing response's headers for the intercept request. By HTTP spec, lines should end with a newline ('\r\n') and headers should end with an empty line ('\r\n\r\n'). [in] body Response body for the intercept request [in] length Length of response body
- Returns:
EINA_TRUE
on success or EINA_FALSE on failure
Eina_Bool ewk_intercept_request_response_status_set | ( | Ewk_Intercept_Request * | intercept_request, |
int | status_code, | ||
const char * | custom_status_text | ||
) |
Sets status code and status text of response for intercepted request.
- Remarks:
- It is allowed to use this function both inside and outside the Ewk_Context_Intercept_Request_Callback.
In case of failure of this function finish writing for this intercept request.
- Since :
- 3.0
- Parameters:
-
[in] intercept_request Intercept Request instance received from Ewk_Context_Intercept_Request_Callback ewk_context callback [in] status_code HTTP response status code [in] custom_status_text HTTP response reason phrase, pass NULL to use recommended reason phrase (example: "OK" for code 200)
- Returns:
EINA_TRUE
on success or EINA_FALSE on failure
Eina_Bool ewk_intercept_request_response_write_chunk | ( | Ewk_Intercept_Request * | intercept_request, |
const char * | chunk, | ||
size_t | length | ||
) |
Writes a part of response body.
This function can be used to write response body in chunks. Application doesn't have to prepare full response body before calling this function, it can be used as soon as a part of response is ready.
- Remarks:
- If this function returns EINA_FALSE, handling the request is done. Any further calls on the Ewk_Intercept_Request instance result in undefined behavior. User should always check return value, because response to this request might not be needed anymore, and function can return EINA_FALSE even though user still has data to write.
It is only allowed to use this function *outside* of the Ewk_Context_Intercept_Request_Callback.
If a part of response body has been written with this function, you can't use the following functions anymore:
- ewk_intercept_request_response_set
- ewk_intercept_request_response_body_set
Using this function with too big chunks of data defeats its purpose. Engine uses chunks of response written with this function without waiting for end of data, which is its main advantage over ewk_intercept_request_response_body_set.
- Since :
- 3.0
- Parameters:
-
[in] intercept_request Intercept Request instance received from Ewk_Context_Intercept_Request_Callback ewk_context callback [in] chunk Part of response body for intercepted request [in] length Length of response body part
- Returns:
EINA_TRUE
on success or EINA_FALSE on failure
- Precondition:
- Before writing response body, you should set response status and headers using the following functions:
- Postcondition:
- After writing full response body in chunks using this function, call it again with NULL as chunk and 0 as length, to signal that response body is finished.
Use the same arguments if there is a failure with preparing the rest of response body on application side, and you don't want or can't continue writing parts.
const char* ewk_intercept_request_url_get | ( | Ewk_Intercept_Request * | intercept_request | ) |
Returns request url from Intercept Request object.
- Remarks:
- Returned string is owned by Intercept Request object, you have to make a copy if you want to use it past owner lifetime.
- Since :
- 3.0
- Parameters:
-
[in] intercept_request intercept request instance received from Ewk_Context_Intercept_Request_Callback ewk_context callback
- Returns:
url
string on success or NULL on failure
Eina_Bool ewk_manifest_background_color_get | ( | Ewk_View_Request_Manifest * | manifest, |
uint8_t * | r, | ||
uint8_t * | g, | ||
uint8_t * | b, | ||
uint8_t * | a | ||
) |
Get the background color of the manifest.
- Since :
- 3.0
- Parameters:
-
[in] manifest Manifest object to get manifest information. [out] r The red component of the background color, Pass NULL if you don't want to get the value. [out] g The green component of the background color, Pass NULL if you don't want to get the value. [out] b The blue component of the background color, Pass NULL if you don't want to get the value. [out] a The alpha component of the background color, Pass NULL if you don't want to get the value.
- Returns:
EINA_TRUE
if background color exists otherwise EINA_FALSE. The value is only valid until related Ewk_View_Request_Manifest object is valid.
- See also:
- Ewk_View_Request_Manifest_Callback
size_t ewk_manifest_icons_count_get | ( | Ewk_View_Request_Manifest * | manifest | ) |
Get the count of icon of the manifest.
- Since :
- 3.0
- Parameters:
-
[in] manifest Manifest object to get manifest information.
- Returns:
count
of icon if icons exist otherwise 0. The value is only valid until related Ewk_View_Request_Manifest object is valid.
- See also:
- Ewk_View_Request_Manifest_Callback
int ewk_manifest_icons_height_get | ( | Ewk_View_Request_Manifest * | manifest, |
size_t | number, | ||
size_t | sizes_number | ||
) |
Get the height of icon of the manifest.
- Since :
- 3.0
- Parameters:
-
[in] manifest Manifest object to get manifest information. [in] number the index of icons to be obtained [in] sizes_number the index of sizes to be obtained
- Returns:
height
of icon if height exists otherwise -1. The value is only valid until related Ewk_View_Request_Manifest object is valid.
- See also:
- Ewk_View_Request_Manifest_Callback
size_t ewk_manifest_icons_sizes_count_get | ( | Ewk_View_Request_Manifest * | manifest, |
size_t | number | ||
) |
Get the count of the icon's sizes.
- Since :
- 3.0
- Parameters:
-
[in] manifest Manifest object to get manifest information. [in] number the index of icons to be obtained
- Returns:
count
of the icon's sizes if size of icons exists otherwise 0. The value is only valid until related Ewk_View_Request_Manifest object is valid.
- See also:
- Ewk_View_Request_Manifest_Callback
const char* ewk_manifest_icons_src_get | ( | Ewk_View_Request_Manifest * | manifest, |
size_t | number | ||
) |
Get the src of icon of the manifest.
- Since :
- 3.0
- Parameters:
-
[in] manifest Manifest object to get manifest information. [in] number the index of icons to be obtained
- Returns:
src
of icon if src exists otherwise null. The value is only valid until related Ewk_View_Request_Manifest object is valid.
- See also:
- Ewk_View_Request_Manifest_Callback
const char* ewk_manifest_icons_type_get | ( | Ewk_View_Request_Manifest * | manifest, |
size_t | number | ||
) |
Get the type of icon of the manifest.
- Since :
- 3.0
- Parameters:
-
[in] manifest Manifest object to get manifest information. [in] number the index of icons to be obtained
- Returns:
type
of icon if type exists otherwise null. The string is only valid until related Ewk_View_Request_Manifest object is valid.
- See also:
- Ewk_View_Request_Manifest_Callback
int ewk_manifest_icons_width_get | ( | Ewk_View_Request_Manifest * | manifest, |
size_t | number, | ||
size_t | sizes_number | ||
) |
Get the width of icon of the manifest.
- Since :
- 3.0
- Parameters:
-
[in] manifest Manifest object to get manifest information. [in] number the index of icons to be obtained [in] sizes_number the index of sizes to be obtained
- Returns:
width
of icon if width exists otherwise -1. The value is only valid until related Ewk_View_Request_Manifest object is valid.
- See also:
- Ewk_View_Request_Manifest_Callback
const char* ewk_manifest_name_get | ( | Ewk_View_Request_Manifest * | manifest | ) |
Get the name of the manifest.
- Since :
- 3.0
- Parameters:
-
[in] manifest Manifest object to get manifest information.
- Returns:
name
string if name exists otherwise null. The string is only valid until related Ewk_View_Request_Manifest object is valid.
- See also:
- Ewk_View_Request_Manifest_Callback
Get the orientation type of the manifest.
- Since :
- 3.0
- Parameters:
-
[in] manifest Manifest object to get manifest information.
- Returns:
orientation
type enum if orientation type exists otherwise WebScreenOrientationLockDefault. The enum is only valid until related Ewk_View_Request_Manifest object is valid.
- See also:
- Ewk_View_Request_Manifest_Callback
const char* ewk_manifest_short_name_get | ( | Ewk_View_Request_Manifest * | manifest | ) |
Get the short name of the manifest.
- Since :
- 3.0
- Parameters:
-
[in] manifest Manifest object to get manifest information.
- Returns:
short
name string if short name exists otherwise null. The string is only valid until related Ewk_View_Request_Manifest object is valid.
- See also:
- Ewk_View_Request_Manifest_Callback
const char* ewk_manifest_start_url_get | ( | Ewk_View_Request_Manifest * | manifest | ) |
Get the start url of the manifest.
- Since :
- 3.0
- Parameters:
-
[in] manifest Manifest object to get manifest information.
- Returns:
start
url string if start url exists otherwise null. The string is only valid until related Ewk_View_Request_Manifest object is valid.
- See also:
- Ewk_View_Request_Manifest_Callback
Eina_Bool ewk_manifest_theme_color_get | ( | Ewk_View_Request_Manifest * | manifest, |
uint8_t * | r, | ||
uint8_t * | g, | ||
uint8_t * | b, | ||
uint8_t * | a | ||
) |
Get the theme color of the manifest.
- Since :
- 3.0
- Parameters:
-
[in] manifest Manifest object to get manifest information. [out] r The red component of the theme color, Pass NULL if you don't want to get the value. [out] g The green component of the theme color, Pass NULL if you don't want to get the value. [out] b The blue component of the theme color, Pass NULL if you don't want to get the value. [out] a The alpha component of the theme color, Pass NULL if you don't want to get the value.
- Returns:
EINA_TRUE
if theme color exists otherwise EINA_FALSE. The value is only valid until related Ewk_View_Request_Manifest object is valid.
- See also:
- Ewk_View_Request_Manifest_Callback
Get the web display mode of the manifest.
- Since :
- 3.0
- Parameters:
-
[in] manifest Manifest object to get manifest information.
- Returns:
web
display mode enum if web display mode exists otherwise WebDisplayModeUndefined. The enum is only valid until related Ewk_View_Request_Manifest object is valid.
- See also:
- Ewk_View_Request_Manifest_Callback
const char* ewk_policy_decision_cookie_get | ( | Ewk_Policy_Decision * | policy_decision | ) |
Returns a cookie from the Policy Decision object.
- Since :
- 2.3
- Parameters:
-
[in] policy_decision The policy decision object
- Returns:
- The cookie string on success,
otherwise an empty string on failure
const char* ewk_policy_decision_host_get | ( | Ewk_Policy_Decision * | policy_decision | ) |
Returns a host from the Policy Decision object.
- Since :
- 2.3
- Parameters:
-
[in] policy_decision The policy decision object
- Returns:
- The host string on success,
otherwise an empty string on failure
const char* ewk_policy_decision_http_method_get | ( | Ewk_Policy_Decision * | policy_decision | ) |
Returns an HTTP method from the Policy Decision object.
- Since :
- 2.3
- Parameters:
-
[in] policy_decision The policy decision object
- Returns:
- The HTTP method string on success,
otherwise an empty string on failure
Eina_Bool ewk_policy_decision_ignore | ( | Ewk_Policy_Decision * | policy_decision | ) |
Ignores the action which triggers this decision.
- Since :
- 2.3
- Parameters:
-
[in] policy_decision The policy decision object
- Returns:
EINA_TRUE
on success,
otherwiseEINA_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.
- Since :
- 2.3
- Parameters:
-
[in] policy_decision The policy decision object
- Returns:
- The navigation type
const Eina_Hash* ewk_policy_decision_response_headers_get | ( | Ewk_Policy_Decision * | policy_decision | ) |
Return HTTP headers for response data from the Policy Decision object.
- Since :
- 2.3
- Parameters:
-
[in] policy_decision The policy decision object
- Returns:
- The HTTP headers on success,
otherwiseNULL
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.
- Since :
- 2.3
- Parameters:
-
[in] policy_decision policy decision object
- Returns:
- The MIME type string on success,
otherwise an empty string on failure
int ewk_policy_decision_response_status_code_get | ( | Ewk_Policy_Decision * | policy_decision | ) |
Returns an HTTP status code from the Policy Decision object.
- Since :
- 2.3
- Parameters:
-
[in] policy_decision The policy decision object
- Returns:
- The HTTP status code number
const char* ewk_policy_decision_scheme_get | ( | Ewk_Policy_Decision * | policy_decision | ) |
Returns a scheme from the Policy Decision object.
- Since :
- 2.3
- Parameters:
-
[in] policy_decision The policy decision object
- Returns:
- The scheme string on success,
otherwise an empty string on failure
Ewk_Policy_Decision_Type ewk_policy_decision_type_get | ( | const Ewk_Policy_Decision * | policy_decision | ) |
Returns a policy type from the Policy Decision object.
- Since :
- 2.3
- Parameters:
-
[in] policy_decision The policy decision object
- Returns:
- The policy type
const char* ewk_policy_decision_url_get | ( | Ewk_Policy_Decision * | policy_decision | ) |
Returns a URL from the Policy Decision object.
- Since :
- 2.3
- Parameters:
-
[in] policy_decision The policy decision object
- Returns:
- The URL string on success,
otherwise an empty string on failure
Eina_Bool ewk_policy_decision_use | ( | Ewk_Policy_Decision * | policy_decision | ) |
Accepts the action which triggers this decision.
- Since :
- 2.3
- Parameters:
-
[in] policy_decision The policy decision object
- Returns:
EINA_TRUE
on success,
otherwiseEINA_FALSE
on failure
Eina_Stringshare* ewk_security_origin_host_get | ( | const Ewk_Security_Origin * | origin | ) |
Requests for getting host of security origin.
- Since :
- 2.4
- Parameters:
-
[in] origin Security origin
- Returns:
- host of security origin
Eina_Stringshare* ewk_security_origin_protocol_get | ( | const Ewk_Security_Origin * | origin | ) |
Requests for getting host of security origin.
- Since :
- 2.4
- Parameters:
-
[in] origin Security origin
- Returns:
- host of security origin
Eina_Bool ewk_settings_auto_fitting_get | ( | const Ewk_Settings * | settings | ) |
Returns the auto fit status.
- Since :
- 2.3
- Parameters:
-
[in] settings The settings object to fit to width
- Returns:
EINA_TRUE
if auto fit is enabled,
otherwiseEINA_FALSE
Eina_Bool ewk_settings_auto_fitting_set | ( | Ewk_Settings * | settings, |
Eina_Bool | enable | ||
) |
Requests setting of auto fit.
- Since :
- 2.3
- Parameters:
-
[in] settings The settings object to fit to width [in] enable If true
the settings object is fit to width,
otherwisefalse
- Returns:
EINA_TRUE
on success,
otherwiseEINA_FALSE
on failure
Eina_Bool ewk_settings_autofill_password_form_enabled_set | ( | Ewk_Settings * | settings, |
Eina_Bool | enable | ||
) |
Requests enable/disable password form autofill.
- Since :
- 2.4
- Parameters:
-
[in] settings Settings object to set password form autofill [in] enable EINA_TRUE
to enable password form autofillEINA_FALSE
to disable
- Returns:
EINA_TRUE
on success, otherwiseEINA_FALSE
int ewk_settings_default_font_size_get | ( | const Ewk_Settings * | settings | ) |
Returns the default font size.
- Since :
- 2.3
- Parameters:
-
[in] settings The settings object to get the default font size
- Returns:
- The default font size,
otherwise0
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
.
- Since :
- 2.3
- Parameters:
-
[in] settings The settings object to set the default font size [in] size A new default font size to set
- Returns:
EINA_TRUE
on success,
otherwiseEINA_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.
- Since :
- 2.3
- Parameters:
-
[in] settings The settings object to query the default text encoding name
- Returns:
- 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.
- Since :
- 2.3
- Parameters:
-
[in] settings The settings object to set the default text encoding name [in] encoding The default text encoding name
- Returns:
EINA_TRUE
on success,
otherwiseEINA_FALSE
on failure
Eina_Bool ewk_settings_form_candidate_data_enabled_set | ( | Ewk_Settings * | settings, |
Eina_Bool | enable | ||
) |
Requests enable/disable form candidate data for autofill.
- Since :
- 2.4
- Parameters:
-
[in] settings Settings object to set form candidate data for autofill [in] enable EINA_TRUE
to enable form candidate data for autofillEINA_FALSE
to disable
- Returns:
EINA_TRUE
on success, otherwiseEINA_FALSE
Eina_Bool ewk_settings_form_profile_data_enabled_set | ( | Ewk_Settings * | settings, |
Eina_Bool | enable | ||
) |
Enables/disables form autofill profile feature.
- Since :
- 2.4
- Parameters:
-
[in] settings Settings object to set the form autofill profile [in] enable EINA_TRUE
to enable the text autosizingEINA_FALSE
to disable
- Returns:
EINA_TRUE
on success, otherwiseEINA_FALSE
Eina_Bool ewk_settings_javascript_enabled_get | ( | const Ewk_Settings * | settings | ) |
Returns whether JavaScript can be executable.
- Since :
- 2.3
- Parameters:
-
[in] settings The settings object to query if JavaScript can be executed
- Returns:
EINA_TRUE
if JavaScript can be executed,
otherwiseEINA_FALSE
if not or on failure
Eina_Bool ewk_settings_javascript_enabled_set | ( | Ewk_Settings * | settings, |
Eina_Bool | enable | ||
) |
Enables/disables JavaScript executing.
- Since :
- 2.3
- Parameters:
-
[in] settings The settings object to set JavaScript executing [in] enable If EINA_TRUE
JavaScript executing is enabled,
otherwiseEINA_FALSE
to disable it
- Returns:
EINA_TRUE
on success,
otherwiseEINA_FALSE
on failure
Eina_Bool ewk_settings_loads_images_automatically_get | ( | const Ewk_Settings * | settings | ) |
Returns whether images can be loaded automatically.
- Since :
- 2.3
- Parameters:
-
[in] settings The settings object to get auto loading of images
- Returns:
EINA_TRUE
if images are loaded automatically,
otherwiseEINA_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.
- Since :
- 2.3
- Parameters:
-
[in] settings The settings object to set auto loading of images [in] automatic If EINA_TRUE
auto loading of images is enabled,
otherwiseEINA_FALSE
to disable it
- Returns:
EINA_TRUE
on success,
otherwiseEINA_FALSE
on failure
Eina_Bool ewk_settings_scripts_can_open_windows_get | ( | const Ewk_Settings * | settings | ) |
Returns whether the scripts can open new windows.
- Since :
- 2.3
- Parameters:
-
[in] settings The settings object to query whether the scripts can open new windows
- Returns:
EINA_TRUE
if the scripts can open new windows
otherwiseEINA_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.
- Since :
- 2.3
- Parameters:
-
[in] settings The settings object to set if the scripts can open new windows [in] enable If EINA_TRUE
the scripts can open new windows
otherwiseEINA_FALSE
if not
- Returns:
EINA_TRUE
on success,
otherwiseEINA_FALSE
on failure (scripts are disabled)
Eina_Bool ewk_settings_viewport_meta_tag_get | ( | const Ewk_Settings * | settings | ) |
Returns whether the viewport meta tag is enabled.
- Parameters:
-
settings settings object
- Returns:
EINA_TRUE
if the viewport meta tag is enabledEINA_FALSE
if not or on failure
Eina_Bool ewk_settings_viewport_meta_tag_set | ( | Ewk_Settings * | settings, |
Eina_Bool | enable | ||
) |
Enables/disables the viewport meta tag.
By default, the viewport meta tag is enabled on mobile and wearable, but it is disabled on TV.
- Parameters:
-
settings settings object enable EINA_TRUE
to enable the viewport meta tagEINA_FALSE
to disable
- Returns:
EINA_TRUE
on success orEINA_FALSE
on failure
int ewk_shutdown | ( | void | ) |
Decreases a reference count of Chromium's instance, possibly destroying it.
If the reference count reaches 0
, Chromium's instance is destroyed.
- Since :
- 2.3
- Returns:
- A reference count of Chromium's instance
Evas_Object* ewk_view_add | ( | Evas * | e | ) |
Creates a new EFL Chromium view object.
- Since :
- 2.3
- Parameters:
-
[in] e The canvas object where to create the view object
- Returns:
- The view object on success,
otherwiseNULL
on failure
Creates a new EFL web view object in incognito mode.
- Since :
- 3.0
- Parameters:
-
[in] e The canvas object where to create the view object
- Returns:
- The view object on success,
otherwiseNULL
on failure
Eina_Bool ewk_view_back | ( | Evas_Object * | o | ) |
Asks the main frame to navigate back in history.
- Since :
- 2.3
- Parameters:
-
[in] o The view object to navigate back
- Returns:
EINA_TRUE
on success,
otherwiseEINA_FALSE
void ewk_view_back_forward_list_clear | ( | const Evas_Object * | o | ) |
Clears the back-forward list of a page.
- Since :
- 2.3
- Parameters:
-
[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.
- Since :
- 2.3
- Parameters:
-
[in] o The view object to get the back-forward navigation list
- Returns:
- The back-forward list instance handle associated with this view
Checks whether it is possible to navigate backwards one item in history.
- Since :
- 2.3
- Parameters:
-
[in] o The view object to query if backward navigation is possible
- Returns:
EINA_TRUE
if it is possible to navigate backwards in history,
otherwiseEINA_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.
- Since :
- 2.3
- Parameters:
-
[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
- Returns:
EINA_TRUE
on a successful request,
otherwiseEINA_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.
- Since :
- 2.3
- Parameters:
-
[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
- Returns:
EINA_TRUE
on success,
otherwiseEINA_FALSE
on failure and
width and height are zeroed
Ewk_Context* ewk_view_context_get | ( | const Evas_Object * | o | ) |
Gets the Ewk_Context of this view.
- Since :
- 2.3
- Parameters:
-
[in] o The view object to get the Ewk_Context
- Returns:
- The Ewk_Context of this view,
otherwiseNULL
on failure
Eina_Bool ewk_view_evaluate_javascript | ( | Evas_Object * | o, |
const char * | name, | ||
const char * | result | ||
) |
Requests the execution of given name & result to the JavaScript runtime.
- Since :
- 3.0
- Parameters:
-
[in] o The view object [in] name The name used to expose the object in JavaScript [in] result The result to the JavaScript runtime
- Returns:
EINA_TRUE
on success,
otherwiseEINA_FALSE
Eina_Bool ewk_view_focus_get | ( | const Evas_Object * | o | ) |
Checks whether a web view has the focus.
- Since :
- 3.0
- Parameters:
-
[in] o The view object.
- Returns:
EINA_TRUE
if the web view has the focus, otherwiseEINA_FALSE
Eina_Bool ewk_view_focus_set | ( | const Evas_Object * | o, |
Eina_Bool | focused | ||
) |
Requests to set or unset a web view as the currently focused one.
- Since :
- 3.0
- Parameters:
-
[in] o The view object. [in] focused EINA_TRUE
to set the focus on the web view,EINA_FALSE
to remove the focus from the web view.
- Returns:
EINA_TRUE
on success, otherwiseEINA_FALSE
Eina_Bool ewk_view_forward | ( | Evas_Object * | o | ) |
Asks the main frame to navigate forward in history.
- Since :
- 2.3
- Parameters:
-
[in] o The view object to navigate forward
- Returns:
EINA_TRUE
on success,
otherwiseEINA_FALSE
Checks whether it is possible to navigate forwards one item in history.
- Since :
- 2.3
- Parameters:
-
[in] o The view object to query if forward navigation is possible
- Returns:
EINA_TRUE
if it is possible to navigate forwards in history,
otherwiseEINA_FALSE
Exits fullscreen when the back key is pressed.
- Since :
- 2.3
- Parameters:
-
[in] o The view object to exit the fullscreen mode
- Returns:
EINA_TRUE
on success,
otherwiseEINA_FALSE
Eina_Bool ewk_view_html_string_load | ( | Evas_Object * | o, |
const char * | html, | ||
const char * | base_url, | ||
const char * | unreachable_url | ||
) |
Loads the specified html string as the content of the view.
External objects such as stylesheets or images referenced in the HTML
document are located relative to baseUrl.
- Remarks:
- There is an alternative API ewk_view_html_string_override_current_entry_load() which is able to override current entry which prevents from backing back to malicious page.
If an unreachableUrl is passed it is used as the url for the loaded content.
This is typically used to display error pages for a failed load.
- Since :
- 2.4
- Parameters:
-
[in] o view object to load the HTML into [in] html HTML data to load [in] base_url Base URL used for relative paths to external objects (optional) [in] unreachable_url URL that could not be reached (optional)
- Returns:
EINA_TRUE
if it the HTML was successfully loaded,EINA_FALSE
otherwise
Eina_Bool ewk_view_javascript_message_handler_add | ( | Evas_Object * | o, |
Ewk_View_Script_Message_Cb | callback, | ||
const char * | name | ||
) |
Injects the supplied javascript message handler into webview.
- Since :
- 3.0
- Remarks:
- Note that injected objects will not appear in JavaScript until the page is next (re)loaded.
Certainly, specify privileges of using native API to users, if using native API affects system settings, stability or security. Privilege display name & description which will be noticed to user.
- Parameters:
-
[in] o The view object [in] callback The result callback [in] name The name used to expose the object in JavaScript
- Returns:
EINA_TRUE
on success,
otherwiseEINA_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
.
- Since :
- 2.3
- Parameters:
-
[in] o The view object to get the current progress
- Returns:
- The load progress of the page, value from
0.0
to1.0
,
otherwise-1.0
on failure
void ewk_view_orientation_send | ( | Evas_Object * | o, |
int | orientation | ||
) |
Sends the orientation of the device.
If orientation value is changed, orientationchanged event will occur.
- Since :
- 2.4
- Parameters:
-
[in] o View object to receive orientation event. [in] orientation The new orientation of the device. (degree)
orientation will be 0 degrees when the device is oriented to natural position ,-90 degrees when it's left side is at the top , 90 degrees when it's right side is at the top ,180 degrees when it is upside down.
const char* ewk_view_original_url_get | ( | const Evas_Object * | o | ) |
Returns the original URL string of the view object.
It returns an internal string that should not be modified.
The string is guaranteed to be stringshared.
- Since :
- 4.0
- Parameters:
-
[in] o The view object to get the original URL
- Returns:
- The original URL on success,
otherwiseNULL
on failure
Eina_Bool ewk_view_reload | ( | Evas_Object * | o | ) |
Asks the main frame to reload the current document.
- Since :
- 2.3
- Parameters:
-
[in] o The view object to reload the current document
- Returns:
EINA_TRUE
on success,
otherwiseEINA_FALSE
void ewk_view_request_manifest | ( | Evas_Object * | o, |
Ewk_View_Request_Manifest_Callback | callback, | ||
void * | user_data | ||
) |
Requests the manifest data of current's page.
- Since :
- 3.0
- Parameters:
-
[in] o view object to request the manifest information [in] callback Ewk_View_Request_Manifest_Callback function to request manifest information [in] user_data user data
- See also:
- Ewk_View_Request_Manifest_Callback
void ewk_view_resume | ( | Evas_Object * | o | ) |
Resumes the operation associated with the view object after calling ewk_view_suspend().
- Since :
- 2.3
- Parameters:
-
[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.
- Since :
- 2.3
- Parameters:
-
[in] o The view object to get the scale factor of
- Returns:
- The current scale factor in use on success,
otherwise-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.
- Since :
- 2.3
- Parameters:
-
[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
- Returns:
EINA_TRUE
on success,
otherwise EINA_FALSE
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.
- Since :
- 2.3
- Remarks:
- This allows to use
NULL
for the callback parameter
So, if the result data from the script is not required,NULL
might be used for the callback parameter
Also, script should be valid statement according to JavaScript language
If script is empty, NULL or invalid statement, this function returnsEINA_FALSE
- Parameters:
-
[in] o The view object to execute the script [in] script The JavaScript code string to execute [in] callback The result callback [in] user_data The user data
- Returns:
EINA_TRUE
on success,
otherwiseEINA_FALSE
on failure
void ewk_view_scroll_by | ( | Evas_Object * | o, |
int | dx, | ||
int | dy | ||
) |
Scrolls the webpage of view by dx and dy.
- Since :
- 2.3
- Parameters:
-
[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.
- Since :
- 2.3
- Parameters:
-
[in] o The view object to get the current scroll position [in] x The pointer to store the horizontal position, may be NULL
[in] y The pointer to store the vertical position, may be NULL
- Returns:
EINA_TRUE
on success,
otherwiseEINA_FALSE
Eina_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.
- Since :
- 2.3
- Parameters:
-
[in] o The view object to scroll [in] x The horizontal position to scroll [in] y The vertical position to scroll
- Returns:
EINA_TRUE
on success,
otherwiseEINA_FALSE
Ewk_Settings* ewk_view_settings_get | ( | const Evas_Object * | o | ) |
Gets the Ewk_Settings of this view.
- Since :
- 2.3
- Parameters:
-
[in] o The view object to get the Ewk_Settings
- Returns:
- The Ewk_Settings of this view,
otherwiseNULL
on failure
Eina_Bool ewk_view_stop | ( | Evas_Object * | o | ) |
Asks the main frame to stop loading.
- Since :
- 2.3
- Parameters:
-
[in] o The view object to stop loading
- Returns:
EINA_TRUE
on success,
otherwiseEINA_FALSE
void ewk_view_suspend | ( | Evas_Object * | o | ) |
Suspends the operation associated with the view object.
- Since :
- 2.3
- Parameters:
-
[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.
- Since :
- 2.3
- Parameters:
-
[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
- Returns:
EINA_TRUE
on success,
otherwise EINA_FALSE on errors
Clears the current selection.
- Since :
- 2.4
- Parameters:
-
[in] o View object with selection in progress
- Returns:
EINA_TRUE
on success, otherwiseEINA_FALSE
const char* ewk_view_text_selection_text_get | ( | Evas_Object * | o | ) |
Returns the selection text.
Returned string becomes invalidated upon next call to this api.
- Since :
- 2.4
- Parameters:
-
[in] o View object to get selection text.
- Returns:
selection
text, otherwiseNULL
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.
- Since :
- 2.3
- Parameters:
-
[in] o The view object to get the current title
- Returns:
- The current title on success,
otherwiseNULL
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.
- Since :
- 2.3
- Parameters:
-
[in] o The view object to get the current URL
- Returns:
- The current URL on success,
otherwiseNULL
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.
- Since :
- 2.3
- Parameters:
-
[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
- Returns:
EINA_TRUE
on a successful request,
otherwiseEINA_FALSE
on failure
Eina_Bool ewk_view_url_set | ( | Evas_Object * | o, |
const char * | url | ||
) |
Asks the object to load the given URL.
- Remarks:
- You can only be sure that url changed after ewk view
smart callback 'url,changed' is called. This is important for
EWK API functions which operate on pages.
- Since :
- 2.3
- Parameters:
-
[in] o The view object to load url [in] url The uniform resource identifier to load
- Returns:
EINA_TRUE
if o is valid, irrespective of load,
otherwiseEINA_FALSE
on failure
const char* ewk_view_user_agent_get | ( | const Evas_Object * | o | ) |
Returns the user agent string.
- Since :
- 2.3
- Parameters:
-
[in] o The view object to get the user agent string
- Returns:
- 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.
- Since :
- 2.3
- Parameters:
-
[in] o The view object to set the user agent string [in] user_agent The user agent string to set,
otherwiseNULL
to restore the default one
- Returns:
EINA_TRUE
on success,
otherwiseEINA_FALSE
on failure
Eina_Bool ewk_view_visibility_set | ( | Evas_Object * | o, |
Eina_Bool | enable | ||
) |
Request to set the current page's visibility.
- Since :
- 2.4
- Parameters:
-
[in] o View object to set the visibility. [in] enable EINA_TRUE to set on the visibility of the page, EINA_FALSE otherwise.
- Returns:
EINA_TRUE
on success, otherwiseEINA_FALSE