Fix conflicts: Map, Hover, Hoversel, Menu, Web
[framework/uifw/elementary.git] / src / lib / elc_hoversel.h
index eb99109..79f4db7 100644 (file)
@@ -16,7 +16,7 @@
  * "selected" - an item in the hoversel list is selected. event_info is the item
  * "dismissed" - the hover is dismissed
  *
- * Default contents parts of the hoversel widget that you can use for are:
+ * Default content parts of the hoversel widget that you can use for are:
  * @li "icon" - An icon of the hoversel
  *
  * Default text parts of the hoversel widget that you can use for are:
  *
  * Supported elm_object common APIs.
  * @li elm_object_disabled_set
- * @li elm_object_text_set
+ * @li elm_object_disabled_get
  * @li elm_object_part_text_set
- * @li elm_object_text_get
  * @li elm_object_part_text_get
- * @li elm_object_content_set
  * @li elm_object_part_content_set
- * @li elm_object_content_unset
  * @li elm_object_part_content_unset
  *
  * Supported elm_object_item common APIs.
- * @li elm_object_item_text_get
  * @li elm_object_item_part_text_get
  *
  * See @ref tutorial_hoversel for an example.
@@ -47,9 +43,7 @@
  * @param parent The parent object
  * @return The new object or NULL if it cannot be created
  */
-EAPI Evas_Object *
-                                  elm_hoversel_add(Evas_Object *parent)
-EINA_ARG_NONNULL(1);
+EAPI Evas_Object                 *elm_hoversel_add(Evas_Object *parent);
 
 /**
  * @brief This sets the hoversel to expand horizontally.
@@ -61,7 +55,7 @@ EINA_ARG_NONNULL(1);
  * @note The initial button will display horizontally regardless of this
  * setting.
  */
-EAPI void                         elm_hoversel_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
+EAPI void                         elm_hoversel_horizontal_set(Evas_Object *obj, Eina_Bool horizontal);
 
 /**
  * @brief This returns whether the hoversel is set to expand horizontally.
@@ -71,7 +65,7 @@ EAPI void                         elm_hoversel_horizontal_set(Evas_Object *obj,
  *
  * @see elm_hoversel_horizontal_set()
  */
-EAPI Eina_Bool                    elm_hoversel_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+EAPI Eina_Bool                    elm_hoversel_horizontal_get(const Evas_Object *obj);
 
 /**
  * @brief Set the Hover parent
@@ -83,7 +77,8 @@ EAPI Eina_Bool                    elm_hoversel_horizontal_get(const Evas_Object
  * hoversel is clicked. Should probably be the window that the hoversel is
  * in. See @ref Hover objects for more information.
  */
-EAPI void                         elm_hoversel_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
+EAPI void                         elm_hoversel_hover_parent_set(Evas_Object *obj, Evas_Object *parent);
+
 /**
  * @brief Get the Hover parent
  *
@@ -94,75 +89,7 @@ EAPI void                         elm_hoversel_hover_parent_set(Evas_Object *obj
  *
  * @see elm_hoversel_hover_parent_set()
  */
-EAPI Evas_Object                 *elm_hoversel_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
-
-/**
- * @brief Set the hoversel button label
- *
- * @param obj The hoversel object
- * @param label The label text.
- *
- * This sets the label of the button that is always visible (before it is
- * clicked and expanded).
- *
- * @deprecated elm_object_text_set()
- */
-EINA_DEPRECATED EAPI void         elm_hoversel_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
-
-/**
- * @brief Get the hoversel button label
- *
- * @param obj The hoversel object
- * @return The label text.
- *
- * @deprecated elm_object_text_get()
- */
-EINA_DEPRECATED EAPI const char  *elm_hoversel_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
-
-/**
- * @brief Set the icon of the hoversel button
- *
- * @param obj The hoversel object
- * @param icon The icon object
- *
- * Sets the icon of the button that is always visible (before it is clicked
- * and expanded).  Once the icon object is set, a previously set one will be
- * deleted, if you want to keep that old content object, use the
- * elm_hoversel_icon_unset() function.
- *
- * @see elm_object_content_set() for the button widget
- * @deprecated Use elm_object_item_part_content_set() instead
- */
-EINA_DEPRECATED EAPI void         elm_hoversel_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
-
-/**
- * @brief Get the icon of the hoversel button
- *
- * @param obj The hoversel object
- * @return The icon object
- *
- * Get the icon of the button that is always visible (before it is clicked
- * and expanded). Also see elm_object_content_get() for the button widget.
- *
- * @see elm_hoversel_icon_set()
- * @deprecated Use elm_object_item_part_content_get() instead
- */
-EINA_DEPRECATED EAPI Evas_Object *elm_hoversel_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
-
-/**
- * @brief Get and unparent the icon of the hoversel button
- *
- * @param obj The hoversel object
- * @return The icon object that was being used
- *
- * Unparent and return the icon of the button that is always visible
- * (before it is clicked and expanded).
- *
- * @see elm_hoversel_icon_set()
- * @see elm_object_content_unset() for the button widget
- * @deprecated Use elm_object_item_part_content_unset() instead
- */
-EINA_DEPRECATED EAPI Evas_Object *elm_hoversel_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
+EAPI Evas_Object                 *elm_hoversel_hover_parent_get(const Evas_Object *obj);
 
 /**
  * @brief This triggers the hoversel popup from code, the same as if the user
@@ -170,7 +97,7 @@ EINA_DEPRECATED EAPI Evas_Object *elm_hoversel_icon_unset(Evas_Object *obj) EINA
  *
  * @param obj The hoversel object
  */
-EAPI void                         elm_hoversel_hover_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
+EAPI void                         elm_hoversel_hover_begin(Evas_Object *obj);
 
 /**
  * @brief This dismisses the hoversel popup as if the user had clicked
@@ -178,7 +105,7 @@ EAPI void                         elm_hoversel_hover_begin(Evas_Object *obj) EIN
  *
  * @param obj The hoversel object
  */
-EAPI void                         elm_hoversel_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
+EAPI void                         elm_hoversel_hover_end(Evas_Object *obj);
 
 /**
  * @brief Returns whether the hoversel is expanded.
@@ -187,7 +114,7 @@ EAPI void                         elm_hoversel_hover_end(Evas_Object *obj) EINA_
  * @return  This will return EINA_TRUE if the hoversel is expanded or
  * EINA_FALSE if it is not expanded.
  */
-EAPI Eina_Bool                    elm_hoversel_expanded_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+EAPI Eina_Bool                    elm_hoversel_expanded_get(const Evas_Object *obj);
 
 /**
  * @brief This will remove all the children items from the hoversel.
@@ -197,10 +124,9 @@ EAPI Eina_Bool                    elm_hoversel_expanded_get(const Evas_Object *o
  * @warning Should @b not be called while the hoversel is active; use
  * elm_hoversel_expanded_get() to check first.
  *
- * @see elm_hoversel_item_del_cb_set()
- * @see elm_hoversel_item_del()
+ * @see elm_object_item_del()
  */
-EAPI void                         elm_hoversel_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
+EAPI void                         elm_hoversel_clear(Evas_Object *obj);
 
 /**
  * @brief Get the list of items within the given hoversel.
@@ -210,7 +136,7 @@ EAPI void                         elm_hoversel_clear(Evas_Object *obj) EINA_ARG_
  *
  * @see elm_hoversel_item_add()
  */
-EAPI const Eina_List             *elm_hoversel_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+EAPI const Eina_List             *elm_hoversel_items_get(const Evas_Object *obj);
 
 /**
  * @brief Add an item to the hoversel button
@@ -226,65 +152,13 @@ EAPI const Eina_List             *elm_hoversel_items_get(const Evas_Object *obj)
  *
  * This adds an item to the hoversel to show when it is clicked. Note: if you
  * need to use an icon from an edje file then use
- * elm_hoversel_item_icon_set() right after the this function, and set
+ * elm_hoversel_item_icon_set() right after this function, and set
  * icon_file to NULL here.
  *
- * For more information on what @p icon_file and @p icon_type are see the
+ * For more information on what @p icon_file and @p icon_type are, see the
  * @ref Icon "icon documentation".
  */
-EAPI Elm_Object_Item             *elm_hoversel_item_add(Evas_Object *obj, const char *label, const char *icon_file, Elm_Icon_Type icon_type, Evas_Smart_Cb func, const void *data) EINA_ARG_NONNULL(1);
-
-/**
- * @brief Delete an item from the hoversel
- *
- * @param it The item to delete
- *
- * This deletes the item from the hoversel (should not be called while the
- * hoversel is active; use elm_hoversel_expanded_get() to check first).
- *
- * @see elm_hoversel_item_add()
- * @see elm_hoversel_item_del_cb_set()
- */
-EAPI void                         elm_hoversel_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
-
-/**
- * @brief Set the function to be called when an item from the hoversel is
- * freed.
- *
- * @param it The item to set the callback on
- * @param func The function called
- *
- * That function will receive these parameters:
- * @li void * item data
- * @li Evas_Object * hoversel object
- * @li Elm_Object_Item * hoversel item
- *
- * @see elm_hoversel_item_add()
- */
-EAPI void                         elm_hoversel_item_del_cb_set(Elm_Object_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
-
-/**
- * @brief This returns the data pointer supplied with elm_hoversel_item_add()
- * that will be passed to associated function callbacks.
- *
- * @param it The item to get the data from
- * @return The data pointer set with elm_hoversel_item_add()
- *
- * @see elm_hoversel_item_add()
- * @deprecated Use elm_object_item_data_get() instead
- */
-EINA_DEPRECATED EAPI void        *elm_hoversel_item_data_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
-
-/**
- * @brief This returns the label text of the given hoversel item.
- *
- * @param it The item to get the label
- * @return The label text of the hoversel item
- *
- * @see elm_hoversel_item_add()
- * @deprecated Use elm_object_item_text_get() instead
- */
-EINA_DEPRECATED EAPI const char  *elm_hoversel_item_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
+EAPI Elm_Object_Item             *elm_hoversel_item_add(Evas_Object *obj, const char *label, const char *icon_file, Elm_Icon_Type icon_type, Evas_Smart_Cb func, const void *data);
 
 /**
  * @brief This sets the icon for the given hoversel item.
@@ -301,7 +175,7 @@ EINA_DEPRECATED EAPI const char  *elm_hoversel_item_label_get(const Elm_Object_I
  *
  * @see elm_hoversel_item_add()
  */
-EAPI void                         elm_hoversel_item_icon_set(Elm_Object_Item *it, const char *icon_file, const char *icon_group, Elm_Icon_Type icon_type) EINA_ARG_NONNULL(1);
+EAPI void                         elm_hoversel_item_icon_set(Elm_Object_Item *it, const char *icon_file, const char *icon_group, Elm_Icon_Type icon_type);
 
 /**
  * @brief Get the icon object of the hoversel item
@@ -316,7 +190,7 @@ EAPI void                         elm_hoversel_item_icon_set(Elm_Object_Item *it
  * @see elm_hoversel_item_icon_set()
  * @see elm_hoversel_item_add()
  */
-EAPI void                         elm_hoversel_item_icon_get(const Elm_Object_Item *it, const char **icon_file, const char **icon_group, Elm_Icon_Type *icon_type) EINA_ARG_NONNULL(1);
+EAPI void                         elm_hoversel_item_icon_get(const Elm_Object_Item *it, const char **icon_file, const char **icon_group, Elm_Icon_Type *icon_type);
 
 /**
  * @}