/* Copyright (C) 2011 Samsung Electronics Copyright (C) 2012 Intel Corporation. All rights reserved. Copyright (C) 2015 Naver Corp. All rights reserved. This library is free software; you can redistribute it and/or modify it under the terms of the GNU Library General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public License for more details. You should have received a copy of the GNU Library General Public License along with this library; see the file COPYING.LIB. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. */ /** * @file ewk_view.h * @brief WebKit main smart object. * * This object provides view related APIs of WebKit2 to EFL object. * * The following signals (see evas_object_smart_callback_add()) are emitted: * * - "authentication,request", Ewk_Auth_Request*: reports that user authentication was requested. Call * ewk_auth_request_ref() on the request object to process the authentication asynchronously. * - "back,forward,list,changed", void: reports that the view's back / forward list had changed. * - "cancel,vibration", void: request to cancel the vibration. * - "contents,size,changed", Ewk_CSS_Size*: reports that contents size was changed. * - "file,chooser,request", Ewk_File_Chooser_Request*: reports that a request has been made for the user to choose * a file (or several) on the file system. Call ewk_file_chooser_request_ref() on the request object to process it * asynchronously. * - "focus,notfound", Ewk_Focus_Direction*: reports that there was no element to be focused on the given direction. * The user can handle next focus behavior using the signal. * - "form,submission,request", Ewk_Form_Submission_Request*: Reports that a form request is about to be submitted. * The Ewk_Form_Submission_Request passed contains information about the text fields of the form. This * is typically used to store login information that can be used later to pre-fill the form. * The form will not be submitted until ewk_form_submission_request_submit() is called. * It is possible to handle the form submission request asynchronously, by simply calling * ewk_form_submission_request_ref() on the request and calling ewk_form_submission_request_submit() * when done to continue with the form submission. If the last reference is removed on a * #Ewk_Form_Submission_Request and the form has not been submitted yet, * ewk_form_submission_request_submit() will be called automatically. * - "load,error", const Ewk_Error*: reports main frame load failed. * - "load,finished", void: reports load finished. * - "load,progress", double*: load progress has changed (value from 0.0 to 1.0). * - "load,provisional,failed", const Ewk_Error*: view provisional load failed. * - "load,provisional,redirect", void: view received redirect for provisional load. * - "load,provisional,started", void: view started provisional load. * - "policy,decision,navigation", Ewk_Navigation_Policy_Decision*: a navigation policy decision should be taken. * To make a policy decision asynchronously, simply increment the reference count of the * #Ewk_Navigation_Policy_Decision object using ewk_navigation_policy_decision_ref(). * - "policy,decision,new,window", Ewk_Navigation_Policy_Decision*: a new window policy decision should be taken. * To make a policy decision asynchronously, simply increment the reference count of the * #Ewk_Navigation_Policy_Decision object using ewk_navigation_policy_decision_ref(). * - "text,found", unsigned int*: the requested text was found and it gives the number of matches. * - "title,changed", const char*: title of the main frame was changed. * - "tooltip,text,set", const char*: tooltip was set. * - "tooltip,text,unset", void: tooltip was unset. * - "url,changed", const char*: url of the main frame was changed. * - "vibrate", uint64_t*: request to vibrate. (value is vibration time) * - "webprocess,crashed", Eina_Bool*: expects a @c EINA_TRUE if web process crash is handled; @c EINA_FALSE, otherwise. */ #ifndef ewk_view_h #define ewk_view_h #include "ewk_back_forward_list.h" #include "ewk_color_picker.h" #include "ewk_context.h" #include "ewk_context_menu.h" #include "ewk_download_job.h" #include "ewk_page_group.h" #include "ewk_popup_menu.h" #include "ewk_security_origin.h" #include "ewk_touch.h" #include "ewk_url_request.h" #include "ewk_url_response.h" #include "ewk_view_configuration.h" #include "ewk_window_features.h" #include <Evas.h> #ifdef __cplusplus extern "C" { #endif /// Enum values containing text directionality values. typedef enum { EWK_TEXT_DIRECTION_RIGHT_TO_LEFT, EWK_TEXT_DIRECTION_LEFT_TO_RIGHT } Ewk_Text_Direction; /// Enum values containing page contents type values. typedef enum { EWK_PAGE_CONTENTS_TYPE_MHTML, EWK_PAGE_CONTENTS_TYPE_STRING } Ewk_Page_Contents_Type; typedef struct Ewk_View_Smart_Data Ewk_View_Smart_Data; typedef struct Ewk_View_Smart_Class Ewk_View_Smart_Class; /// Ewk view's class, to be overridden by sub-classes. struct Ewk_View_Smart_Class { Evas_Smart_Class sc; /**< all but 'data' is free to be changed. */ unsigned long version; Eina_Bool (*custom_item_selected)(Ewk_View_Smart_Data *sd, Ewk_Context_Menu_Item *item); Eina_Bool (*context_menu_show)(Ewk_View_Smart_Data *sd, Evas_Coord x, Evas_Coord y, Ewk_Context_Menu *menu); Eina_Bool (*context_menu_hide)(Ewk_View_Smart_Data *sd); /** * @brief smart method to notify that \<select\> tag is pressed. * * Application should implement this method to support select tag. * * @note After @c popup_menu_hide is called, @a menu will not be valid. * * @see ewk_popup_menu_selected_index_get * @see ewk_popup_menu_selected_index_set * @see ewk_popup_menu_close */ Eina_Bool (*popup_menu_show)(Ewk_View_Smart_Data *sd, Eina_Rectangle rect, Ewk_Text_Direction text_direction, double page_scale_factor, Ewk_Popup_Menu *menu); /** * @brief smart method to notify that current @a menu will be hidden and destroyed. * * @see ewk_popup_menu_selected_index_get * @see ewk_popup_menu_selected_index_set * @see ewk_popup_menu_close */ Eina_Bool (*popup_menu_hide)(Ewk_View_Smart_Data *sd); // event handling: // - returns true if handled // - if overridden, have to call parent method if desired Eina_Bool (*focus_in)(Ewk_View_Smart_Data *sd); Eina_Bool (*focus_out)(Ewk_View_Smart_Data *sd); Eina_Bool (*fullscreen_enter)(Ewk_View_Smart_Data *sd, Ewk_Security_Origin *origin); Eina_Bool (*fullscreen_exit)(Ewk_View_Smart_Data *sd); Eina_Bool (*mouse_wheel)(Ewk_View_Smart_Data *sd, const Evas_Event_Mouse_Wheel *ev); Eina_Bool (*mouse_down)(Ewk_View_Smart_Data *sd, const Evas_Event_Mouse_Down *ev); Eina_Bool (*mouse_up)(Ewk_View_Smart_Data *sd, const Evas_Event_Mouse_Up *ev); Eina_Bool (*mouse_move)(Ewk_View_Smart_Data *sd, const Evas_Event_Mouse_Move *ev); Eina_Bool (*key_down)(Ewk_View_Smart_Data *sd, const Evas_Event_Key_Down *ev); Eina_Bool (*key_up)(Ewk_View_Smart_Data *sd, const Evas_Event_Key_Up *ev); Eina_Bool (*window_geometry_set)(Ewk_View_Smart_Data *sd, Evas_Coord x, Evas_Coord y, Evas_Coord width, Evas_Coord height); Eina_Bool (*window_geometry_get)(Ewk_View_Smart_Data *sd, Evas_Coord *x, Evas_Coord *y, Evas_Coord *width, Evas_Coord *height); // javascript popup: // - All strings should be guaranteed to be stringshared. void (*run_javascript_alert)(Ewk_View_Smart_Data *sd, const char *message); Eina_Bool (*run_javascript_confirm)(Ewk_View_Smart_Data *sd, const char *message); const char *(*run_javascript_prompt)(Ewk_View_Smart_Data *sd, const char *message, const char *default_value); /**< return string should be stringshared. */ Eina_Bool (*run_javascript_before_unload_confirm)(Ewk_View_Smart_Data *sd, const char *message); // color picker: // - Shows and hides color picker. Eina_Bool (*input_picker_color_request)(Ewk_View_Smart_Data *sd, Ewk_Color_Picker *color_picker); Eina_Bool (*input_picker_color_dismiss)(Ewk_View_Smart_Data *sd); // storage: // - Web database. unsigned long long (*exceeded_database_quota)(Ewk_View_Smart_Data *sd, const char *databaseName, const char *displayName, unsigned long long currentQuota, unsigned long long currentOriginUsage, unsigned long long currentDatabaseUsage, unsigned long long expectedUsage); // window creation and closing: // - Create a new window with specified features and close window. Evas_Object *(*window_create)(Ewk_View_Smart_Data *sd, Ewk_View_Configuration* configuration, const Ewk_Window_Features *window_features); void (*window_close)(Ewk_View_Smart_Data *sd); }; /** * The version you have to put into the version field * in the @a Ewk_View_Smart_Class structure. */ #define EWK_VIEW_SMART_CLASS_VERSION 9UL /** * Initializer for whole Ewk_View_Smart_Class structure. * * @param smart_class_init initializer to use for the "base" field * (Evas_Smart_Class). * * @see EWK_VIEW_SMART_CLASS_INIT_NULL * @see EWK_VIEW_SMART_CLASS_INIT_VERSION * @see EWK_VIEW_SMART_CLASS_INIT_NAME_VERSION */ #define EWK_VIEW_SMART_CLASS_INIT(smart_class_init) {smart_class_init, EWK_VIEW_SMART_CLASS_VERSION, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0} /** * Initializer to zero a whole Ewk_View_Smart_Class structure. * * @see EWK_VIEW_SMART_CLASS_INIT_VERSION * @see EWK_VIEW_SMART_CLASS_INIT_NAME_VERSION * @see EWK_VIEW_SMART_CLASS_INIT */ #define EWK_VIEW_SMART_CLASS_INIT_NULL EWK_VIEW_SMART_CLASS_INIT(EVAS_SMART_CLASS_INIT_NULL) /** * Initializer to zero a whole Ewk_View_Smart_Class structure and set * name and version. * * Similar to EWK_VIEW_SMART_CLASS_INIT_NULL, but will set version field of * Evas_Smart_Class (base field) to latest EVAS_SMART_CLASS_VERSION and name * to the specific value. * * It will keep a reference to name field as a "const char *", that is, * name must be available while the structure is used (hint: static or global!) * and will not be modified. * * @see EWK_VIEW_SMART_CLASS_INIT_NULL * @see EWK_VIEW_SMART_CLASS_INIT_VERSION * @see EWK_VIEW_SMART_CLASS_INIT */ #define EWK_VIEW_SMART_CLASS_INIT_NAME_VERSION(name) EWK_VIEW_SMART_CLASS_INIT(EVAS_SMART_CLASS_INIT_NAME_VERSION(name)) #ifdef __cplusplus typedef class EwkView EwkView; #else typedef struct EwkView EwkView; #endif /** * @brief Contains an internal View data. * * It is to be considered private by users, but may be extended or * changed by sub-classes (that's why it's in public header file). */ struct Ewk_View_Smart_Data { Evas_Object_Smart_Clipped_Data base; const Ewk_View_Smart_Class* api; /**< reference to casted class instance */ Evas_Object* self; /**< reference to owner object */ Evas_Object* image; /**< reference to evas_object_image for drawing web contents */ EwkView* priv; /**< should never be accessed, c++ stuff */ struct { Evas_Coord x, y, w, h; /**< last used viewport */ } view; struct { /**< what changed since last smart_calculate */ Eina_Bool any:1; Eina_Bool size:1; Eina_Bool position:1; } changed; }; /// Creates a type name for Ewk_CSS_Size. typedef struct Ewk_CSS_Size Ewk_CSS_Size; /** * @brief Structure representing size. */ struct Ewk_CSS_Size { Evas_Coord w; /**< width */ Evas_Coord h; /**< height */ }; /** * Enum values used to specify search options. * @brief Provides option to find text */ enum Ewk_Find_Options { EWK_FIND_OPTIONS_NONE, /**< no search flags, this means a case sensitive, no wrap, forward only search. */ EWK_FIND_OPTIONS_CASE_INSENSITIVE = 1 << 0, /**< case insensitive search. */ EWK_FIND_OPTIONS_AT_WORD_STARTS = 1 << 1, /**< search text only at the beginning of the words. */ EWK_FIND_OPTIONS_TREAT_MEDIAL_CAPITAL_AS_WORD_START = 1 << 2, /**< treat capital letters in the middle of words as word start. */ EWK_FIND_OPTIONS_BACKWARDS = 1 << 3, /**< search backwards. */ EWK_FIND_OPTIONS_WRAP_AROUND = 1 << 4, /**< if not present search will stop at the end of the document. */ EWK_FIND_OPTIONS_SHOW_OVERLAY = 1 << 5, /**< show overlay */ EWK_FIND_OPTIONS_SHOW_FIND_INDICATOR = 1 << 6, /**< show indicator */ EWK_FIND_OPTIONS_SHOW_HIGHLIGHT = 1 << 7 /**< show highlight */ }; typedef enum Ewk_Find_Options Ewk_Find_Options; /** * Enum values used to set pagination mode. */ typedef enum { EWK_PAGINATION_MODE_INVALID = -1, /**< invalid pagination mode that will be returned when error occured. */ EWK_PAGINATION_MODE_UNPAGINATED, /**< default mode for pagination. not paginated */ EWK_PAGINATION_MODE_LEFT_TO_RIGHT, /**< go to the next page with scrolling left to right horizontally. */ EWK_PAGINATION_MODE_RIGHT_TO_LEFT, /**< go to the next page with scrolling right to left horizontally. */ EWK_PAGINATION_MODE_TOP_TO_BOTTOM, /**< go to the next page with scrolling top to bottom vertically. */ EWK_PAGINATION_MODE_BOTTOM_TO_TOP /**< go to the next page with scrolling bottom to top vertically. */ } Ewk_Pagination_Mode; /** * Enum values used to set focus direction. */ typedef enum Ewk_Focus_Direction { EWK_FOCUS_DIRECTION_FORWARD = 0, EWK_FOCUS_DIRECTION_BACKWARD, } Ewk_Focus_Direction; /** * @typedef Ewk_View_Script_Execute_Cb Ewk_View_Script_Execute_Cb * @brief Callback type for use with ewk_view_script_execute() */ typedef void (*Ewk_View_Script_Execute_Cb)(Evas_Object *o, const char *return_value, void *user_data); /** * Creates a type name for the callback function used to get the page contents. * * @param type type of the contents * @param data string buffer of the contents * @param user_data user data will be passed when ewk_view_page_contents_get is called */ typedef void (*Ewk_Page_Contents_Cb)(Ewk_Page_Contents_Type type, const char *data, void *user_data); /** * Sets the smart class APIs, enabling view to be inherited. * * @param api class definition to set, all members with the * exception of @a Evas_Smart_Class->data may be overridden, must * @b not be @c NULL * * @note @a Evas_Smart_Class->data is used to implement type checking and * is not supposed to be changed/overridden. If you need extra * data for your smart class to work, just extend * Ewk_View_Smart_Class instead. * The Evas_Object which inherits the ewk_view should use * ewk_view_smart_add() to create Evas_Object instead of * evas_object_smart_add() because it performs additional initialization * for the ewk_view. * * @return @c EINA_TRUE on success or @c EINA_FALSE on failure (probably * version mismatch) * * @see ewk_view_smart_add() */ EAPI Eina_Bool ewk_view_smart_class_set(Ewk_View_Smart_Class *api); /** * Creates a new EFL WebKit view object with Evas_Smart and Ewk_Context. * * @note The Evas_Object which inherits the ewk_view should create its * Evas_Object using this API instead of evas_object_smart_add() * because the default initialization for ewk_view is done in this API. * * @param e canvas object where to create the view object * @param smart Evas_Smart object. Its type should be EWK_VIEW_TYPE_STR * @param context Ewk_Context object which is used for initializing * @param pageGroup Ewk_Page_Group object which is used for initializing * * @return view object on success or @c NULL on failure * * @see ewk_view_add_with_configuration */ EAPI Evas_Object *ewk_view_smart_add(Evas *e, Evas_Smart *smart, Ewk_Context *context, Ewk_Page_Group *pageGroup); /** * Creates a new EFL WebKit view object with Ewk_View_Configuration * * @note The Evas_Object which inherits the ewk_view should create its * Evas_Object using this API instead of evas_object_smart_add() * because the default initialization for ewk_view is done in this API. * * @param e canvas object where to create the view object * @param smart Evas_Smart object. Its type should be EWK_VIEW_TYPE_STR * @param configuration Ewk_View_Configuration object which is used for initializing or @c NULL to use default configuration * * @return view object on success or @c NULL on failure * * @see window_create * @see ewk_view_configuration_new */ EAPI Evas_Object *ewk_view_add_with_configuration(Evas *e, Evas_Smart *smart, Ewk_View_Configuration *configuration); /** * Creates a new EFL WebKit view object. * * @param e canvas object where to create the view object * * @return view object on success or @c NULL on failure * * @see ewk_view_add_with_configuration */ EAPI Evas_Object *ewk_view_add(Evas *e); /** * Creates a new EFL WebKit view object based on specific Ewk_Context. * * @param e canvas object where to create the view object * @param context Ewk_Context object to declare process model * * @return view object on success or @c NULL on failure * * @see ewk_view_add_with_configuration */ EAPI Evas_Object *ewk_view_add_with_context(Evas *e, Ewk_Context *context); /** * Tries to close this view. * * If current web page in @a o contains onbeforeunload event, this will fire * run_javascript_confirm callback in smart class. * If not, this will fire window_close callback in smart class. * * @param o the view object to try to close. */ EAPI void ewk_view_try_close(Evas_Object *o); /** * Gets the Ewk_Context of this view. * * @param o the view object to get the Ewk_Context * * @return the Ewk_Context of this view or @c NULL on failure */ EAPI Ewk_Context *ewk_view_context_get(const Evas_Object *o); /** * Gets the Ewk_Page_Group of this view. * * @param o the view object to get the Ewk_Page_Group * * @return the Ewk_Page_Group of this view or @c NULL on failure */ EAPI Ewk_Page_Group *ewk_view_page_group_get(const Evas_Object *o); /** * Asks the object to load the given URL. * * @param o view object to load @a URL * @param url uniform resource identifier to load * * @return @c EINA_TRUE is returned if @a o is valid, irrespective of load, * or @c EINA_FALSE on failure */ EAPI Eina_Bool ewk_view_url_set(Evas_Object *o, const char *url); /** * Returns the current URL string of view object. * * It returns an internal string and should not * be modified. The string is guaranteed to be stringshared. * * @param o view object to get current URL * * @return current URL on success or @c NULL on failure */ EAPI const char *ewk_view_url_get(const Evas_Object *o); /** * Asks the main frame to reload the current document. * * @param o view object to reload current document * * @return @c EINA_TRUE on success or @c EINA_FALSE otherwise * * @see ewk_view_reload_bypass_cache() */ EAPI Eina_Bool ewk_view_reload(Evas_Object *o); /** * Reloads the current page's document without cache. * * @param o view object to reload current document * * @return @c EINA_TRUE on success or @c EINA_FALSE otherwise */ EAPI Eina_Bool ewk_view_reload_bypass_cache(Evas_Object *o); /** * Asks the main frame to stop loading. * * @param o view object to stop loading * * @return @c EINA_TRUE on success or @c EINA_FALSE otherwise. */ EAPI Eina_Bool ewk_view_stop(Evas_Object *o); /** * Asks the main frame to navigate back in the history. * * @param o view object to navigate back * * @return @c EINA_TRUE on success or @c EINA_FALSE otherwise * * @see ewk_frame_back() */ EAPI Eina_Bool ewk_view_back(Evas_Object *o); /** * Asks the main frame to navigate forward in the history. * * @param o view object to navigate forward * * @return @c EINA_TRUE on success or @c EINA_FALSE otherwise * * @see ewk_frame_forward() */ EAPI Eina_Bool ewk_view_forward(Evas_Object *o); /** * Queries if it is possible to navigate backwards one item in the history. * * @param o view object to query if backward navigation is possible * * @return @c EINA_TRUE if it is possible to navigate backwards in the history, @c EINA_FALSE otherwise */ EAPI Eina_Bool ewk_view_back_possible(Evas_Object *o); /** * Queries if it is possible to navigate forwards one item in the history. * * @param o view object to query if forward navigation is possible * * @return @c EINA_TRUE if it is possible to navigate forwards in the history, @c EINA_FALSE otherwise */ EAPI Eina_Bool ewk_view_forward_possible(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 parameter returns the same * handle. This handle is alive while view is alive, thus one * might want to listen for EVAS_CALLBACK_DEL on given view * (@a o) to know when to stop using returned handle. * * @param o view object to get navigation back-forward list * * @return the back-forward list instance handle associated with this view */ EAPI Ewk_Back_Forward_List *ewk_view_back_forward_list_get(const Evas_Object *o); /** * Navigates to specified back-forward list item. * * @param o view object to navigate in the history * @param item the back-forward list item * * @return @c EINA_TRUE on success or @c EINA_FALSE otherwise */ EAPI Eina_Bool ewk_view_navigate_to(Evas_Object *o, const Ewk_Back_Forward_List_Item *item); /** * Gets the current title of the main frame. * * It returns an internal string and should not * be modified. The string is guaranteed to be stringshared. * * @param o view object to get current title * * @return current title on success or @c NULL on failure */ EAPI const char *ewk_view_title_get(const Evas_Object *o); /** * Gets the current load progress of page. * * The progress estimation from 0.0 to 1.0. * * @param o view object to get the current progress * * @return the load progress of page, value from 0.0 to 1.0, * or @c -1.0 on failure */ EAPI double ewk_view_load_progress_get(const Evas_Object *o); /** * Loads the specified @a html string as the content of the view. * * External objects such as stylesheets or images referenced in the HTML * document are located relative to @a baseUrl. * * If an @a 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. * * @param o view object to load the HTML into * @param html HTML data to load * @param baseUrl Base URL used for relative paths to external objects (optional) * @param unreachableUrl URL that could not be reached (optional) * * @return @c EINA_TRUE if it the HTML was successfully loaded, @c EINA_FALSE otherwise */ EAPI Eina_Bool ewk_view_html_string_load(Evas_Object *o, const char *html, const char *baseUrl, const char *unreachableUrl); /** * Scales the current page, centered at the given point. * * @param o view object to set the zoom level * @param scale_factor a new level to set * @param cx x of center coordinate * @param cy y of center coordinate * * @return @c EINA_TRUE on success or @c EINA_FALSE otherwise */ EAPI Eina_Bool ewk_view_scale_set(Evas_Object *o, double scale_factor, int cx, int cy); /** * Queries the current scale factor of the page. * * It returns previous scale factor after ewk_view_scale_set is called immediately * until scale factor of page is really changed. * * @param o view object to get the scale factor * * @return current scale factor in use on success or @c -1.0 on failure */ EAPI double ewk_view_scale_get(const Evas_Object *o); /** * Sets zoom of the current page. * * @param o view object to set the zoom level * @param zoom_factor a new level to set * * @return @c EINA_TRUE on success or @c EINA_FALSE otherwise */ EAPI Eina_Bool ewk_view_page_zoom_set(Evas_Object *o, double zoom_factor); /** * Queries the current zoom factor of the page. * * It returns previous zoom factor after ewk_view_page_zoom_factor_set is called immediately * until zoom factor of page is really changed. * * @param o view object to get the zoom factor * * @return current zoom factor in use on success or @c -1.0 on failure */ EAPI double ewk_view_page_zoom_get(const Evas_Object *o); /** * Queries the ratio between the CSS units and device pixels when the content is unscaled. * * When designing touch-friendly contents, knowing the approximated target size on a device * is important for contents providers in order to get the intented layout and element * sizes. * * As most first generation touch devices had a PPI of approximately 160, this became a * de-facto value, when used in conjunction with the viewport meta tag. * * Devices with a higher PPI learning towards 240 or 320, applies a pre-scaling on all * content, of either 1.5 or 2.0, not affecting the CSS scale or pinch zooming. * * This value can be set using this property and it is exposed to CSS media queries using * the -webkit-device-pixel-ratio query. * * For instance, if you want to load an image without having it upscaled on a web view * using a device pixel ratio of 2.0 it can be done by loading an image of say 100x100 * pixels but showing it at half the size. * * @code * * @media (-webkit-min-device-pixel-ratio: 1.5) { * .icon { * width: 50px; * height: 50px; * url: "/images/icon@2x.png"; // This is actually a 100x100 image * } * } * * @endcode * * If the above is used on a device with device pixel ratio of 1.5, it will be scaled * down but still provide a better looking image. * * @param o view object to get device pixel ratio * * @return the ratio between the CSS units and device pixels, * or @c -1.0 on failure */ EAPI float ewk_view_device_pixel_ratio_get(const Evas_Object *o); /** * Sets the ratio between the CSS units and device pixels when the content is unscaled. * * @param o view object to set device pixel ratio * * @return @c EINA_TRUE if the device pixel ratio was set, @c EINA_FALSE otherwise * * @see ewk_view_device_pixel_ratio_get() */ EAPI Eina_Bool ewk_view_device_pixel_ratio_set(Evas_Object *o, float ratio); /** * Sets the theme path that will be used by this view. * * This also sets the theme on the main frame. As frames inherit theme * from their parent, this will have all frames with unset theme to * use this one. * * @param o view object to change theme * @param path theme path */ EAPI void ewk_view_theme_set(Evas_Object *o, const char *path); /** * Gets the theme set on this view. * * This returns the value set by ewk_view_theme_set(). * * @param o view object to get theme path * * @return the theme path, may be @c NULL if not set */ EAPI const char *ewk_view_theme_get(const Evas_Object *o); /** * Gets the current custom character encoding name. * * @param o view object to get the current encoding * * @return @c eina_stringshare containing the current encoding, or * @c NULL if it's not set */ EAPI const char *ewk_view_custom_encoding_get(const Evas_Object *o); /** * Sets the custom character encoding and reloads the page. * * @param o view to set the encoding * @param encoding the new encoding to set or @c NULL to restore the default one * * @return @c EINA_TRUE on success @c EINA_FALSE otherwise */ EAPI Eina_Bool ewk_view_custom_encoding_set(Evas_Object *o, const char *encoding); /** * Gets the current user agent string. * * @param o view object to get the current user agent * * @return @c eina_stringshare containing the current user agent, or @c default user agent * * @see ewk_view_user_agent_set() */ EAPI const char *ewk_view_user_agent_get(const Evas_Object *o); /** * Sets the user agent string. * * @param o view to set the user agent * @param user_agent the user agent string to set or @c NULL to restore the default one * * @note If you just want to add your application name in the user agent, * use ewk_view_application_name_for_user_agent_set(). * * @return @c EINA_TRUE on success @c EINA_FALSE otherwise * * @see ewk_view_application_name_for_user_agent_get() * @see ewk_view_application_name_for_user_agent_set() */ EAPI Eina_Bool ewk_view_user_agent_set(Evas_Object *o, const char *user_agent); /** * Gets the application name for the user agent string. * * @param o view object to get the current application name * * @return @c eina_stringshare containing the current application name * @c NULL otherwise * * @see ewk_view_application_name_for_user_agent_set() */ EAPI const char *ewk_view_application_name_for_user_agent_get(const Evas_Object *o); /** * Sets the application name for the user agent string. * * In HTTP, the user agent string is used for content negotiation, * where the origin server selects suitable content or operating parameters for the response. * * If custom user agent is not set by ewk_view_user_agent_set(), * the user agent string will consist of the common components which web engine provides and @a application_name. * * If you want to change the whole user agent string, please use ewk_view_user_agent_set(). * * @param o view to set application name for the user agent * @param application_name the application_name to set or @c NULL to remove application_name from the common user agent string. * * @note Below is the example of default user agent string. * * Mozilla/5.0 (X11; Linux; Unknown) AppleWebKit/601.1 (KHTML, like Gecko) Version/8.0 Safari/601.1 @a application_name * * @return @c EINA_TRUE on success @c EINA_FALSE otherwise * * @see ewk_view_user_agent_set() * @see ewk_view_user_agent_get() */ EAPI Eina_Bool ewk_view_application_name_for_user_agent_set(Evas_Object *o, const char *application_name); /** * Searches and hightlights the given string in the document. * * @param o view object to find text * @param text text to find * @param options options to find * @param max_match_count maximum match count to find, unlimited if 0 * * @return @c EINA_TRUE on success, @c EINA_FALSE on errors */ EAPI Eina_Bool ewk_view_text_find(Evas_Object *o, const char *text, Ewk_Find_Options options, unsigned max_match_count); /** * Clears the highlight of searched text. * * @param o view object to find text * * @return @c EINA_TRUE on success, @c EINA_FALSE on errors */ EAPI Eina_Bool ewk_view_text_find_highlight_clear(Evas_Object *o); /** * Counts the given string in the document. * * This does not highlight the matched string and just count the matched string. * * As the search is carried out through the whole document, * only the following EWK_FIND_OPTIONS are valid. * - EWK_FIND_OPTIONS_NONE * - EWK_FIND_OPTIONS_CASE_INSENSITIVE * - EWK_FIND_OPTIONS_AT_WORD_START * - EWK_FIND_OPTIONS_TREAT_MEDIAL_CAPITAL_AS_WORD_START * * The "text,found" callback will be called with the number of matched string. * * @param o view object to find text * @param text text to find * @param options options to find * @param max_match_count maximum match count to find, unlimited if 0 * * @return @c EINA_TRUE on success, @c EINA_FALSE on errors */ EAPI Eina_Bool ewk_view_text_matches_count(Evas_Object *o, const char *text, Ewk_Find_Options options, unsigned max_match_count); /** * Sets whether the ewk_view supports the mouse events or not. * * The ewk_view will support the mouse events if EINA_TRUE or not support the * mouse events otherwise. The default value is EINA_TRUE. * * @param o view object to enable/disable the mouse events * @param enabled a state to set * * @return @c EINA_TRUE on success or @c EINA_FALSE on failure */ EAPI Eina_Bool ewk_view_mouse_events_enabled_set(Evas_Object *o, Eina_Bool enabled); /** * Queries if the ewk_view supports the mouse events. * * @param o view object to query if the mouse events are enabled * * @return @c EINA_TRUE if the mouse events are enabled or @c EINA_FALSE otherwise */ EAPI Eina_Bool ewk_view_mouse_events_enabled_get(const Evas_Object *o); /** * Feeds the touch event to the view. * * @param o view object to feed touch event * @param type the type of touch event * @param points a list of points (Ewk_Touch_Point) to process * @param modifiers an Evas_Modifier handle to the list of modifier keys * registered in the Evas. Users can get the Evas_Modifier from the Evas * using evas_key_modifier_get() and can set each modifier key using * evas_key_modifier_on() and evas_key_modifier_off() * * @return @c EINA_TRUE on success or @c EINA_FALSE on failure */ EAPI Eina_Bool ewk_view_feed_touch_event(Evas_Object *o, Ewk_Touch_Event_Type type, const Eina_List *points, const Evas_Modifier *modifiers); /** * Sets whether the ewk_view supports the touch events or not. * * The ewk_view will support the touch events if @c EINA_TRUE or not support the * touch events otherwise. The default value is @c EINA_FALSE. * * @param o view object to enable/disable the touch events * @param enabled a state to set * * @return @c EINA_TRUE on success or @c EINA_FALSE on failure */ EAPI Eina_Bool ewk_view_touch_events_enabled_set(Evas_Object *o, Eina_Bool enabled); /** * Queries if the ewk_view supports the touch events. * * @param o view object to query if the touch events are enabled * * @return @c EINA_TRUE if the touch events are enabled or @c EINA_FALSE otherwise */ EAPI Eina_Bool ewk_view_touch_events_enabled_get(const Evas_Object *o); /** * Show the inspector to debug a web page. * * @param o The view to show the inspector. * * @return @c EINA_TRUE on success or @c EINA_FALSE on failure * * @see ewk_settings_developer_extras_enabled_set() */ EAPI Eina_Bool ewk_view_inspector_show(Evas_Object *o); /** * Close the inspector * * @param o The view to close the inspector. * * @return @c EINA_TRUE on success or @c EINA_FALSE on failure */ EAPI Eina_Bool ewk_view_inspector_close(Evas_Object *o); /** * Set pagination mode to the current web page. * * @param o view object to set the pagenation mode * @param mode The Ewk_Pagination_Mode to set * * @return @c EINA_TRUE on success or @c EINA_FALSE on failure */ EAPI Eina_Bool ewk_view_pagination_mode_set(Evas_Object *o, Ewk_Pagination_Mode mode); /** * Get pagination mode of the current web page. * * The default value is EWK_PAGINATION_MODE_UNPAGINATED. * When error occured, EWK_PAGINATION_MODE_INVALID is returned. * * @param o view object to get the pagination mode * * @return The pagination mode of the current web page */ EAPI Ewk_Pagination_Mode ewk_view_pagination_mode_get(const Evas_Object *o); /** * Exit fullscreen mode. * * @param o view object where to exit fullscreen * * @return @c EINA_TRUE if successful, @c EINA_FALSE otherwise */ EAPI Eina_Bool ewk_view_fullscreen_exit(Evas_Object *o); /** * Get contents of the current web page. * * @param o view object to get the page contents * @param type type of the page contents * @param callback callback function to be called when the operation is finished * @param user_data user data to be passed to the callback function * * @return @c EINA_TRUE on success or @c EINA_FALSE otherwise */ EAPI Eina_Bool ewk_view_page_contents_get(const Evas_Object *o, Ewk_Page_Contents_Type type, Ewk_Page_Contents_Cb callback, void *user_data); /** * Requests execution of the given script. * * The result value for the execution can be retrieved from the asynchronous callback. * * @param o The view to execute script * @param script JavaScript to execute * @param callback The function to call when the execution is completed, may be @c NULL * @param user_data User data, may be @c NULL * * @return @c EINA_TRUE on success or @c EINA_FALSE on failure */ EAPI Eina_Bool ewk_view_script_execute(Evas_Object *o, const char *script, Ewk_View_Script_Execute_Cb callback, void *user_data); /** * Sets whether the ewk_view use fixed layout or not. * * The webview will use fixed layout if EINA_TRUE or not use it otherwise. * The default value is EINA_FALSE. * * @param o view object to set fixed layout * @param enabled a state to set * * @return @c EINA_TRUE on success, or @c EINA_FALSE on failure */ EAPI Eina_Bool ewk_view_layout_fixed_set(Evas_Object *o, Eina_Bool enabled); /** * Queries if the webview is using fixed layout. * * @param o view object to query the status * * @return @c EINA_TRUE if the webview is using fixed layout, or * @c EINA_FALSE otherwise */ EAPI Eina_Bool ewk_view_layout_fixed_get(const Evas_Object *o); /** * Sets size of fixed layout to web page. * * The webview size will be set with given size. * * @param o view object to set fixed layout * @param width an integer value in which to set width of fixed layout * @param height an integer value in which to set height of fixed layout */ EAPI void ewk_view_layout_fixed_size_set(const Evas_Object *o, Evas_Coord width, Evas_Coord height); /** * Gets the fixed layout size of current web page. * * @param o view object to query the size * * @param width pointer to an integer value in which to get the width of fixed layout * @param height pointer to an integer value in which to get the height of fixed layout */ EAPI void ewk_view_layout_fixed_size_get(const Evas_Object *o, Evas_Coord *width, Evas_Coord *height); /** * Sets the background color and transparency of the view. * * @param o view object to change the background color * @param r red color component * @param g green color component * @param b blue color component * @param a transparency */ EAPI void ewk_view_bg_color_set(Evas_Object *o, int r, int g, int b, int a); /** * Gets the background color of the view. * * @param o view object to get the background color * @param r the pointer to store red color component * @param g the pointer to store green color component * @param b the pointer to store blue color component * @param a the pointer to store alpha value */ EAPI void ewk_view_bg_color_get(const Evas_Object *o, int *r, int *g, int *b, int *a); /** * Get contents size of current web page. * * If it fails to get the content size, the width and height will be set to 0. * * @param o view object to get contents size * @param width pointer to an integer in which to store the width of contents. * @param height pointer to an integer in which to store the height of contents. * * @return @c EINA_TRUE on success or @c EINA_FALSE otherwise */ EAPI Eina_Bool ewk_view_contents_size_get(const Evas_Object *o, Evas_Coord *width, Evas_Coord *height); /** * Get status of the activate action. Activate action describes the click. * * @param o view of the object * * @return @c EINA_TRUE on success, or @c EINA_FALSE otherwise */ EAPI Eina_Bool ewk_view_accessibility_action_activate_get(const Evas_Object *o); /** * Get status of the next action. Action next moves and focuses next object. * * @param o view of the object * * @return @c EINA_TRUE on success, or @c EINA_FALSE otherwise */ EAPI Eina_Bool ewk_view_accessibility_action_next_get(const Evas_Object *o); /** * Get status of the previous action. Previous action moves and focuses previous element. * * @param o view of the object * * @return @c EINA_TRUE on success, or @c EINA_FALSE otherwise */ EAPI Eina_Bool ewk_view_accessibility_action_prev_get(const Evas_Object *o); /** * Get status of the read action. Read action focuses object with specific coordinates. * * @param o view of the object * * @return @c EINA_TRUE on success, or @c EINA_FALSE otherwise */ EAPI Eina_Bool ewk_view_accessibility_action_read_by_point_get(const Evas_Object *o); #ifdef __cplusplus } #endif #endif // ewk_view_h