Data Structures

struct  _Elm_Web_Frame_Load_Error
 Structure used to report load errors. More...
struct  _Elm_Web_Menu_Item
 Structure describing the items in a menu. More...
struct  _Elm_Web_Menu
 Structure describing the menu of a popup. More...

Typedefs

typedef struct
_Elm_Web_Frame_Load_Error 
Elm_Web_Frame_Load_Error
 Structure used to report load errors.
typedef struct _Elm_Web_Menu_Item Elm_Web_Menu_Item
 Structure describing the items in a menu.
typedef struct _Elm_Web_Menu Elm_Web_Menu
 Structure describing the menu of a popup.
typedef struct
_Elm_Web_Window_Features 
Elm_Web_Window_Features
 Opaque handler containing the features (such as statusbar, menubar, etc) that are to be set on a newly requested window.
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.
typedef Evas_Object *(* Elm_Web_Dialog_Alert )(void *data, Evas_Object *obj, const char *message)
 Callback type for the JS alert hook.
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.
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.
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.
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.

Enumerations

enum  Elm_Web_Menu_Item_Type
 The possibles types that the items in a menu can be.
enum  Elm_Web_Zoom_Mode {
  ELM_WEB_ZOOM_MODE_MANUAL = 0,
  ELM_WEB_ZOOM_MODE_AUTO_FIT,
  ELM_WEB_ZOOM_MODE_AUTO_FILL,
  ELM_WEB_ZOOM_MODE_LAST
}
 Types of zoom available. More...
enum  Elm_Web_Window_Feature_Flag
 Definitions of web window features.

Functions

Eina_Bool elm_need_web (void)
 Request that your elementary application needs web support.
Evas_Object * elm_web_add (Evas_Object *parent)
 Add a new web object to the parent.
void elm_web_useragent_set (Evas_Object *obj, const char *user_agent)
 Change useragent of a elm_web object.
const char * elm_web_useragent_get (const Evas_Object *obj)
 Return current useragent of elm_web object.
Evas_Object * elm_web_webkit_view_get (const Evas_Object *obj)
 Get internal ewk_view object from web object.
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.
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.
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.
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.
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.
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.
Eina_Bool elm_web_tab_propagate_get (const Evas_Object *obj)
 Gets the status of the tab propagation.
void elm_web_tab_propagate_set (Evas_Object *obj, Eina_Bool propagate)
 Sets whether to use tab propagation.
Eina_Bool elm_web_uri_set (Evas_Object *obj, const char *uri)
 Sets the URI for the web object.
const char * elm_web_uri_get (const Evas_Object *obj)
 Gets the current URI for the object.
const char * elm_web_title_get (const Evas_Object *obj)
 Gets the current title.
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.
void elm_web_bg_color_get (const Evas_Object *obj, int *r, int *g, int *b, int *a)
 Gets the background color to be used by the web object.
const char * elm_web_selection_get (const Evas_Object *obj)
 Gets a copy of the currently selected text.
void elm_web_popup_selected_set (Evas_Object *obj, int index)
 Tells the web object which index in the currently open popup was selected.
Eina_Bool elm_web_popup_destroy (Evas_Object *obj)
 Dismisses an open dropdown popup.
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.
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.
Eina_Bool elm_web_text_matches_unmark_all (Evas_Object *obj)
 Clears all marked matches in the document.
Eina_Bool elm_web_text_matches_highlight_set (Evas_Object *obj, Eina_Bool highlight)
 Sets whether to highlight the matched marks.
Eina_Bool elm_web_text_matches_highlight_get (const Evas_Object *obj)
 Gets whether highlighting marks is enabled.
double elm_web_load_progress_get (const Evas_Object *obj)
 Gets the overall loading progress of the page.
Eina_Bool elm_web_stop (Evas_Object *obj)
 Stops loading the current page.
Eina_Bool elm_web_reload (Evas_Object *obj)
 Requests a reload of the current document in the object.
Eina_Bool elm_web_reload_full (Evas_Object *obj)
 Requests a reload of the current document, avoiding any existing caches.
Eina_Bool elm_web_back (Evas_Object *obj)
 Goes back one step in the browsing history.
Eina_Bool elm_web_forward (Evas_Object *obj)
 Goes forward one step in the browsing history.
Eina_Bool elm_web_navigate (Evas_Object *obj, int steps)
 Jumps the given number of steps in the browsing history.
Eina_Bool elm_web_back_possible_get (Evas_Object *obj)
 Queries whether it's possible to go back in history.
Eina_Bool elm_web_forward_possible_get (Evas_Object *obj)
 Queries whether it's possible to go forward in history.
Eina_Bool elm_web_navigate_possible_get (Evas_Object *obj, int steps)
 Queries whether it's possible to jump the given number of steps.
Eina_Bool elm_web_history_enabled_get (const Evas_Object *obj)
 Gets whether browsing history is enabled for the given object.
void elm_web_history_enabled_set (Evas_Object *obj, Eina_Bool enabled)
 Enables or disables the browsing history.
void elm_web_zoom_set (Evas_Object *obj, double zoom)
 Sets the zoom level of the web object.
double elm_web_zoom_get (const Evas_Object *obj)
 Gets the current zoom level set on the web object.
void elm_web_zoom_mode_set (Evas_Object *obj, Elm_Web_Zoom_Mode mode)
 Sets the zoom mode to use.
Elm_Web_Zoom_Mode elm_web_zoom_mode_get (const Evas_Object *obj)
 Gets the currently set zoom mode.
void elm_web_region_show (Evas_Object *obj, int x, int y, int w, int h)
 Shows the given region in the web object.
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.
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.
Eina_Bool elm_web_inwin_mode_get (const Evas_Object *obj)
 Gets whether Inwin mode is set for the current object.
Eina_Bool elm_web_window_features_property_get (const Elm_Web_Window_Features *wf, Elm_Web_Window_Feature_Flag flag)
 Gets boolean properties from Elm_Web_Window_Features (such as statusbar, menubar, etc) that are on a window.
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.

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:

  • "download,request": A file download has been requested. Event info is a pointer to a Elm_Web_Download
  • "editorclient,contents,changed": Editor client's contents changed
  • "editorclient,selection,changed": Editor client's selection changed
  • "frame,created": A new frame was created. Event info is an Evas_Object which can be handled with WebKit's ewk_frame API
  • "icon,received": An icon was received by the main frame
  • "inputmethod,changed": Input method changed. Event info is an Eina_Bool indicating whether it's enabled or not
  • "js,windowobject,clear": JS window object has been cleared
  • "link,hover,in": Mouse cursor is hovering over a link. Event info is a char *link[2], where the first string contains the URL the link points to, and the second one the title of the link
  • "link,hover,out": Mouse cursor left the link
  • "load,document,finished": Loading of a document finished. Event info is the frame that finished loading
  • "load,error": Load failed. Event info is a pointer to Elm_Web_Frame_Load_Error
  • "load,finished": Load finished. Event info is NULL on success, on error it's a pointer to Elm_Web_Frame_Load_Error
  • "load,newwindow,show": A new window was created and is ready to be shown
  • "load,progress": Overall load progress. Event info is a pointer to a double containing a value between 0.0 and 1.0
  • "load,provisional": Started provisional load
  • "load,started": Loading of a document started
  • "menubar,visible,get": Queries if the menubar is visible. Event info is a pointer to Eina_Bool where the callback should set EINA_TRUE if the menubar is visible, or EINA_FALSE in case it's not
  • "menubar,visible,set": Informs menubar visibility. Event info is an Eina_Bool indicating the visibility
  • "popup,created": A dropdown widget was activated, requesting its popup menu to be created. Event info is a pointer to Elm_Web_Menu
  • "popup,willdelete": The web object is ready to destroy the popup object created. Event info is a pointer to Elm_Web_Menu
  • "ready": Page is fully loaded
  • "scrollbars,visible,get": Queries visibility of scrollbars. Event info is a pointer to Eina_Bool where the visibility state should be set
  • "scrollbars,visible,set": Informs scrollbars visibility. Event info is an Eina_Bool with the visibility state set
  • "statusbar,text,set": Text of the statusbar changed. Even info is a string with the new text
  • "statusbar,visible,get": Queries visibility of the status bar. Event info is a pointer to Eina_Bool where the visibility state should be set.
  • "statusbar,visible,set": Informs statusbar visibility. Event info is an Eina_Bool with the visibility value
  • "title,changed": Title of the main frame changed. Event info is a string with the new title
  • "toolbars,visible,get": Queries visibility of toolbars. Event info is a pointer to Eina_Bool where the visibility state should be set
  • "toolbars,visible,set": Informs the visibility of toolbars. Event info is an Eina_Bool with the visibility state
  • "tooltip,text,set": Show and set text of a tooltip. Event info is a string with the text to show
  • "uri,changed": URI of the main frame changed. Event info is a string with the new URI
  • "view,resized": The web object internal's view changed sized
  • "windows,close,request": A JavaScript request to close the current window was requested
  • "zoom,animated,end": Animated zoom finished

available styles:

  • default

An example of use of web:


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()

Structure used to report load errors.

Load errors are reported as signal by elm_web. All the strings are temporary references and should not be used after the signal callback returns. If it's required, make copies with strdup() or eina_stringshare_add() (they are not even guaranteed to be stringshared, so must use eina_stringshare_add() and not eina_stringshare_ref()).

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()

Enumeration Type Documentation

Types of zoom available.

Enumerator:
ELM_WEB_ZOOM_MODE_MANUAL 

Zoom controlled normally by elm_web_zoom_set.

ELM_WEB_ZOOM_MODE_AUTO_FIT 

Zoom until content fits in web object.

ELM_WEB_ZOOM_MODE_AUTO_FILL 

Zoom until content fills web object.

ELM_WEB_ZOOM_MODE_LAST 

Sentinel value to indicate end.


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_WIDGET_DATA.

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_WIDGET_DATA.

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

Gets 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_WIDGET_DATA.

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_WIDGET_DATA.

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
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()
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()
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()
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()
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_WIDGET_DATA.

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_WIDGET_DATA.

Eina_Bool elm_web_history_enabled_get ( const Evas_Object *  obj)

Gets 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_WIDGET_DATA.

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_WIDGET_DATA.

Eina_Bool elm_web_inwin_mode_get ( const Evas_Object *  obj)

Gets whether Inwin mode is set for the current object.

Parameters:
objThe web object
Returns:
EINA_TRUE if Inwin mode is set, EINA_FALSE otherwise
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
double elm_web_load_progress_get ( const Evas_Object *  obj)

Gets 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_WIDGET_DATA.

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_WIDGET_DATA.

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_WIDGET_DATA.

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_WIDGET_DATA.

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_WIDGET_DATA.

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_WIDGET_DATA.

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_WIDGET_DATA.

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_WIDGET_DATA.

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_WIDGET_DATA.

const char* elm_web_selection_get ( const Evas_Object *  obj)

Gets 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_WIDGET_DATA.

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_WIDGET_DATA.

Eina_Bool elm_web_tab_propagate_get ( const Evas_Object *  obj)

Gets 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()
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
Eina_Bool elm_web_text_matches_highlight_get ( const Evas_Object *  obj)

Gets whether highlighting marks is enabled.

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

References ELM_WIDGET_DATA.

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_WIDGET_DATA.

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_WIDGET_DATA.

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_WIDGET_DATA.

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_WIDGET_DATA.

const char* elm_web_title_get ( const Evas_Object *  obj)

Gets 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_WIDGET_DATA.

const char* elm_web_uri_get ( const Evas_Object *  obj)

Gets 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

References ELM_WIDGET_DATA.

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.

References ELM_WIDGET_DATA.

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_WIDGET_DATA.

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_WIDGET_DATA.

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_WIDGET_DATA.

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
Eina_Bool elm_web_window_features_property_get ( const Elm_Web_Window_Features wf,
Elm_Web_Window_Feature_Flag  flag 
)

Gets 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)

Gets 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
Elm_Web_Zoom_Mode elm_web_zoom_mode_get ( const Evas_Object *  obj)

Gets 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_WEB_ZOOM_MODE_LAST.

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_WEB_ZOOM_MODE_LAST, and elm_web_zoom_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_WEB_ZOOM_MODE_AUTO_FILL, ELM_WEB_ZOOM_MODE_AUTO_FIT, ELM_WEB_ZOOM_MODE_MANUAL, and ELM_WIDGET_DATA.

Referenced by elm_web_zoom_mode_set().