fix bug hermet added in font code! :)
[framework/uifw/elementary.git] / src / lib / elm_actionslider.h
index d218a65..1be91fc 100644 (file)
@@ -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
  *
  * 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"
  * @{
  */
@@ -45,32 +55,40 @@ typedef enum
  *
  * @param parent The parent object
  * @return The new actionslider object or NULL if it cannot be created
+ *
+ * @ingroup Actionslider
  */
-EAPI Evas_Object                *elm_actionslider_add(Evas_Object *parent) 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
@@ -78,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
@@ -97,16 +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.
+ *
+ * @ingroup Actionslider
  */
-EAPI Elm_Actionslider_Pos        elm_actionslider_enabled_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+EAPI Elm_Actionslider_Pos        elm_actionslider_enabled_pos_get(const Evas_Object *obj);
 
 /**
  * @}