Data Structures | Macros | Typedefs | Functions
Web

Data Structures

struct  _Elm_Web_Menu
 Structure describing the menu of a popup. More...
 

Macros

#define elm_obj_web_webkit_view_get(ret)   ELM_OBJ_WEB_ID(ELM_OBJ_WEB_SUB_ID_WEBKIT_VIEW_GET), EO_TYPECHECK(Evas_Object **, ret)
 
#define elm_obj_web_window_create_hook_set(func, data)   ELM_OBJ_WEB_ID(ELM_OBJ_WEB_SUB_ID_WINDOW_CREATE_HOOK_SET), EO_TYPECHECK(Elm_Web_Window_Open, func), EO_TYPECHECK(void *, data)
 
#define elm_obj_web_dialog_alert_hook_set(func, data)   ELM_OBJ_WEB_ID(ELM_OBJ_WEB_SUB_ID_DIALOG_ALERT_HOOK_SET), EO_TYPECHECK(Elm_Web_Dialog_Alert, func), EO_TYPECHECK(void *, data)
 
#define elm_obj_web_dialog_confirm_hook_set(func, data)   ELM_OBJ_WEB_ID(ELM_OBJ_WEB_SUB_ID_DIALOG_CONFIRM_HOOK_SET), EO_TYPECHECK(Elm_Web_Dialog_Confirm, func), EO_TYPECHECK(void *, data)
 
#define elm_obj_web_dialog_prompt_hook_set(func, data)   ELM_OBJ_WEB_ID(ELM_OBJ_WEB_SUB_ID_DIALOG_PROMPT_HOOK_SET), EO_TYPECHECK(Elm_Web_Dialog_Prompt, func), EO_TYPECHECK(void *, data)
 
#define elm_obj_web_dialog_file_selector_hook_set(func, data)   ELM_OBJ_WEB_ID(ELM_OBJ_WEB_SUB_ID_DIALOG_FILE_SELECTOR_HOOK_SET), EO_TYPECHECK(Elm_Web_Dialog_File_Selector, func), EO_TYPECHECK(void *, data)
 
#define elm_obj_web_console_message_hook_set(func, data)   ELM_OBJ_WEB_ID(ELM_OBJ_WEB_SUB_ID_CONSOLE_MESSAGE_HOOK_SET), EO_TYPECHECK(Elm_Web_Console_Message, func), EO_TYPECHECK(void *, data)
 
#define elm_obj_web_useragent_set(user_agent)   ELM_OBJ_WEB_ID(ELM_OBJ_WEB_SUB_ID_USERAGENT_SET), EO_TYPECHECK(const char *, user_agent)
 
#define elm_obj_web_useragent_get(ret)   ELM_OBJ_WEB_ID(ELM_OBJ_WEB_SUB_ID_USERAGENT_GET), EO_TYPECHECK(const char **, ret)
 
#define elm_obj_web_tab_propagate_get(ret)   ELM_OBJ_WEB_ID(ELM_OBJ_WEB_SUB_ID_TAB_PROPAGATE_GET), EO_TYPECHECK(Eina_Bool *, ret)
 
#define elm_obj_web_tab_propagate_set(propagate)   ELM_OBJ_WEB_ID(ELM_OBJ_WEB_SUB_ID_TAB_PROPAGATE_SET), EO_TYPECHECK(Eina_Bool, propagate)
 
#define elm_obj_web_url_set(url, ret)   ELM_OBJ_WEB_ID(ELM_OBJ_WEB_SUB_ID_URL_SET), EO_TYPECHECK(const char *, url), EO_TYPECHECK(Eina_Bool *, ret)
 
#define elm_obj_web_url_get(ret)   ELM_OBJ_WEB_ID(ELM_OBJ_WEB_SUB_ID_URL_GET), EO_TYPECHECK(const char **, ret)
 
#define elm_obj_web_html_string_load(html, base_url, unreachable_url, ret)   ELM_OBJ_WEB_ID(ELM_OBJ_WEB_SUB_ID_HTML_STRING_LOAD), EO_TYPECHECK(const char *, html), EO_TYPECHECK(const char *, base_url), EO_TYPECHECK(const char *, unreachable_url), EO_TYPECHECK(Eina_Bool *, ret)
 
#define elm_obj_web_title_get(ret)   ELM_OBJ_WEB_ID(ELM_OBJ_WEB_SUB_ID_TITLE_GET), EO_TYPECHECK(const char **, ret)
 
#define elm_obj_web_bg_color_set(r, g, b, a)   ELM_OBJ_WEB_ID(ELM_OBJ_WEB_SUB_ID_BG_COLOR_SET), EO_TYPECHECK(int, r), EO_TYPECHECK(int, g), EO_TYPECHECK(int, b), EO_TYPECHECK(int, a)
 
#define elm_obj_web_bg_color_get(r, g, b, a)   ELM_OBJ_WEB_ID(ELM_OBJ_WEB_SUB_ID_BG_COLOR_GET), EO_TYPECHECK(int *, r), EO_TYPECHECK(int *, g), EO_TYPECHECK(int *, b), EO_TYPECHECK(int *, a)
 
#define elm_obj_web_selection_get(ret)   ELM_OBJ_WEB_ID(ELM_OBJ_WEB_SUB_ID_SELECTION_GET), EO_TYPECHECK(const char **, ret)
 
#define elm_obj_web_popup_selected_set(idx)   ELM_OBJ_WEB_ID(ELM_OBJ_WEB_SUB_ID_POPUP_SELECTED_SET), EO_TYPECHECK(int, idx)
 
#define elm_obj_web_popup_destroy(ret)   ELM_OBJ_WEB_ID(ELM_OBJ_WEB_SUB_ID_POPUP_DESTROY), EO_TYPECHECK(Eina_Bool *, ret)
 
#define elm_obj_web_text_search(string, case_sensitive, forward, wrap, ret)   ELM_OBJ_WEB_ID(ELM_OBJ_WEB_SUB_ID_TEXT_SEARCH), EO_TYPECHECK(const char *, string), EO_TYPECHECK(Eina_Bool, case_sensitive), EO_TYPECHECK(Eina_Bool, forward), EO_TYPECHECK(Eina_Bool, wrap), EO_TYPECHECK(Eina_Bool *, ret)
 
#define elm_obj_web_text_matches_mark(string, case_sensitive, highlight, limit, ret)   ELM_OBJ_WEB_ID(ELM_OBJ_WEB_SUB_ID_TEXT_MATCHES_MARK), EO_TYPECHECK(const char *, string), EO_TYPECHECK(Eina_Bool, case_sensitive), EO_TYPECHECK(Eina_Bool, highlight), EO_TYPECHECK(unsigned int, limit), EO_TYPECHECK(unsigned int *, ret)
 
#define elm_obj_web_text_matches_unmark_all(ret)   ELM_OBJ_WEB_ID(ELM_OBJ_WEB_SUB_ID_TEXT_MATCHES_UNMARK_ALL), EO_TYPECHECK(Eina_Bool *, ret)
 
#define elm_obj_web_text_matches_highlight_set(highlight, ret)   ELM_OBJ_WEB_ID(ELM_OBJ_WEB_SUB_ID_TEXT_MATCHES_HIGHLIGHT_SET), EO_TYPECHECK(Eina_Bool, highlight), EO_TYPECHECK(Eina_Bool *, ret)
 
#define elm_obj_web_text_matches_highlight_get(ret)   ELM_OBJ_WEB_ID(ELM_OBJ_WEB_SUB_ID_TEXT_MATCHES_HIGHLIGHT_GET), EO_TYPECHECK(Eina_Bool *, ret)
 
#define elm_obj_web_load_progress_get(ret)   ELM_OBJ_WEB_ID(ELM_OBJ_WEB_SUB_ID_LOAD_PROGRESS_GET), EO_TYPECHECK(double *, ret)
 
#define elm_obj_web_stop(ret)   ELM_OBJ_WEB_ID(ELM_OBJ_WEB_SUB_ID_STOP), EO_TYPECHECK(Eina_Bool *, ret)
 
#define elm_obj_web_reload(ret)   ELM_OBJ_WEB_ID(ELM_OBJ_WEB_SUB_ID_RELOAD), EO_TYPECHECK(Eina_Bool *, ret)
 
#define elm_obj_web_reload_full(ret)   ELM_OBJ_WEB_ID(ELM_OBJ_WEB_SUB_ID_RELOAD_FULL), EO_TYPECHECK(Eina_Bool *, ret)
 
#define elm_obj_web_back(ret)   ELM_OBJ_WEB_ID(ELM_OBJ_WEB_SUB_ID_BACK), EO_TYPECHECK(Eina_Bool *, ret)
 
#define elm_obj_web_forward(ret)   ELM_OBJ_WEB_ID(ELM_OBJ_WEB_SUB_ID_FORWARD), EO_TYPECHECK(Eina_Bool *, ret)
 
#define elm_obj_web_navigate(steps, ret)   ELM_OBJ_WEB_ID(ELM_OBJ_WEB_SUB_ID_NAVIGATE), EO_TYPECHECK(int, steps), EO_TYPECHECK(Eina_Bool *, ret)
 
#define elm_obj_web_back_possible_get(ret)   ELM_OBJ_WEB_ID(ELM_OBJ_WEB_SUB_ID_BACK_POSSIBLE_GET), EO_TYPECHECK(Eina_Bool *, ret)
 
#define elm_obj_web_forward_possible_get(ret)   ELM_OBJ_WEB_ID(ELM_OBJ_WEB_SUB_ID_FORWARD_POSSIBLE_GET), EO_TYPECHECK(Eina_Bool *, ret)
 
#define elm_obj_web_navigate_possible_get(steps, ret)   ELM_OBJ_WEB_ID(ELM_OBJ_WEB_SUB_ID_NAVIGATE_POSSIBLE_GET), EO_TYPECHECK(int, steps), EO_TYPECHECK(Eina_Bool *, ret)
 
#define elm_obj_web_history_enabled_get(ret)   ELM_OBJ_WEB_ID(ELM_OBJ_WEB_SUB_ID_HISTORY_ENABLED_GET), EO_TYPECHECK(Eina_Bool *, ret)
 
#define elm_obj_web_history_enabled_set(enable)   ELM_OBJ_WEB_ID(ELM_OBJ_WEB_SUB_ID_HISTORY_ENABLED_SET), EO_TYPECHECK(Eina_Bool, enable)
 
#define elm_obj_web_zoom_set(zoom)   ELM_OBJ_WEB_ID(ELM_OBJ_WEB_SUB_ID_ZOOM_SET), EO_TYPECHECK(double, zoom)
 
#define elm_obj_web_zoom_get(ret)   ELM_OBJ_WEB_ID(ELM_OBJ_WEB_SUB_ID_ZOOM_GET), EO_TYPECHECK(double *, ret)
 
#define elm_obj_web_zoom_mode_set(mode)   ELM_OBJ_WEB_ID(ELM_OBJ_WEB_SUB_ID_ZOOM_MODE_SET), EO_TYPECHECK(Elm_Web_Zoom_Mode, mode)
 
#define elm_obj_web_zoom_mode_get(ret)   ELM_OBJ_WEB_ID(ELM_OBJ_WEB_SUB_ID_ZOOM_MODE_GET), EO_TYPECHECK(Elm_Web_Zoom_Mode *, ret)
 
#define elm_obj_web_region_show(x, y, w, h)   ELM_OBJ_WEB_ID(ELM_OBJ_WEB_SUB_ID_REGION_SHOW), EO_TYPECHECK(int, x), EO_TYPECHECK(int, y), EO_TYPECHECK(int, w), EO_TYPECHECK(int, h)
 
#define elm_obj_web_region_bring_in(x, y, w, h)   ELM_OBJ_WEB_ID(ELM_OBJ_WEB_SUB_ID_REGION_BRING_IN), EO_TYPECHECK(int, x), EO_TYPECHECK(int, y), EO_TYPECHECK(int, w), EO_TYPECHECK(int, h)
 
#define elm_obj_web_inwin_mode_set(value)   ELM_OBJ_WEB_ID(ELM_OBJ_WEB_SUB_ID_INWIN_MODE_SET), EO_TYPECHECK(Eina_Bool, value)
 
#define elm_obj_web_inwin_mode_get(ret)   ELM_OBJ_WEB_ID(ELM_OBJ_WEB_SUB_ID_INWIN_MODE_GET), EO_TYPECHECK(Eina_Bool *, ret)
 

Typedefs

typedef struct _Elm_Web_Menu Elm_Web_Menu
 Structure describing the menu of a popup. More...
 
typedef Evas_Object *(* Elm_Web_Window_Open )(void *data, Evas_Object *obj, Eina_Bool js, const Elm_Web_Window_Features *window_features)
 Callback type for the create_window hook. More...
 
typedef Evas_Object *(* Elm_Web_Dialog_Alert )(void *data, Evas_Object *obj, const char *message)
 Callback type for the JS alert hook. More...
 
typedef Evas_Object *(* Elm_Web_Dialog_Confirm )(void *data, Evas_Object *obj, const char *message, Eina_Bool *ret)
 Callback type for the JS confirm hook. More...
 
typedef Evas_Object *(* Elm_Web_Dialog_Prompt )(void *data, Evas_Object *obj, const char *message, const char *def_value, const char **value, Eina_Bool *ret)
 Callback type for the JS prompt hook. More...
 
typedef Evas_Object *(* Elm_Web_Dialog_File_Selector )(void *data, Evas_Object *obj, Eina_Bool allows_multiple, Eina_List *accept_types, Eina_List **selected, Eina_Bool *ret)
 Callback type for the JS file selector hook. More...
 
typedef void(* Elm_Web_Console_Message )(void *data, Evas_Object *obj, const char *message, unsigned int line_number, const char *source_id)
 Callback type for the JS console message hook. More...
 

Functions

Eina_Bool elm_need_web (void)
 Request that your elementary application needs web support. More...
 
Evas_Object * elm_web_add (Evas_Object *parent)
 Add a new web object to the parent. More...
 
void elm_web_zoom_mode_set (Evas_Object *obj, Elm_Web_Zoom_Mode mode)
 Sets the zoom mode to use. More...
 
Elm_Web_Zoom_Mode elm_web_zoom_mode_get (const Evas_Object *obj)
 Get the currently set zoom mode. More...
 
Eina_Bool elm_web_window_features_property_get (const Elm_Web_Window_Features *wf, Elm_Web_Window_Feature_Flag flag)
 Get boolean properties from Elm_Web_Window_Features (such as statusbar, menubar, etc) that are on a window. More...
 
void elm_web_window_features_region_get (const Elm_Web_Window_Features *wf, Evas_Coord *x, Evas_Coord *y, Evas_Coord *w, Evas_Coord *h)
 TODO : Add documentation. More...
 
Evas_Object * elm_web_webkit_view_get (const Evas_Object *obj)
 Get internal ewk_view object from web object. More...
 
void elm_web_window_create_hook_set (Evas_Object *obj, Elm_Web_Window_Open func, void *data)
 Sets the function to call when a new window is requested. More...
 
void elm_web_dialog_alert_hook_set (Evas_Object *obj, Elm_Web_Dialog_Alert func, void *data)
 Sets the function to call when an alert dialog. More...
 
void elm_web_dialog_confirm_hook_set (Evas_Object *obj, Elm_Web_Dialog_Confirm func, void *data)
 Sets the function to call when an confirm dialog. More...
 
void elm_web_dialog_prompt_hook_set (Evas_Object *obj, Elm_Web_Dialog_Prompt func, void *data)
 Sets the function to call when an prompt dialog. More...
 
void elm_web_dialog_file_selector_hook_set (Evas_Object *obj, Elm_Web_Dialog_File_Selector func, void *data)
 Sets the function to call when an file selector dialog. More...
 
void elm_web_console_message_hook_set (Evas_Object *obj, Elm_Web_Console_Message func, void *data)
 Sets the function to call when a console message is emitted from JS. More...
 
void elm_web_useragent_set (Evas_Object *obj, const char *user_agent)
 Change useragent of a elm_web object. More...
 
const char * elm_web_useragent_get (const Evas_Object *obj)
 Return current useragent of elm_web object. More...
 
Eina_Bool elm_web_tab_propagate_get (const Evas_Object *obj)
 Get the status of the tab propagation. More...
 
void elm_web_tab_propagate_set (Evas_Object *obj, Eina_Bool propagate)
 Sets whether to use tab propagation. More...
 
Eina_Bool elm_web_url_set (Evas_Object *obj, const char *url)
 Sets the URL for the web object. More...
 
Eina_Bool elm_web_html_string_load (Evas_Object *obj, const char *html, const char *base_url, const char *unreachable_url)
 Loads the specified html string as the content of the web object. More...
 
const char * elm_web_url_get (const Evas_Object *obj)
 Get the current URL for the object. More...
 
EINA_DEPRECATED Eina_Bool elm_web_uri_set (Evas_Object *obj, const char *uri)
 Sets the URI for the web object. More...
 
EINA_DEPRECATED const char * elm_web_uri_get (const Evas_Object *obj)
 Get the current URI for the object. More...
 
const char * elm_web_title_get (const Evas_Object *obj)
 Get the current title. More...
 
void elm_web_bg_color_set (Evas_Object *obj, int r, int g, int b, int a)
 Sets the background color to be used by the web object. More...
 
void elm_web_bg_color_get (const Evas_Object *obj, int *r, int *g, int *b, int *a)
 Get the background color to be used by the web object. More...
 
const char * elm_web_selection_get (const Evas_Object *obj)
 Get a copy of the currently selected text. More...
 
void elm_web_popup_selected_set (Evas_Object *obj, int index)
 Tells the web object which index in the currently open popup was selected. More...
 
Eina_Bool elm_web_popup_destroy (Evas_Object *obj)
 Dismisses an open dropdown popup. More...
 
Eina_Bool elm_web_text_search (const Evas_Object *obj, const char *string, Eina_Bool case_sensitive, Eina_Bool forward, Eina_Bool wrap)
 Searches the given string in a document. More...
 
unsigned int elm_web_text_matches_mark (Evas_Object *obj, const char *string, Eina_Bool case_sensitive, Eina_Bool highlight, unsigned int limit)
 Marks matches of the given string in a document. More...
 
Eina_Bool elm_web_text_matches_unmark_all (Evas_Object *obj)
 Clears all marked matches in the document. More...
 
Eina_Bool elm_web_text_matches_highlight_set (Evas_Object *obj, Eina_Bool highlight)
 Sets whether to highlight the matched marks. More...
 
Eina_Bool elm_web_text_matches_highlight_get (const Evas_Object *obj)
 Get whether highlighting marks is enabled. More...
 
double elm_web_load_progress_get (const Evas_Object *obj)
 Get the overall loading progress of the page. More...
 
Eina_Bool elm_web_stop (Evas_Object *obj)
 Stops loading the current page. More...
 
Eina_Bool elm_web_reload (Evas_Object *obj)
 Requests a reload of the current document in the object. More...
 
Eina_Bool elm_web_reload_full (Evas_Object *obj)
 Requests a reload of the current document, avoiding any existing caches. More...
 
Eina_Bool elm_web_back (Evas_Object *obj)
 Goes back one step in the browsing history. More...
 
Eina_Bool elm_web_forward (Evas_Object *obj)
 Goes forward one step in the browsing history. More...
 
Eina_Bool elm_web_navigate (Evas_Object *obj, int steps)
 Jumps the given number of steps in the browsing history. More...
 
Eina_Bool elm_web_back_possible_get (Evas_Object *obj)
 Queries whether it's possible to go back in history. More...
 
Eina_Bool elm_web_forward_possible_get (Evas_Object *obj)
 Queries whether it's possible to go forward in history. More...
 
Eina_Bool elm_web_navigate_possible_get (Evas_Object *obj, int steps)
 Queries whether it's possible to jump the given number of steps. More...
 
Eina_Bool elm_web_history_enabled_get (const Evas_Object *obj)
 Get whether browsing history is enabled for the given object. More...
 
void elm_web_history_enabled_set (Evas_Object *obj, Eina_Bool enabled)
 Enables or disables the browsing history. More...
 
void elm_web_zoom_set (Evas_Object *obj, double zoom)
 Sets the zoom level of the web object. More...
 
double elm_web_zoom_get (const Evas_Object *obj)
 Get the current zoom level set on the web object. More...
 
void elm_web_region_show (Evas_Object *obj, int x, int y, int w, int h)
 Shows the given region in the web object. More...
 
void elm_web_region_bring_in (Evas_Object *obj, int x, int y, int w, int h)
 Brings in the region to the visible area. More...
 
void elm_web_inwin_mode_set (Evas_Object *obj, Eina_Bool value)
 Sets the default dialogs to use an Inwin instead of a normal window. More...
 
Eina_Bool elm_web_inwin_mode_get (const Evas_Object *obj)
 Get whether Inwin mode is set for the current object. More...
 

Detailed Description

web_inheritance_tree.png
preview-00.png

A web widget is used for displaying web pages (HTML/CSS/JS) using WebKit-EFL. You must have compiled Elementary with ewebkit support.

Signals that you can add callbacks for are:

available styles:

An example of use of web:

Macro Definition Documentation

#define elm_obj_web_back (   ret)    ELM_OBJ_WEB_ID(ELM_OBJ_WEB_SUB_ID_BACK), EO_TYPECHECK(Eina_Bool *, ret)
Since
1.8

Goes back one step in the browsing history

Parameters
[out]ret
See Also
elm_web_back

Referenced by elm_web_back().

#define elm_obj_web_back_possible_get (   ret)    ELM_OBJ_WEB_ID(ELM_OBJ_WEB_SUB_ID_BACK_POSSIBLE_GET), EO_TYPECHECK(Eina_Bool *, ret)
Since
1.8

Queries whether it's possible to go back in history

Parameters
[out]ret
See Also
elm_web_back_possible_get

Referenced by elm_web_back_possible_get().

#define elm_obj_web_bg_color_get (   r,
  g,
  b,
 
)    ELM_OBJ_WEB_ID(ELM_OBJ_WEB_SUB_ID_BG_COLOR_GET), EO_TYPECHECK(int *, r), EO_TYPECHECK(int *, g), EO_TYPECHECK(int *, b), EO_TYPECHECK(int *, a)
Since
1.8

Get the background color to be used by the web object

Parameters
[out]r
[out]g
[out]b
[out]a
See Also
elm_web_bg_color_get

Referenced by elm_web_bg_color_get().

#define elm_obj_web_bg_color_set (   r,
  g,
  b,
 
)    ELM_OBJ_WEB_ID(ELM_OBJ_WEB_SUB_ID_BG_COLOR_SET), EO_TYPECHECK(int, r), EO_TYPECHECK(int, g), EO_TYPECHECK(int, b), EO_TYPECHECK(int, a)
Since
1.8

Sets the background color to be used by the web object

Parameters
[in]r
[in]g
[in]b
[in]a
See Also
elm_web_bg_color_set

Referenced by elm_web_bg_color_set().

#define elm_obj_web_console_message_hook_set (   func,
  data 
)    ELM_OBJ_WEB_ID(ELM_OBJ_WEB_SUB_ID_CONSOLE_MESSAGE_HOOK_SET), EO_TYPECHECK(Elm_Web_Console_Message, func), EO_TYPECHECK(void *, data)
Since
1.8

Sets the function to call when a console message is emitted from JS

Parameters
[in]func
[in]data
See Also
elm_web_console_message_hook_set

Referenced by elm_web_console_message_hook_set().

#define elm_obj_web_dialog_alert_hook_set (   func,
  data 
)    ELM_OBJ_WEB_ID(ELM_OBJ_WEB_SUB_ID_DIALOG_ALERT_HOOK_SET), EO_TYPECHECK(Elm_Web_Dialog_Alert, func), EO_TYPECHECK(void *, data)
Since
1.8

Sets the function to call when an alert dialog

Parameters
[in]func
[in]data
See Also
elm_web_dialog_alert_hook_set

Referenced by elm_web_dialog_alert_hook_set().

#define elm_obj_web_dialog_confirm_hook_set (   func,
  data 
)    ELM_OBJ_WEB_ID(ELM_OBJ_WEB_SUB_ID_DIALOG_CONFIRM_HOOK_SET), EO_TYPECHECK(Elm_Web_Dialog_Confirm, func), EO_TYPECHECK(void *, data)
Since
1.8

Sets the function to call when an confirm dialog

Parameters
[in]func
[in]data
See Also
elm_web_dialog_confirm_hook_set

Referenced by elm_web_dialog_confirm_hook_set().

#define elm_obj_web_dialog_file_selector_hook_set (   func,
  data 
)    ELM_OBJ_WEB_ID(ELM_OBJ_WEB_SUB_ID_DIALOG_FILE_SELECTOR_HOOK_SET), EO_TYPECHECK(Elm_Web_Dialog_File_Selector, func), EO_TYPECHECK(void *, data)
Since
1.8

Sets the function to call when an file selector dialog

Parameters
[in]func
[in]data
See Also
elm_web_dialog_file_selector_hook_set

Referenced by elm_web_dialog_file_selector_hook_set().

#define elm_obj_web_dialog_prompt_hook_set (   func,
  data 
)    ELM_OBJ_WEB_ID(ELM_OBJ_WEB_SUB_ID_DIALOG_PROMPT_HOOK_SET), EO_TYPECHECK(Elm_Web_Dialog_Prompt, func), EO_TYPECHECK(void *, data)
Since
1.8

Sets the function to call when an prompt dialog

Parameters
[in]func
[in]data
See Also
elm_web_dialog_prompt_hook_set

Referenced by elm_web_dialog_prompt_hook_set().

#define elm_obj_web_forward (   ret)    ELM_OBJ_WEB_ID(ELM_OBJ_WEB_SUB_ID_FORWARD), EO_TYPECHECK(Eina_Bool *, ret)
Since
1.8

Goes forward one step in the browsing history

Parameters
[out]ret
See Also
elm_web_forward

Referenced by elm_web_forward().

#define elm_obj_web_forward_possible_get (   ret)    ELM_OBJ_WEB_ID(ELM_OBJ_WEB_SUB_ID_FORWARD_POSSIBLE_GET), EO_TYPECHECK(Eina_Bool *, ret)
Since
1.8

Queries whether it's possible to go forward in history

Parameters
[out]ret
See Also
elm_web_forward_possible_get

Referenced by elm_web_forward_possible_get().

#define elm_obj_web_history_enabled_get (   ret)    ELM_OBJ_WEB_ID(ELM_OBJ_WEB_SUB_ID_HISTORY_ENABLED_GET), EO_TYPECHECK(Eina_Bool *, ret)
Since
1.8

Get whether browsing history is enabled for the given object

Parameters
[out]ret
See Also
elm_web_history_enabled_get

Referenced by elm_web_history_enabled_get().

#define elm_obj_web_history_enabled_set (   enable)    ELM_OBJ_WEB_ID(ELM_OBJ_WEB_SUB_ID_HISTORY_ENABLED_SET), EO_TYPECHECK(Eina_Bool, enable)
Since
1.8

Enables or disables the browsing history

Parameters
[in]enable
See Also
elm_web_history_enabled_set

Referenced by elm_web_history_enabled_set().

#define elm_obj_web_html_string_load (   html,
  base_url,
  unreachable_url,
  ret 
)    ELM_OBJ_WEB_ID(ELM_OBJ_WEB_SUB_ID_HTML_STRING_LOAD), EO_TYPECHECK(const char *, html), EO_TYPECHECK(const char *, base_url), EO_TYPECHECK(const char *, unreachable_url), EO_TYPECHECK(Eina_Bool *, ret)
Since
1.9

Loads the specified html string as the content of the web object

Parameters
[in]html
[in]base_url
[in]unreachable_url
[out]ret
See Also
elm_web_html_string_load

Referenced by elm_web_html_string_load().

#define elm_obj_web_inwin_mode_get (   ret)    ELM_OBJ_WEB_ID(ELM_OBJ_WEB_SUB_ID_INWIN_MODE_GET), EO_TYPECHECK(Eina_Bool *, ret)
Since
1.8

Get whether Inwin mode is set for the current object

Parameters
[out]ret
See Also
elm_web_inwin_mode_get

Referenced by elm_web_inwin_mode_get().

#define elm_obj_web_inwin_mode_set (   value)    ELM_OBJ_WEB_ID(ELM_OBJ_WEB_SUB_ID_INWIN_MODE_SET), EO_TYPECHECK(Eina_Bool, value)
Since
1.8

Sets the default dialogs to use an Inwin instead of a normal window

Parameters
[in]value
See Also
elm_web_inwin_mode_set

Referenced by elm_web_inwin_mode_set().

#define elm_obj_web_load_progress_get (   ret)    ELM_OBJ_WEB_ID(ELM_OBJ_WEB_SUB_ID_LOAD_PROGRESS_GET), EO_TYPECHECK(double *, ret)
Since
1.8

Get the overall loading progress of the page

Parameters
[out]ret
See Also
elm_web_load_progress_get

Referenced by elm_web_load_progress_get().

#define elm_obj_web_navigate (   steps,
  ret 
)    ELM_OBJ_WEB_ID(ELM_OBJ_WEB_SUB_ID_NAVIGATE), EO_TYPECHECK(int, steps), EO_TYPECHECK(Eina_Bool *, ret)
Since
1.8

Jumps the given number of steps in the browsing history

Parameters
[in]steps
[out]ret
See Also
elm_web_navigate

Referenced by elm_web_navigate().

#define elm_obj_web_navigate_possible_get (   steps,
  ret 
)    ELM_OBJ_WEB_ID(ELM_OBJ_WEB_SUB_ID_NAVIGATE_POSSIBLE_GET), EO_TYPECHECK(int, steps), EO_TYPECHECK(Eina_Bool *, ret)
Since
1.8

Queries whether it's possible to jump the given number of steps

Parameters
[in]steps
[out]ret
See Also
elm_web_navigate_possible_get

Referenced by elm_web_navigate_possible_get().

#define elm_obj_web_popup_destroy (   ret)    ELM_OBJ_WEB_ID(ELM_OBJ_WEB_SUB_ID_POPUP_DESTROY), EO_TYPECHECK(Eina_Bool *, ret)
Since
1.8

Dismisses an open dropdown popup

Parameters
[out]ret
See Also
elm_web_popup_destroy

Referenced by elm_web_popup_destroy().

#define elm_obj_web_popup_selected_set (   idx)    ELM_OBJ_WEB_ID(ELM_OBJ_WEB_SUB_ID_POPUP_SELECTED_SET), EO_TYPECHECK(int, idx)
Since
1.8

Tells the web object which index in the currently open popup was selected

Parameters
[in]idx
See Also
elm_web_popup_selected_set

Referenced by elm_web_popup_selected_set().

#define elm_obj_web_region_bring_in (   x,
  y,
  w,
 
)    ELM_OBJ_WEB_ID(ELM_OBJ_WEB_SUB_ID_REGION_BRING_IN), EO_TYPECHECK(int, x), EO_TYPECHECK(int, y), EO_TYPECHECK(int, w), EO_TYPECHECK(int, h)
Since
1.8

Brings in the region to the visible area

Parameters
[in]x
[in]y
[in]w
[in]h
See Also
elm_web_region_bring_in

Referenced by elm_web_region_bring_in().

#define elm_obj_web_region_show (   x,
  y,
  w,
 
)    ELM_OBJ_WEB_ID(ELM_OBJ_WEB_SUB_ID_REGION_SHOW), EO_TYPECHECK(int, x), EO_TYPECHECK(int, y), EO_TYPECHECK(int, w), EO_TYPECHECK(int, h)
Since
1.8

Shows the given region in the web object

Parameters
[in]x
[in]y
[in]w
[in]h
See Also
elm_web_region_show

Referenced by elm_web_region_show().

#define elm_obj_web_reload (   ret)    ELM_OBJ_WEB_ID(ELM_OBJ_WEB_SUB_ID_RELOAD), EO_TYPECHECK(Eina_Bool *, ret)
Since
1.8

Requests a reload of the current document in the object

Parameters
[out]ret
See Also
elm_web_reload

Referenced by elm_web_reload().

#define elm_obj_web_reload_full (   ret)    ELM_OBJ_WEB_ID(ELM_OBJ_WEB_SUB_ID_RELOAD_FULL), EO_TYPECHECK(Eina_Bool *, ret)
Since
1.8

Requests a reload of the current document, avoiding any existing caches

Parameters
[out]ret
See Also
elm_web_reload_full

Referenced by elm_web_reload_full().

#define elm_obj_web_selection_get (   ret)    ELM_OBJ_WEB_ID(ELM_OBJ_WEB_SUB_ID_SELECTION_GET), EO_TYPECHECK(const char **, ret)
Since
1.8

Get a copy of the currently selected text

Parameters
[out]ret
See Also
elm_web_selection_get

Referenced by elm_web_selection_get().

#define elm_obj_web_stop (   ret)    ELM_OBJ_WEB_ID(ELM_OBJ_WEB_SUB_ID_STOP), EO_TYPECHECK(Eina_Bool *, ret)
Since
1.8

Stops loading the current page

Parameters
[out]ret
See Also
elm_web_stop

Referenced by elm_web_stop().

#define elm_obj_web_tab_propagate_get (   ret)    ELM_OBJ_WEB_ID(ELM_OBJ_WEB_SUB_ID_TAB_PROPAGATE_GET), EO_TYPECHECK(Eina_Bool *, ret)
Since
1.8

Get the status of the tab propagation

Parameters
[out]ret
See Also
elm_web_tab_propagate_get

Referenced by elm_web_tab_propagate_get().

#define elm_obj_web_tab_propagate_set (   propagate)    ELM_OBJ_WEB_ID(ELM_OBJ_WEB_SUB_ID_TAB_PROPAGATE_SET), EO_TYPECHECK(Eina_Bool, propagate)
Since
1.8

Sets whether to use tab propagation

Parameters
[in]propagate
See Also
elm_web_tab_propagate_set

Referenced by elm_web_tab_propagate_set().

#define elm_obj_web_text_matches_highlight_get (   ret)    ELM_OBJ_WEB_ID(ELM_OBJ_WEB_SUB_ID_TEXT_MATCHES_HIGHLIGHT_GET), EO_TYPECHECK(Eina_Bool *, ret)
Since
1.8

Get whether highlighting marks is enabled

Parameters
[out]ret
See Also
elm_web_text_matches_highlight_get

Referenced by elm_web_text_matches_highlight_get().

#define elm_obj_web_text_matches_highlight_set (   highlight,
  ret 
)    ELM_OBJ_WEB_ID(ELM_OBJ_WEB_SUB_ID_TEXT_MATCHES_HIGHLIGHT_SET), EO_TYPECHECK(Eina_Bool, highlight), EO_TYPECHECK(Eina_Bool *, ret)
Since
1.8

Sets whether to highlight the matched marks

Parameters
[in]highlight
[out]ret
See Also
elm_web_text_matches_highlight_set

Referenced by elm_web_text_matches_highlight_set().

#define elm_obj_web_text_matches_mark (   string,
  case_sensitive,
  highlight,
  limit,
  ret 
)    ELM_OBJ_WEB_ID(ELM_OBJ_WEB_SUB_ID_TEXT_MATCHES_MARK), EO_TYPECHECK(const char *, string), EO_TYPECHECK(Eina_Bool, case_sensitive), EO_TYPECHECK(Eina_Bool, highlight), EO_TYPECHECK(unsigned int, limit), EO_TYPECHECK(unsigned int *, ret)
Since
1.8

Marks matches of the given string in a document.

Parameters
[in]string
[in]case_sensitive
[in]highlight
[in]limit
[out]ret
See Also
elm_web_text_matches_mark

Referenced by elm_web_text_matches_mark().

#define elm_obj_web_text_matches_unmark_all (   ret)    ELM_OBJ_WEB_ID(ELM_OBJ_WEB_SUB_ID_TEXT_MATCHES_UNMARK_ALL), EO_TYPECHECK(Eina_Bool *, ret)
Since
1.8

Clears all marked matches in the document

Parameters
[out]ret
See Also
elm_web_text_matches_unmark_all

Referenced by elm_web_text_matches_unmark_all().

#define elm_obj_web_text_search (   string,
  case_sensitive,
  forward,
  wrap,
  ret 
)    ELM_OBJ_WEB_ID(ELM_OBJ_WEB_SUB_ID_TEXT_SEARCH), EO_TYPECHECK(const char *, string), EO_TYPECHECK(Eina_Bool, case_sensitive), EO_TYPECHECK(Eina_Bool, forward), EO_TYPECHECK(Eina_Bool, wrap), EO_TYPECHECK(Eina_Bool *, ret)
Since
1.8

Searches the given string in a document.

Parameters
[in]string
[in]case_sensitive
[in]forward
[in]wrap
[out]ret
See Also
elm_web_text_search

Referenced by elm_web_text_search().

#define elm_obj_web_title_get (   ret)    ELM_OBJ_WEB_ID(ELM_OBJ_WEB_SUB_ID_TITLE_GET), EO_TYPECHECK(const char **, ret)
Since
1.8

Get the current title

Parameters
[out]ret
See Also
elm_web_title_get

Referenced by elm_web_title_get().

#define elm_obj_web_url_get (   ret)    ELM_OBJ_WEB_ID(ELM_OBJ_WEB_SUB_ID_URL_GET), EO_TYPECHECK(const char **, ret)
Since
1.8

Get the current URL for the object

Parameters
[out]ret
See Also
elm_web_url_get

Referenced by elm_web_uri_get(), and elm_web_url_get().

#define elm_obj_web_url_set (   url,
  ret 
)    ELM_OBJ_WEB_ID(ELM_OBJ_WEB_SUB_ID_URL_SET), EO_TYPECHECK(const char *, url), EO_TYPECHECK(Eina_Bool *, ret)
Since
1.8

Sets the URL for the web object

Parameters
[in]url
[out]ret
See Also
elm_web_url_set

Referenced by elm_web_uri_set(), and elm_web_url_set().

#define elm_obj_web_useragent_get (   ret)    ELM_OBJ_WEB_ID(ELM_OBJ_WEB_SUB_ID_USERAGENT_GET), EO_TYPECHECK(const char **, ret)
Since
1.8

Return current useragent of elm_web object

Parameters
[out]ret
See Also
elm_web_useragent_get

Referenced by elm_web_useragent_get().

#define elm_obj_web_useragent_set (   user_agent)    ELM_OBJ_WEB_ID(ELM_OBJ_WEB_SUB_ID_USERAGENT_SET), EO_TYPECHECK(const char *, user_agent)
Since
1.8

Change useragent of a elm_web object

Parameters
[in]user_agent
See Also
elm_web_useragent_set

Referenced by elm_web_useragent_set().

#define elm_obj_web_webkit_view_get (   ret)    ELM_OBJ_WEB_ID(ELM_OBJ_WEB_SUB_ID_WEBKIT_VIEW_GET), EO_TYPECHECK(Evas_Object **, ret)
Since
1.8

Get internal ewk_view object from web object.

Parameters
[out]ret
See Also
elm_web_webkit_view_get

Referenced by elm_web_webkit_view_get().

#define elm_obj_web_window_create_hook_set (   func,
  data 
)    ELM_OBJ_WEB_ID(ELM_OBJ_WEB_SUB_ID_WINDOW_CREATE_HOOK_SET), EO_TYPECHECK(Elm_Web_Window_Open, func), EO_TYPECHECK(void *, data)
Since
1.8

Sets the function to call when a new window is requested

Parameters
[in]func
[in]data
See Also
elm_web_window_create_hook_set

Referenced by elm_web_window_create_hook_set().

#define elm_obj_web_zoom_get (   ret)    ELM_OBJ_WEB_ID(ELM_OBJ_WEB_SUB_ID_ZOOM_GET), EO_TYPECHECK(double *, ret)
Since
1.8

Get the current zoom level set on the web object

Parameters
[out]ret
See Also
elm_web_zoom_get

Referenced by elm_web_zoom_get().

#define elm_obj_web_zoom_mode_get (   ret)    ELM_OBJ_WEB_ID(ELM_OBJ_WEB_SUB_ID_ZOOM_MODE_GET), EO_TYPECHECK(Elm_Web_Zoom_Mode *, ret)
Since
1.8

Get the currently set zoom mode

Parameters
[out]ret
See Also
elm_web_zoom_mode_get

Referenced by elm_web_zoom_mode_get().

#define elm_obj_web_zoom_mode_set (   mode)    ELM_OBJ_WEB_ID(ELM_OBJ_WEB_SUB_ID_ZOOM_MODE_SET), EO_TYPECHECK(Elm_Web_Zoom_Mode, mode)
Since
1.8

Sets the zoom mode to use

Parameters
[in]mode
See Also
elm_web_zoom_mode_set

Referenced by elm_web_zoom_mode_set().

#define elm_obj_web_zoom_set (   zoom)    ELM_OBJ_WEB_ID(ELM_OBJ_WEB_SUB_ID_ZOOM_SET), EO_TYPECHECK(double, zoom)
Since
1.8

Sets the zoom level of the web object

Parameters
[in]zoom
See Also
elm_web_zoom_set

Referenced by elm_web_zoom_set().

Typedef Documentation

typedef void(* Elm_Web_Console_Message)(void *data, Evas_Object *obj, const char *message, unsigned int line_number, const char *source_id)

Callback type for the JS console message hook.

When a console message is added from JavaScript, any set function to the console message hook will be called for the user to handle. There is no default implementation of this hook.

Parameters
dataUser data pointer set when setting the hook function.
objThe elm_web object that originated the message.
messageThe message sent.
line_numberThe line number.
source_idSource id.
See Also
elm_web_console_message_hook_set()
typedef Evas_Object*(* Elm_Web_Dialog_Alert)(void *data, Evas_Object *obj, const char *message)

Callback type for the JS alert hook.

Parameters
dataUser data pointer set when setting the hook function.
objThe elm_web object requesting the new window.
messageThe message to show in the alert dialog.
Returns
The object representing the alert dialog. Elm_Web will run a second main loop to handle the dialog and normal flow of the application will be restored when the object is deleted, so the user should handle the popup properly in order to delete the object when the action is finished. If the function returns NULL the popup will be ignored.
See Also
elm_web_dialog_alert_hook_set()
typedef Evas_Object*(* Elm_Web_Dialog_Confirm)(void *data, Evas_Object *obj, const char *message, Eina_Bool *ret)

Callback type for the JS confirm hook.

Parameters
dataUser data pointer set when setting the hook function.
objThe elm_web object requesting the new window.
messageThe message to show in the confirm dialog.
retPointer to store the user selection. EINA_TRUE if the user selected Ok, EINA_FALSE otherwise.
Returns
The object representing the confirm dialog. Elm_Web will run a second main loop to handle the dialog and normal flow of the application will be restored when the object is deleted, so the user should handle the popup properly in order to delete the object when the action is finished. If the function returns NULL the popup will be ignored.
See Also
elm_web_dialog_confirm_hook_set()
typedef Evas_Object*(* Elm_Web_Dialog_File_Selector)(void *data, Evas_Object *obj, Eina_Bool allows_multiple, Eina_List *accept_types, Eina_List **selected, Eina_Bool *ret)

Callback type for the JS file selector hook.

Parameters
dataUser data pointer set when setting the hook function.
objThe elm_web object requesting the new window.
allows_multipleEINA_TRUE if multiple files can be selected.
accept_typesMime types accepted.
selectedPointer to store the list of malloc'ed strings containing the path to each file selected. Must be NULL if the file dialog is canceled.
retPointer to store the user selection. EINA_TRUE if the user selected Ok, EINA_FALSE otherwise.
Returns
The object representing the file selector dialog. Elm_Web will run a second main loop to handle the dialog and normal flow of the application will be restored when the object is deleted, so the user should handle the popup properly in order to delete the object when the action is finished. If the function returns NULL the popup will be ignored.
See Also
elm_web_dialog_file selector_hook_set()
typedef Evas_Object*(* Elm_Web_Dialog_Prompt)(void *data, Evas_Object *obj, const char *message, const char *def_value, const char **value, Eina_Bool *ret)

Callback type for the JS prompt hook.

Parameters
dataUser data pointer set when setting the hook function.
objThe elm_web object requesting the new window.
messageThe message to show in the prompt dialog.
def_valueThe default value to present the user in the entry
valuePointer to store the value given by the user. Must be a malloc'ed string or NULL if the user canceled the popup.
retPointer to store the user selection. EINA_TRUE if the user selected Ok, EINA_FALSE otherwise.
Returns
The object representing the prompt dialog. Elm_Web will run a second main loop to handle the dialog and normal flow of the application will be restored when the object is deleted, so the user should handle the popup properly in order to delete the object when the action is finished. If the function returns NULL the popup will be ignored.
See Also
elm_web_dialog_prompt_hook_set()
typedef struct _Elm_Web_Menu Elm_Web_Menu

Structure describing the menu of a popup.

This structure will be passed as the event_info for the "popup,create" signal, which is emitted when a dropdown menu is opened. Users wanting to handle these popups by themselves should listen to this signal and set the handled property of the struct to EINA_TRUE. Leaving this property as EINA_FALSE means that the user will not handle the popup and the default implementation will be used.

When the popup is ready to be dismissed, a "popup,willdelete" signal will be emitted to notify the user that it can destroy any objects and free all data related to it.

See Also
elm_web_popup_selected_set()
elm_web_popup_destroy()
typedef Evas_Object*(* Elm_Web_Window_Open)(void *data, Evas_Object *obj, Eina_Bool js, const Elm_Web_Window_Features *window_features)

Callback type for the create_window hook.

Parameters
dataUser data pointer set when setting the hook function.
objThe elm_web object requesting the new window.
jsSet to EINA_TRUE if the request was originated from JavaScript. EINA_FALSE otherwise.
window_featuresA pointer of #Elm_Web_Window_Features indicating the features requested for the new window.
Returns
The elm_web widget where the request will be loaded. That is, if a new window or tab is created, the elm_web widget in it should be returned, and NOT the window object. Returning NULL should cancel the request.
See Also
elm_web_window_create_hook_set()

Function Documentation

Eina_Bool elm_need_web ( void  )

Request that your elementary application needs web support.

This initializes the Ewebkit library when called and if support exists it returns EINA_TRUE, otherwise returns EINA_FALSE. This must be called before any other function that deals with elm_web objects or ewk_view instances.

Examples:
web_example_02.c.
Evas_Object* elm_web_add ( Evas_Object *  parent)

Add a new web object to the parent.

Parameters
parentThe parent object.
Returns
The new object or NULL if it cannot be created.
See Also
elm_web_uri_set()
elm_web_webkit_view_get()
Eina_Bool elm_web_back ( Evas_Object *  obj)

Goes back one step in the browsing history.

This is equivalent to calling elm_web_object_navigate(obj, -1);

Parameters
objThe web object
Returns
EINA_TRUE on success, EINA_FALSE otherwise
See Also
elm_web_history_enabled_set()
elm_web_back_possible()
elm_web_forward()
elm_web_navigate()

References elm_obj_web_back.

Eina_Bool elm_web_back_possible_get ( Evas_Object *  obj)

Queries whether it's possible to go back in history.

Parameters
objThe web object
Returns
EINA_TRUE if it's possible to back in history, EINA_FALSE otherwise

References elm_obj_web_back_possible_get.

void elm_web_bg_color_get ( const Evas_Object *  obj,
int *  r,
int *  g,
int *  b,
int *  a 
)

Get the background color to be used by the web object.

This is the color that will be used by default when the loaded page does not set it's own. Color values are pre-multiplied.

Parameters
objThe web object
rRed component
gGreen component
bBlue component
aAlpha component

References elm_obj_web_bg_color_get.

void elm_web_bg_color_set ( Evas_Object *  obj,
int  r,
int  g,
int  b,
int  a 
)

Sets the background color to be used by the web object.

This is the color that will be used by default when the loaded page does not set it's own. Color values are pre-multiplied.

Parameters
objThe web object
rRed component
gGreen component
bBlue component
aAlpha component

References elm_obj_web_bg_color_set.

void elm_web_console_message_hook_set ( Evas_Object *  obj,
Elm_Web_Console_Message  func,
void *  data 
)

Sets the function to call when a console message is emitted from JS.

This hook will be called when a console message is emitted from JavaScript. There is no default implementation for this feature.

Parameters
objThe web object where to set the hook function
funcThe callback function to be used
dataUser data

References elm_obj_web_console_message_hook_set.

void elm_web_dialog_alert_hook_set ( Evas_Object *  obj,
Elm_Web_Dialog_Alert  func,
void *  data 
)

Sets the function to call when an alert dialog.

This hook will be called when a JavaScript alert dialog is requested. If no function is set or NULL is passed in func, the default implementation will take place.

Parameters
objThe web object where to set the hook function
funcThe callback function to be used
dataUser data
See Also
elm_web_inwin_mode_set()

References elm_obj_web_dialog_alert_hook_set.

void elm_web_dialog_confirm_hook_set ( Evas_Object *  obj,
Elm_Web_Dialog_Confirm  func,
void *  data 
)

Sets the function to call when an confirm dialog.

This hook will be called when a JavaScript confirm dialog is requested. If no function is set or NULL is passed in func, the default implementation will take place.

Parameters
objThe web object where to set the hook function
funcThe callback function to be used
dataUser data
See Also
elm_web_inwin_mode_set()

References elm_obj_web_dialog_confirm_hook_set.

void elm_web_dialog_file_selector_hook_set ( Evas_Object *  obj,
Elm_Web_Dialog_File_Selector  func,
void *  data 
)

Sets the function to call when an file selector dialog.

This hook will be called when a JavaScript file selector dialog is requested. If no function is set or NULL is passed in func, the default implementation will take place.

Parameters
objThe web object where to set the hook function
funcThe callback function to be used
dataUser data
See Also
elm_web_inwin_mode_set()

References elm_obj_web_dialog_file_selector_hook_set.

void elm_web_dialog_prompt_hook_set ( Evas_Object *  obj,
Elm_Web_Dialog_Prompt  func,
void *  data 
)

Sets the function to call when an prompt dialog.

This hook will be called when a JavaScript prompt dialog is requested. If no function is set or NULL is passed in func, the default implementation will take place.

Parameters
objThe web object where to set the hook function
funcThe callback function to be used
dataUser data
See Also
elm_web_inwin_mode_set()

References elm_obj_web_dialog_prompt_hook_set.

Eina_Bool elm_web_forward ( Evas_Object *  obj)

Goes forward one step in the browsing history.

This is equivalent to calling elm_web_object_navigate(obj, 1);

Parameters
objThe web object
Returns
EINA_TRUE on success, EINA_FALSE otherwise
See Also
elm_web_history_enabled_set()
elm_web_forward_possible_get()
elm_web_back()
elm_web_navigate()

References elm_obj_web_forward.

Eina_Bool elm_web_forward_possible_get ( Evas_Object *  obj)

Queries whether it's possible to go forward in history.

Parameters
objThe web object
Returns
EINA_TRUE if it's possible to forward in history, EINA_FALSE otherwise

References elm_obj_web_forward_possible_get.

Eina_Bool elm_web_history_enabled_get ( const Evas_Object *  obj)

Get whether browsing history is enabled for the given object.

Parameters
objThe web object
Returns
EINA_TRUE if history is enabled, EINA_FALSE otherwise

References elm_obj_web_history_enabled_get.

void elm_web_history_enabled_set ( Evas_Object *  obj,
Eina_Bool  enabled 
)

Enables or disables the browsing history.

Parameters
objThe web object
enabledWhether to enable or disable the browsing history

References elm_obj_web_history_enabled_set.

Eina_Bool elm_web_html_string_load ( Evas_Object *  obj,
const char *  html,
const char *  base_url,
const char *  unreachable_url 
)

Loads the specified html string as the content of the web object.

Parameters
objThe web object
htmlHTML data to load
base_urlBase URL used for relative paths to external objects (optional)
unreachable_urlURL that could not be reached (optional)
Returns
EINA_TRUE if it the HTML was successfully loaded, EINA_FALSE otherwise

External objects such as stylesheets or images referenced in the HTML document are located relative to base_url.

If an unreachable_url 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
1.9

References elm_obj_web_html_string_load.

Eina_Bool elm_web_inwin_mode_get ( const Evas_Object *  obj)

Get whether Inwin mode is set for the current object.

Parameters
objThe web object
Returns
EINA_TRUE if Inwin mode is set, EINA_FALSE otherwise

References elm_obj_web_inwin_mode_get.

void elm_web_inwin_mode_set ( Evas_Object *  obj,
Eina_Bool  value 
)

Sets the default dialogs to use an Inwin instead of a normal window.

If set, then the default implementation for the JavaScript dialogs and file selector will be opened in an Inwin. Otherwise they will use a normal separated window.

Parameters
objThe web object
valueEINA_TRUE to use Inwin, EINA_FALSE to use a normal window

References elm_obj_web_inwin_mode_set.

double elm_web_load_progress_get ( const Evas_Object *  obj)

Get the overall loading progress of the page.

Returns the estimated loading progress of the page, with a value between 0.0 and 1.0. This is an estimated progress accounting for all the frames included in the page.

Parameters
objThe web object
Returns
A value between 0.0 and 1.0 indicating the progress, or -1.0 on failure

References elm_obj_web_load_progress_get.

Eina_Bool elm_web_navigate ( Evas_Object *  obj,
int  steps 
)

Jumps the given number of steps in the browsing history.

The steps value can be a negative integer to back in history, or a positive to move forward.

Parameters
objThe web object
stepsThe number of steps to jump
Returns
EINA_TRUE on success, EINA_FALSE on error or if not enough history exists to jump the given number of steps
See Also
elm_web_history_enabled_set()
elm_web_back()
elm_web_forward()

References elm_obj_web_navigate.

Eina_Bool elm_web_navigate_possible_get ( Evas_Object *  obj,
int  steps 
)

Queries whether it's possible to jump the given number of steps.

The steps value can be a negative integer to back in history, or a positive to move forward.

Parameters
objThe web object
stepsThe number of steps to check for
Returns
EINA_TRUE if enough history exists to perform the given jump, EINA_FALSE otherwise

References elm_obj_web_navigate_possible_get.

Eina_Bool elm_web_popup_destroy ( Evas_Object *  obj)

Dismisses an open dropdown popup.

When the popup from a dropdown widget is to be dismissed, either after selecting an option or to cancel it, this function must be called, which will later emit an "popup,willdelete" signal to notify the user that any memory and objects related to this popup can be freed.

Parameters
objThe web object
Returns
EINA_TRUE if the menu was successfully destroyed, or EINA_FALSE if there was no menu to destroy

References elm_obj_web_popup_destroy.

void elm_web_popup_selected_set ( Evas_Object *  obj,
int  index 
)

Tells the web object which index in the currently open popup was selected.

When the user handles the popup creation from the "popup,created" signal, it needs to tell the web object which item was selected by calling this function with the index corresponding to the item.

Parameters
objThe web object
indexThe index selected
See Also
elm_web_popup_destroy()

References elm_obj_web_popup_selected_set.

void elm_web_region_bring_in ( Evas_Object *  obj,
int  x,
int  y,
int  w,
int  h 
)

Brings in the region to the visible area.

Like elm_web_region_show(), but it animates the scrolling of the object to show the area

Parameters
objThe web object
xThe x coordinate of the region to show
yThe y coordinate of the region to show
wThe width of the region to show
hThe height of the region to show

References elm_obj_web_region_bring_in.

void elm_web_region_show ( Evas_Object *  obj,
int  x,
int  y,
int  w,
int  h 
)

Shows the given region in the web object.

Parameters
objThe web object
xThe x coordinate of the region to show
yThe y coordinate of the region to show
wThe width of the region to show
hThe height of the region to show

References elm_obj_web_region_show.

Eina_Bool elm_web_reload ( Evas_Object *  obj)

Requests a reload of the current document in the object.

Parameters
objThe web object
Returns
EINA_TRUE on success, EINA_FALSE otherwise

References elm_obj_web_reload.

Eina_Bool elm_web_reload_full ( Evas_Object *  obj)

Requests a reload of the current document, avoiding any existing caches.

Parameters
objThe web object
Returns
EINA_TRUE on success, EINA_FALSE otherwise

References elm_obj_web_reload_full.

const char* elm_web_selection_get ( const Evas_Object *  obj)

Get a copy of the currently selected text.

The string returned must be freed by the user when it's done with it.

Parameters
objThe web object
Returns
A newly allocated string, or NULL if nothing is selected or an error occurred

References elm_obj_web_selection_get.

Eina_Bool elm_web_stop ( Evas_Object *  obj)

Stops loading the current page.

Cancels the loading of the current page in the web object. This will cause a "load,error" signal to be emitted, with the is_cancellation flag set to EINA_TRUE.

Parameters
objThe web object
Returns
EINA_TRUE if the cancel was successful, EINA_FALSE otherwise

References elm_obj_web_stop.

Eina_Bool elm_web_tab_propagate_get ( const Evas_Object *  obj)

Get the status of the tab propagation.

Parameters
objThe web object to query
Returns
EINA_TRUE if tab propagation is enabled, EINA_FALSE otherwise
See Also
elm_web_tab_propagate_set()

References elm_obj_web_tab_propagate_get.

void elm_web_tab_propagate_set ( Evas_Object *  obj,
Eina_Bool  propagate 
)

Sets whether to use tab propagation.

If tab propagation is enabled, whenever the user presses the Tab key, Elementary will handle it and switch focus to the next widget. The default value is disabled, where WebKit will handle the Tab key to cycle focus though its internal objects, jumping to the next widget only when that cycle ends.

Parameters
objThe web object
propagateWhether to propagate Tab keys to Elementary or not

References elm_obj_web_tab_propagate_set.

Eina_Bool elm_web_text_matches_highlight_get ( const Evas_Object *  obj)

Get whether highlighting marks is enabled.

Parameters
objThe web object
Returns
EINA_TRUE is marks are set to be highlighted, EINA_FALSE otherwise

References elm_obj_web_text_matches_highlight_get.

Eina_Bool elm_web_text_matches_highlight_set ( Evas_Object *  obj,
Eina_Bool  highlight 
)

Sets whether to highlight the matched marks.

If enabled, marks set with elm_web_text_matches_mark() will be highlighted.

Parameters
objThe web object
highlightWhether to highlight the marks or not
Returns
EINA_TRUE on success, EINA_FALSE otherwise

References elm_obj_web_text_matches_highlight_set.

unsigned int elm_web_text_matches_mark ( Evas_Object *  obj,
const char *  string,
Eina_Bool  case_sensitive,
Eina_Bool  highlight,
unsigned int  limit 
)

Marks matches of the given string in a document.

Parameters
objThe web object where to search text
stringString to match
case_sensitiveIf match should be case sensitive or not
highlightIf matches should be highlighted
limitMaximum amount of matches, or zero to unlimited
Returns
number of matched string

References elm_obj_web_text_matches_mark.

Eina_Bool elm_web_text_matches_unmark_all ( Evas_Object *  obj)

Clears all marked matches in the document.

Parameters
objThe web object
Returns
EINA_TRUE on success, EINA_FALSE otherwise

References elm_obj_web_text_matches_unmark_all.

Eina_Bool elm_web_text_search ( const Evas_Object *  obj,
const char *  string,
Eina_Bool  case_sensitive,
Eina_Bool  forward,
Eina_Bool  wrap 
)

Searches the given string in a document.

Parameters
objThe web object where to search the text
stringString to search
case_sensitiveIf search should be case sensitive or not
forwardIf search is from cursor and on or backwards
wrapIf search should wrap at the end
Returns
EINA_TRUE if the given string was found, EINA_FALSE if not or failure

References elm_obj_web_text_search.

const char* elm_web_title_get ( const Evas_Object *  obj)

Get the current title.

The returned string must not be freed and is guaranteed to be stringshared.

Parameters
objThe web object
Returns
A stringshared internal string with the current title, or NULL on failure

References elm_obj_web_title_get.

EINA_DEPRECATED const char* elm_web_uri_get ( const Evas_Object *  obj)

Get the current URI for the object.

The returned string must not be freed and is guaranteed to be stringshared.

Parameters
objThe web object
Returns
A stringshared internal string with the current URI, or NULL on failure
Deprecated:
Use elm_web_url_get() instead
See Also
elm_web_url_get()

References elm_obj_web_url_get.

EINA_DEPRECATED Eina_Bool elm_web_uri_set ( Evas_Object *  obj,
const char *  uri 
)

Sets the URI for the web object.

It must be a full URI, with resource included, in the form http://www.enlightenment.org or file:///tmp/something.html

Parameters
objThe web object
uriThe URI to set
Returns
EINA_TRUE if the URI could be set, EINA_FALSE if an error occurred.
Deprecated:
Use elm_web_url_set() instead
See Also
elm_web_url_set()

References elm_obj_web_url_set.

const char* elm_web_url_get ( const Evas_Object *  obj)

Get the current URL for the object.

The returned string must not be freed and is guaranteed to be stringshared.

Parameters
objThe web object
Returns
A stringshared internal string with the current URL, or NULL on failure

References elm_obj_web_url_get.

Eina_Bool elm_web_url_set ( Evas_Object *  obj,
const char *  url 
)

Sets the URL for the web object.

It must be a full URL, with resource included, in the form http://www.enlightenment.org or file:///tmp/something.html

Parameters
objThe web object
urlThe URL to set
Returns
EINA_TRUE if the URL could be set, EINA_FALSE if an error occurred.

References elm_obj_web_url_set.

const char* elm_web_useragent_get ( const Evas_Object *  obj)

Return current useragent of elm_web object.

Parameters
objThe object
Returns
Useragent string

References elm_obj_web_useragent_get.

void elm_web_useragent_set ( Evas_Object *  obj,
const char *  user_agent 
)

Change useragent of a elm_web object.

Parameters
objThe object
user_agentString for useragent

References elm_obj_web_useragent_set.

Evas_Object* elm_web_webkit_view_get ( const Evas_Object *  obj)

Get internal ewk_view object from web object.

Elementary may not provide some low level features of EWebKit, instead of cluttering the API with proxy methods we opted to return the internal reference. Be careful using it as it may interfere with elm_web behavior.

Parameters
objThe web object.
Returns
The internal ewk_view object or NULL if it does not exist. (Failure to create or Elementary compiled without ewebkit)
See Also
elm_web_add()

References elm_obj_web_webkit_view_get.

void elm_web_window_create_hook_set ( Evas_Object *  obj,
Elm_Web_Window_Open  func,
void *  data 
)

Sets the function to call when a new window is requested.

This hook will be called when a request to create a new window is issued from the web page loaded. There is no default implementation for this feature, so leaving this unset or passing NULL in func will prevent new windows from opening.

Parameters
objThe web object where to set the hook function
funcThe hook function to be called when a window is requested
dataUser data

References elm_obj_web_window_create_hook_set.

Eina_Bool elm_web_window_features_property_get ( const Elm_Web_Window_Features *  wf,
Elm_Web_Window_Feature_Flag  flag 
)

Get boolean properties from Elm_Web_Window_Features (such as statusbar, menubar, etc) that are on a window.

Parameters
wfThe web window features object
flagThe web window feature flag whose value is required.
Returns
EINA_TRUE if the flag is set, EINA_FALSE otherwise
void elm_web_window_features_region_get ( const Elm_Web_Window_Features *  wf,
Evas_Coord *  x,
Evas_Coord *  y,
Evas_Coord *  w,
Evas_Coord *  h 
)

TODO : Add documentation.

Parameters
wfThe web window features object
x,y,w,h- the co-ordinates of the web view window.
double elm_web_zoom_get ( const Evas_Object *  obj)

Get the current zoom level set on the web object.

Note that this is the zoom level set on the web object and not that of the underlying Webkit one. In the ::ELM_WEB_ZOOM_MODE_MANUAL mode, the two zoom levels should match, but for the other two modes the Webkit zoom is calculated internally to match the chosen mode without changing the zoom level set for the web object.

Parameters
objThe web object
Returns
The zoom level set on the object

References elm_obj_web_zoom_get.

Elm_Web_Zoom_Mode elm_web_zoom_mode_get ( const Evas_Object *  obj)

Get the currently set zoom mode.

Parameters
objThe web object
Returns
The current zoom mode set for the object, or ::ELM_WEB_ZOOM_MODE_LAST on error

References elm_obj_web_zoom_mode_get.

void elm_web_zoom_mode_set ( Evas_Object *  obj,
Elm_Web_Zoom_Mode  mode 
)

Sets the zoom mode to use.

The modes can be any of those defined in ::Elm_Web_Zoom_Mode, except ::ELM_WEB_ZOOM_MODE_LAST. The default is ::ELM_WEB_ZOOM_MODE_MANUAL.

::ELM_WEB_ZOOM_MODE_MANUAL means the zoom level will be controlled with the elm_web_zoom_set() function. ::ELM_WEB_ZOOM_MODE_AUTO_FIT will calculate the needed zoom level to make sure the entirety of the web object's contents are shown. ::ELM_WEB_ZOOM_MODE_AUTO_FILL will calculate the needed zoom level to fit the contents in the web object's size, without leaving any space unused.

Parameters
objThe web object
modeThe mode to set

References elm_obj_web_zoom_mode_set.

void elm_web_zoom_set ( Evas_Object *  obj,
double  zoom 
)

Sets the zoom level of the web object.

Zoom level matches the Webkit API, so 1.0 means normal zoom, with higher values meaning zoom in and lower meaning zoom out. This function will only affect the zoom level if the mode set with elm_web_zoom_mode_set() is ::ELM_WEB_ZOOM_MODE_MANUAL.

Parameters
objThe web object
zoomThe zoom level to set

References elm_obj_web_zoom_set.