[genlist] apply r71140 with local enhancement

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

diff --git a/src/lib/elm_check.h b/src/lib/elm_check.h
index 9f51a56..7bdf13b 100644 (file)
--- a/src/lib/elm_check.h
+++ b/src/lib/elm_check.h
@@ -1,5 +1,6 @@
 /**
  * @defgroup Check Check
+ * @ingroup Elementary
  *
  * @image html img/widget/check/preview-00.png
  * @image latex img/widget/check/preview-00.eps
@@ -20,87 +21,43 @@
  * for it to modify.
  *
  * Signals that you can add callbacks for are:
- * "changed" - This is called whenever the user changes the state of one of
- *             the check object(event_info is NULL).
+ * "changed" - This is called whenever the user changes the state of the check
+ *             objects(event_info is NULL).
  *
- * Default contents parts of the check widget that you can use for are:
+ * Default content parts of the check widget that you can use for are:
  * @li "icon" - An icon of the check
  *
  * Default text parts of the check widget that you can use for are:
- * @li "elm.text" - Label of the check
+ * @li "default" - A label of the check
+ * @li "on" - On state label of the check
+ * @li "off" - Off state label of the check
+ *
+ * Supported elm_object common APIs.
+ * @li @ref elm_object_disabled_set
+ * @li @ref elm_object_disabled_get
+ * @li @ref elm_object_part_text_set
+ * @li @ref elm_object_part_text_get
+ * @li @ref elm_object_part_content_set
+ * @li @ref elm_object_part_content_get
+ * @li @ref elm_object_part_content_unset
+ * @li @ref elm_object_signal_emit
+ * @li @ref elm_object_signal_callback_add
+ * @li @ref elm_object_signal_callback_del
+ *
+ * @ref tutorial_check should give you a firm grasp of how to use this widget.
  *
- * @ref tutorial_check should give you a firm grasp of how to use this widget
- * .
  * @{
  */
+
 /**
  * @brief Add a new Check object
  *
  * @param parent The parent object
  * @return The new object or NULL if it cannot be created
- */
-EAPI Evas_Object *
-                                  elm_check_add(Evas_Object *parent)
-EINA_ARG_NONNULL(1);
-
-/**
- * @brief Set the text label of the check object
- *
- * @param obj The check object
- * @param label The text label string in UTF-8
- *
- * @deprecated use elm_object_text_set() instead.
- */
-EINA_DEPRECATED EAPI void         elm_check_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
-
-/**
- * @brief Get the text label of the check object
- *
- * @param obj The check object
- * @return The text label string in UTF-8
- *
- * @deprecated use elm_object_text_get() instead.
- */
-EINA_DEPRECATED EAPI const char  *elm_check_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
-
-/**
- * @brief Set the icon object of the check object
- *
- * @param obj The check object
- * @param icon The icon object
- *
- * 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_object_content_unset() function.
- *
- * @deprecated use elm_object_part_content_set() instead.
- *
- */
-EINA_DEPRECATED EAPI void         elm_check_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
-
-/**
- * @brief Get the icon object of the check object
- *
- * @param obj The check object
- * @return The icon object
- *
- * @deprecated use elm_object_part_content_get() instead.
  *
+ * @ingroup Check
  */
-EINA_DEPRECATED EAPI Evas_Object *elm_check_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
-
-/**
- * @brief Unset the icon used for the check object
- *
- * @param obj The check object
- * @return The icon object that was being used
- *
- * Unparent and return the icon object which was set for this widget.
- *
- * @deprecated use elm_object_part_content_unset() instead.
- *
- */
-EINA_DEPRECATED EAPI Evas_Object *elm_check_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
+EAPI Evas_Object *                elm_check_add(Evas_Object *parent);
 
 /**
  * @brief Set the on/off state of the check object
@@ -108,19 +65,23 @@ EINA_DEPRECATED EAPI Evas_Object *elm_check_icon_unset(Evas_Object *obj) EINA_AR
  * @param obj The check object
  * @param state The state to use (1 == on, 0 == off)
  *
- * This sets the state of the check. If set
- * with elm_check_state_pointer_set() the state of that variable is also
- * changed. Calling this @b doesn't cause the "changed" signal to be emited.
+ * This sets the state of the check. If set with elm_check_state_pointer_set()
+ * the state of that variable is also changed. Calling this @b doesn't cause
+ * the "changed" signal to be emitted.
+ *
+ * @ingroup Check
  */
-EAPI void                         elm_check_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
+EAPI void                         elm_check_state_set(Evas_Object *obj, Eina_Bool state);
 
 /**
  * @brief Get the state of the check object
  *
  * @param obj The check object
  * @return The boolean state
+ *
+ * @ingroup Check
  */
-EAPI Eina_Bool                    elm_check_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+EAPI Eina_Bool                    elm_check_state_get(const Evas_Object *obj);
 
 /**
  * @brief Set a convenience pointer to a boolean to change
@@ -134,10 +95,10 @@ EAPI Eina_Bool                    elm_check_state_get(const Evas_Object *obj) EI
  * then when this is called, the check objects state will also be modified to
  * reflect the value of the boolean @p statep points to, just like calling
  * elm_check_state_set().
+ *
+ * @ingroup Check
  */
-EAPI void                         elm_check_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
-EINA_DEPRECATED EAPI void         elm_check_states_labels_set(Evas_Object *obj, const char *ontext, const char *offtext) EINA_ARG_NONNULL(1, 2, 3);
-EINA_DEPRECATED EAPI void         elm_check_states_labels_get(const Evas_Object *obj, const char **ontext, const char **offtext) EINA_ARG_NONNULL(1, 2, 3);
+EAPI void                         elm_check_state_pointer_set(Evas_Object *obj, Eina_Bool *statep);
 
 /**
  * @}