summaryrefslogtreecommitdiff
path: root/legacy
diff options
context:
space:
mode:
authorBruno Dilly <bdilly@profusion.mobi>2011-10-24 23:41:56 +0000
committerBruno Dilly <bdilly@profusion.mobi>2011-10-24 23:41:56 +0000
commit842daf46ecb06b213126ee64a7a0b57b139214f9 (patch)
tree655e801cc157db3bbc06fbed78562b8b16c965aa /legacy
parenta63bf2c1c483c2c883b3c4612e18b119394e3bf7 (diff)
Elementary Toggle: Document functions to be used instead of deprecated
SVN revision: 64364
Diffstat (limited to 'legacy')
-rw-r--r--legacy/elementary/src/lib/Elementary.h.in24
1 files changed, 22 insertions, 2 deletions
diff --git a/legacy/elementary/src/lib/Elementary.h.in b/legacy/elementary/src/lib/Elementary.h.in
index 9a3ee7c64e..6ebb1165d7 100644
--- a/legacy/elementary/src/lib/Elementary.h.in
+++ b/legacy/elementary/src/lib/Elementary.h.in
@@ -7582,7 +7582,8 @@ extern "C" {
7582 * @code 7582 * @code
7583 * obj = elm_check_add(parent); 7583 * obj = elm_check_add(parent);
7584 * elm_object_style_set(obj, "toggle"); 7584 * elm_object_style_set(obj, "toggle");
7585 * elm_check_states_labels_set(obj, "ON", "OFF"); 7585 * elm_object_text_part_set(obj, "on", "ON");
7586 * elm_object_text_part_set(obj, "off", "OFF");
7586 * @endcode 7587 * @endcode
7587 * 7588 *
7588 * Signals that you can add callbacks for are: 7589 * Signals that you can add callbacks for are:
@@ -7628,6 +7629,8 @@ extern "C" {
7628 * Once the icon object is set, a previously set one will be deleted 7629 * Once the icon object is set, a previously set one will be deleted
7629 * If you want to keep that old content object, use the 7630 * If you want to keep that old content object, use the
7630 * elm_toggle_icon_unset() function. 7631 * elm_toggle_icon_unset() function.
7632 *
7633 * @deprecated use elm_check_icon_set() instead.
7631 */ 7634 */
7632 EINA_DEPRECATED EAPI void elm_toggle_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1); 7635 EINA_DEPRECATED EAPI void elm_toggle_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
7633 /** 7636 /**
@@ -7639,6 +7642,8 @@ extern "C" {
7639 * Return the icon object which is set for this widget. 7642 * Return the icon object which is set for this widget.
7640 * 7643 *
7641 * @see elm_toggle_icon_set() 7644 * @see elm_toggle_icon_set()
7645 *
7646 * @deprecated use elm_check_icon_get() instead.
7642 */ 7647 */
7643 EINA_DEPRECATED EAPI Evas_Object *elm_toggle_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1); 7648 EINA_DEPRECATED EAPI Evas_Object *elm_toggle_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7644 /** 7649 /**
@@ -7650,6 +7655,8 @@ extern "C" {
7650 * Unparent and return the icon object which was set for this widget. 7655 * Unparent and return the icon object which was set for this widget.
7651 * 7656 *
7652 * @see elm_toggle_icon_set() 7657 * @see elm_toggle_icon_set()
7658 *
7659 * @deprecated use elm_check_icon_unset() instead.
7653 */ 7660 */
7654 EINA_DEPRECATED EAPI Evas_Object *elm_toggle_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1); 7661 EINA_DEPRECATED EAPI Evas_Object *elm_toggle_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7655 /** 7662 /**
@@ -7658,14 +7665,21 @@ extern "C" {
7658 * @param obj The toggle object 7665 * @param obj The toggle object
7659 * @param onlabel The label displayed when the toggle is in the "on" state 7666 * @param onlabel The label displayed when the toggle is in the "on" state
7660 * @param offlabel The label displayed when the toggle is in the "off" state 7667 * @param offlabel The label displayed when the toggle is in the "off" state
7668 *
7669 * @deprecated use elm_object_text_part_set() for "on" and "off" parts
7670 * instead.
7661 */ 7671 */
7662 EINA_DEPRECATED EAPI void elm_toggle_states_labels_set(Evas_Object *obj, const char *onlabel, const char *offlabel) EINA_ARG_NONNULL(1); 7672 EINA_DEPRECATED EAPI void elm_toggle_states_labels_set(Evas_Object *obj, const char *onlabel, const char *offlabel) EINA_ARG_NONNULL(1);
7663 /** 7673 /**
7664 * @brief Gets the labels associated with the on and off states of the toggle. 7674 * @brief Gets the labels associated with the on and off states of the
7675 * toggle.
7665 * 7676 *
7666 * @param obj The toggle object 7677 * @param obj The toggle object
7667 * @param onlabel A char** to place the onlabel of @p obj into 7678 * @param onlabel A char** to place the onlabel of @p obj into
7668 * @param offlabel A char** to place the offlabel of @p obj into 7679 * @param offlabel A char** to place the offlabel of @p obj into
7680 *
7681 * @deprecated use elm_object_text_part_get() for "on" and "off" parts
7682 * instead.
7669 */ 7683 */
7670 EINA_DEPRECATED EAPI void elm_toggle_states_labels_get(const Evas_Object *obj, const char **onlabel, const char **offlabel) EINA_ARG_NONNULL(1); 7684 EINA_DEPRECATED EAPI void elm_toggle_states_labels_get(const Evas_Object *obj, const char **onlabel, const char **offlabel) EINA_ARG_NONNULL(1);
7671 /** 7685 /**
@@ -7673,6 +7687,8 @@ extern "C" {
7673 * 7687 *
7674 * @param obj The toggle object 7688 * @param obj The toggle object
7675 * @param state The state of @p obj 7689 * @param state The state of @p obj
7690 *
7691 * @deprecated use elm_check_state_set() instead.
7676 */ 7692 */
7677 EINA_DEPRECATED EAPI void elm_toggle_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1); 7693 EINA_DEPRECATED EAPI void elm_toggle_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
7678 /** 7694 /**
@@ -7680,6 +7696,8 @@ extern "C" {
7680 * 7696 *
7681 * @param obj The toggle object 7697 * @param obj The toggle object
7682 * @return The state of @p obj 7698 * @return The state of @p obj
7699 *
7700 * @deprecated use elm_check_state_get() instead.
7683 */ 7701 */
7684 EINA_DEPRECATED EAPI Eina_Bool elm_toggle_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1); 7702 EINA_DEPRECATED EAPI Eina_Bool elm_toggle_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7685 /** 7703 /**
@@ -7687,6 +7705,8 @@ extern "C" {
7687 * 7705 *
7688 * @param obj The toggle object 7706 * @param obj The toggle object
7689 * @param statep The state pointer of @p obj 7707 * @param statep The state pointer of @p obj
7708 *
7709 * @deprecated use elm_check_state_pointer_set() instead.
7690 */ 7710 */
7691 EINA_DEPRECATED EAPI void elm_toggle_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1); 7711 EINA_DEPRECATED EAPI void elm_toggle_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
7692 /** 7712 /**