fix bug hermet added in font code! :)

[framework/uifw/elementary.git] / src / lib / elm_actionslider.h

diff --git a/src/lib/elm_actionslider.h b/src/lib/elm_actionslider.h
index e1db17f..1be91fc 100644 (file)
--- a/src/lib/elm_actionslider.h
+++ b/src/lib/elm_actionslider.h
@@ -1,5 +1,6 @@
 /**
  * @addtogroup Actionslider Actionslider
+ * @ingroup Elementary
  *
  * @image html img/widget/actionslider/preview-00.png
  * @image latex img/widget/actionslider/preview-00.eps
@@ -22,16 +23,25 @@
  *
  * Signals that you can add callbacks for are:
  *
- * "selected" - when user selects an enabled position (the label is passed
- *              as event info)".
- * @n
+ * "selected" - when user selects an enabled position (the label is passed as
+ *              event info)".
  * "pos_changed" - when the indicator reaches any of the positions("left",
  *                 "right" or "center").
  *
+ * Default text parts of the actionslider widget that you can use for are:
+ * @li "indicator" - An indicator label of the actionslider
+ * @li "left" - A left label of the actionslider
+ * @li "right" - A right label of the actionslider
+ * @li "center" - A center label of the actionslider
+ *
+ * Supported elm_object common APIs.
+ * @li @ref elm_object_part_text_set
+ * @li @ref elm_object_part_text_get
+ *
  * See an example of actionslider usage @ref actionslider_example_page "here"
  * @{
  */
-typedef enum _Elm_Actionslider_Pos
+typedef enum
 {
    ELM_ACTIONSLIDER_NONE = 0,
    ELM_ACTIONSLIDER_LEFT = 1 << 0,
@@ -45,56 +55,40 @@ typedef enum _Elm_Actionslider_Pos
  *
  * @param parent The parent object
  * @return The new actionslider object or NULL if it cannot be created
- */
-EAPI Evas_Object *
-                                 elm_actionslider_add(Evas_Object *parent)
-EINA_ARG_NONNULL(1);
-
-/**
- * Set actionslider labels.
  *
- * @param obj The actionslider object
- * @param left_label The label to be set on the left.
- * @param center_label The label to be set on the center.
- * @param right_label The label to be set on the right.
- * @deprecated use elm_object_text_set() instead.
+ * @ingroup Actionslider
  */
-EINA_DEPRECATED EAPI void        elm_actionslider_labels_set(Evas_Object *obj, const char *left_label, const char *center_label, const char *right_label) EINA_ARG_NONNULL(1);
-
-/**
- * Get actionslider labels.
- *
- * @param obj The actionslider object
- * @param left_label A char** to place the left_label of @p obj into.
- * @param center_label A char** to place the center_label of @p obj into.
- * @param right_label A char** to place the right_label of @p obj into.
- * @deprecated use elm_object_text_set() instead.
- */
-EINA_DEPRECATED EAPI void        elm_actionslider_labels_get(const Evas_Object *obj, const char **left_label, const char **center_label, const char **right_label) EINA_ARG_NONNULL(1);
+EAPI Evas_Object                *elm_actionslider_add(Evas_Object *parent);
 
 /**
  * Get actionslider selected label.
  *
  * @param obj The actionslider object
  * @return The selected label
+ *
+ * @ingroup Actionslider
  */
-EAPI const char                 *elm_actionslider_selected_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+EAPI const char                 *elm_actionslider_selected_label_get(const Evas_Object *obj);
 
 /**
  * Set actionslider indicator position.
  *
  * @param obj The actionslider object.
  * @param pos The position of the indicator.
+ *
+ * @ingroup Actionslider
  */
-EAPI void                        elm_actionslider_indicator_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
+EAPI void                        elm_actionslider_indicator_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos);
 
 /**
  * Get actionslider indicator position.
  *
  * @param obj The actionslider object.
  * @return The position of the indicator.
+ *
+ * @ingroup Actionslider
  */
-EAPI Elm_Actionslider_Pos        elm_actionslider_indicator_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+EAPI Elm_Actionslider_Pos        elm_actionslider_indicator_pos_get(const Evas_Object *obj);
 
 /**
  * Set actionslider magnet position. To make multiple positions magnets @c or
@@ -102,16 +96,20 @@ EAPI Elm_Actionslider_Pos        elm_actionslider_indicator_pos_get(const Evas_O
  *
  * @param obj The actionslider object.
  * @param pos Bit mask indicating the magnet positions.
+ *
+ * @ingroup Actionslider
  */
-EAPI void                        elm_actionslider_magnet_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
+EAPI void                        elm_actionslider_magnet_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos);
 
 /**
  * Get actionslider magnet position.
  *
  * @param obj The actionslider object.
  * @return The positions with magnet property.
+ *
+ * @ingroup Actionslider
  */
-EAPI Elm_Actionslider_Pos        elm_actionslider_magnet_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+EAPI Elm_Actionslider_Pos        elm_actionslider_magnet_pos_get(const Evas_Object *obj);
 
 /**
  * Set actionslider enabled position. To set multiple positions as enabled @c or
@@ -121,34 +119,20 @@ EAPI Elm_Actionslider_Pos        elm_actionslider_magnet_pos_get(const Evas_Obje
  *
  * @param obj The actionslider object.
  * @param pos Bit mask indicating the enabled positions.
+ *
+ * @ingroup Actionslider
  */
-EAPI void                        elm_actionslider_enabled_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
+EAPI void                        elm_actionslider_enabled_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos);
 
 /**
  * Get actionslider enabled position.
  *
  * @param obj The actionslider object.
  * @return The enabled positions.
- */
-EAPI Elm_Actionslider_Pos        elm_actionslider_enabled_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
-
-/**
- * Set the label used on the indicator.
  *
- * @param obj The actionslider object
- * @param label The label to be set on the indicator.
- * @deprecated use elm_object_text_set() instead.
- */
-EINA_DEPRECATED EAPI void        elm_actionslider_indicator_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
-
-/**
- * Get the label used on the indicator object.
- *
- * @param obj The actionslider object
- * @return The indicator label
- * @deprecated use elm_object_text_get() instead.
+ * @ingroup Actionslider
  */
-EINA_DEPRECATED EAPI const char *elm_actionslider_indicator_label_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
+EAPI Elm_Actionslider_Pos        elm_actionslider_enabled_pos_get(const Evas_Object *obj);
 
 /**
  * @}