Merge remote-tracking branch 'remotes/origin/upstream'
[framework/uifw/elementary.git] / src / lib / elm_web.h
index f20ac86..3739bf7 100644 (file)
@@ -4,7 +4,11 @@
  * @image html img/widget/web/preview-00.png
  * @image latex img/widget/web/preview-00.eps
  *
+<<<<<<< HEAD
+ * A web object is used for displaying web pages (HTML/CSS/JS)
+=======
  * A web widget is used for displaying web pages (HTML/CSS/JS)
+>>>>>>> remotes/origin/upstream
  * using WebKit-EFL. You must have compiled Elementary with
  * ewebkit support.
  *
@@ -109,7 +113,11 @@ typedef struct _Elm_Web_Frame_Load_Error Elm_Web_Frame_Load_Error;
 struct _Elm_Web_Frame_Load_Error
 {
    int          code; /**< Numeric error code */
+<<<<<<< HEAD
+   Eina_Bool    is_cancellation; /**< Error produced by cancelling a request */
+=======
    Eina_Bool    is_cancellation; /**< Error produced by canceling a request */
+>>>>>>> remotes/origin/upstream
    const char  *domain; /**< Error domain name */
    const char  *description; /**< Error description (already localized) */
    const char  *failing_url; /**< The URL that failed to load */
@@ -210,6 +218,8 @@ typedef enum
  */
 typedef struct _Elm_Web_Window_Features Elm_Web_Window_Features;
 
+<<<<<<< HEAD
+=======
 
 /**
  * Definitions of web window features.
@@ -225,6 +235,7 @@ typedef enum
    ELM_WEB_WINDOW_FEATURE_FULLSCREEN
 } Elm_Web_Window_Feature_Flag;
 
+>>>>>>> remotes/origin/upstream
 /**
  * Callback type for the create_window hook.
  *
@@ -272,7 +283,11 @@ typedef Evas_Object *(*Elm_Web_Dialog_Alert)(void *data, Evas_Object *obj, const
  * @li @p data User data pointer set when setting the hook function
  * @li @p obj The elm_web object requesting the new window
  * @li @p message The message to show in the confirm dialog
+<<<<<<< HEAD
+ * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
+=======
  * @li @p ret Pointer to store the user selection. @c EINA_TRUE if
+>>>>>>> remotes/origin/upstream
  * the user selected @c Ok, @c EINA_FALSE otherwise.
  *
  * The function should return the object representing the confirm dialog.
@@ -294,9 +309,15 @@ typedef Evas_Object *(*Elm_Web_Dialog_Confirm)(void *data, Evas_Object *obj, con
  * @li @p obj The elm_web object requesting the new window
  * @li @p message The message to show in the prompt dialog
  * @li @p def_value The default value to present the user in the entry
+<<<<<<< HEAD
+ * @li @p value Pointer where to store the value given by the user. Must
+ * be a malloc'ed string or @c NULL if the user cancelled the popup.
+ * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
+=======
  * @li @p value Pointer to store the value given by the user. Must
  * be a malloc'ed string or @c NULL if the user canceled the popup.
  * @li @p ret Pointer to store the user selection. @c EINA_TRUE if
+>>>>>>> remotes/origin/upstream
  * the user selected @c Ok, @c EINA_FALSE otherwise.
  *
  * The function should return the object representing the prompt dialog.
@@ -318,10 +339,17 @@ typedef Evas_Object *(*Elm_Web_Dialog_Prompt)(void *data, Evas_Object *obj, cons
  * @li @p obj The elm_web object requesting the new window
  * @li @p allows_multiple @c EINA_TRUE if multiple files can be selected.
  * @li @p accept_types Mime types accepted
+<<<<<<< HEAD
+ * @li @p selected Pointer where to store the list of malloc'ed strings
+ * containing the path to each file selected. Must be @c NULL if the file
+ * dialog is cancelled
+ * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
+=======
  * @li @p selected Pointer to store the list of malloc'ed strings
  * containing the path to each file selected. Must be @c NULL if the file
  * dialog is canceled
  * @li @p ret Pointer to store the user selection. @c EINA_TRUE if
+>>>>>>> remotes/origin/upstream
  * the user selected @c Ok, @c EINA_FALSE otherwise.
  *
  * The function should return the object representing the file selector
@@ -369,7 +397,11 @@ EAPI Evas_Object      *elm_web_add(Evas_Object *parent);
  * Change useragent of a elm_web object
  * 
  * @param obj The object
+<<<<<<< HEAD
+ * @param useragent String for useragent
+=======
  * @param user_agent String for useragent
+>>>>>>> remotes/origin/upstream
  *
  */
 EAPI void elm_web_useragent_set(Evas_Object *obj, const char *user_agent);
@@ -520,7 +552,11 @@ EAPI void              elm_web_tab_propagate_set(Evas_Object *obj, Eina_Bool pro
  *
  * @param obj The web object
  * @param uri The URI to set
+<<<<<<< HEAD
+ * @return EINA_TRUE if the URI could be, EINA_FALSE if an error occurred
+=======
  * @return EINA_TRUE if the URI could be set, EINA_FALSE if an error occurred
+>>>>>>> remotes/origin/upstream
  */
 EAPI Eina_Bool         elm_web_uri_set(Evas_Object *obj, const char *uri);
 
@@ -585,7 +621,11 @@ EAPI void              elm_web_bg_color_get(const Evas_Object *obj, int *r, int
  * @return A newly allocated string, or NULL if nothing is selected or an
  * error occurred
  */
+<<<<<<< HEAD
+EAPI char             *elm_view_selection_get(const Evas_Object *obj);
+=======
 EAPI char             *elm_web_selection_get(const Evas_Object *obj);
+>>>>>>> remotes/origin/upstream
 
 /**
  * Tells the web object which index in the currently open popup was selected
@@ -667,7 +707,11 @@ EAPI Eina_Bool         elm_web_text_matches_highlight_set(Evas_Object *obj, Eina
 /**
  * Gets whether highlighting marks is enabled
  *
+<<<<<<< HEAD
+ * @param The web object
+=======
  * @param obj The web object
+>>>>>>> remotes/origin/upstream
  *
  * @return EINA_TRUE is marks are set to be highlighted, EINA_FALSE
  * otherwise
@@ -681,7 +725,11 @@ EAPI Eina_Bool         elm_web_text_matches_highlight_get(const Evas_Object *obj
  * 0.0 and 1.0. This is an estimated progress accounting for all the frames
  * included in the page.
  *
+<<<<<<< HEAD
+ * @param The web object
+=======
  * @param obj The web object
+>>>>>>> remotes/origin/upstream
  *
  * @return A value between 0.0 and 1.0 indicating the progress, or -1.0 on
  * failure
@@ -728,7 +776,11 @@ EAPI Eina_Bool         elm_web_reload_full(Evas_Object *obj);
  *
  * @return EINA_TRUE on success, EINA_FALSE otherwise
  *
+<<<<<<< HEAD
+ * @see elm_web_history_enable_set()
+=======
  * @see elm_web_history_enabled_set()
+>>>>>>> remotes/origin/upstream
  * @see elm_web_back_possible()
  * @see elm_web_forward()
  * @see elm_web_navigate()
@@ -744,8 +796,13 @@ EAPI Eina_Bool         elm_web_back(Evas_Object *obj);
  *
  * @return EINA_TRUE on success, EINA_FALSE otherwise
  *
+<<<<<<< HEAD
+ * @see elm_web_history_enable_set()
+ * @see elm_web_forward_possible()
+=======
  * @see elm_web_history_enabled_set()
  * @see elm_web_forward_possible_get()
+>>>>>>> remotes/origin/upstream
  * @see elm_web_back()
  * @see elm_web_navigate()
  */
@@ -763,8 +820,13 @@ EAPI Eina_Bool         elm_web_forward(Evas_Object *obj);
  * @return EINA_TRUE on success, EINA_FALSE on error or if not enough
  * history exists to jump the given number of steps
  *
+<<<<<<< HEAD
+ * @see elm_web_history_enable_set()
+ * @see elm_web_navigate_possible()
+=======
  * @see elm_web_history_enabled_set()
  * @see elm_web_navigate_possible_get()
+>>>>>>> remotes/origin/upstream
  * @see elm_web_back()
  * @see elm_web_forward()
  */
@@ -778,7 +840,11 @@ EAPI Eina_Bool         elm_web_navigate(Evas_Object *obj, int steps);
  * @return EINA_TRUE if it's possible to back in history, EINA_FALSE
  * otherwise
  */
+<<<<<<< HEAD
+EAPI Eina_Bool         elm_web_back_possible(Evas_Object *obj);
+=======
 EAPI Eina_Bool         elm_web_back_possible_get(Evas_Object *obj);
+>>>>>>> remotes/origin/upstream
 
 /**
  * Queries whether it's possible to go forward in history
@@ -788,7 +854,11 @@ EAPI Eina_Bool         elm_web_back_possible_get(Evas_Object *obj);
  * @return EINA_TRUE if it's possible to forward in history, EINA_FALSE
  * otherwise
  */
+<<<<<<< HEAD
+EAPI Eina_Bool         elm_web_forward_possible(Evas_Object *obj);
+=======
 EAPI Eina_Bool         elm_web_forward_possible_get(Evas_Object *obj);
+>>>>>>> remotes/origin/upstream
 
 /**
  * Queries whether it's possible to jump the given number of steps
@@ -802,7 +872,11 @@ EAPI Eina_Bool         elm_web_forward_possible_get(Evas_Object *obj);
  * @return EINA_TRUE if enough history exists to perform the given jump,
  * EINA_FALSE otherwise
  */
+<<<<<<< HEAD
+EAPI Eina_Bool         elm_web_navigate_possible(Evas_Object *obj, int steps);
+=======
 EAPI Eina_Bool         elm_web_navigate_possible_get(Evas_Object *obj, int steps);
+>>>>>>> remotes/origin/upstream
 
 /**
  * Gets whether browsing history is enabled for the given object
@@ -811,15 +885,25 @@ EAPI Eina_Bool         elm_web_navigate_possible_get(Evas_Object *obj, int steps
  *
  * @return EINA_TRUE if history is enabled, EINA_FALSE otherwise
  */
+<<<<<<< HEAD
+EAPI Eina_Bool         elm_web_history_enable_get(const Evas_Object *obj);
+=======
 EAPI Eina_Bool         elm_web_history_enabled_get(const Evas_Object *obj);
+>>>>>>> remotes/origin/upstream
 
 /**
  * Enables or disables the browsing history
  *
  * @param obj The web object
+<<<<<<< HEAD
+ * @param enable Whether to enable or disable the browsing history
+ */
+EAPI void              elm_web_history_enable_set(Evas_Object *obj, Eina_Bool enable);
+=======
  * @param enabled Whether to enable or disable the browsing history
  */
 EAPI void              elm_web_history_enabled_set(Evas_Object *obj, Eina_Bool enabled);
+>>>>>>> remotes/origin/upstream
 
 /**
  * Sets the zoom level of the web object
@@ -926,6 +1010,10 @@ EAPI Eina_Bool         elm_web_inwin_mode_get(const Evas_Object *obj);
 
 EAPI void              elm_web_window_features_ref(Elm_Web_Window_Features *wf);
 EAPI void              elm_web_window_features_unref(Elm_Web_Window_Features *wf);
+<<<<<<< HEAD
+EAPI void              elm_web_window_features_bool_property_get(const Elm_Web_Window_Features *wf, Eina_Bool *toolbar_visible, Eina_Bool *statusbar_visible, Eina_Bool *scrollbars_visible, Eina_Bool *menubar_visible, Eina_Bool *locationbar_visble, Eina_Bool *fullscreen);
+EAPI void              elm_web_window_features_int_property_get(const Elm_Web_Window_Features *wf, int *x, int *y, int *w, int *h);
+=======
 
 /**
  * Gets boolean properties from Elm_Web_Window_Features
@@ -947,6 +1035,7 @@ EAPI Eina_Bool              elm_web_window_features_property_get(const Elm_Web_W
  *
  */
 EAPI 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);
+>>>>>>> remotes/origin/upstream
 
 /**
  * @}