From 6fd44042d00979ea8cdf52744af2640307d1432b Mon Sep 17 00:00:00 2001 From: Jiyoun Park Date: Fri, 16 Mar 2012 05:48:18 +0000 Subject: [PATCH] update info SVN revision: 69448 --- legacy/elementary/src/lib/elm_deprecated.h | 157 -------------------- legacy/elementary/src/lib/elm_removed.h | 158 +++++++++++++++++++++ 2 files changed, 158 insertions(+), 157 deletions(-) diff --git a/legacy/elementary/src/lib/elm_deprecated.h b/legacy/elementary/src/lib/elm_deprecated.h index fc0d4ac5fb..77dde9c413 100644 --- a/legacy/elementary/src/lib/elm_deprecated.h +++ b/legacy/elementary/src/lib/elm_deprecated.h @@ -1,160 +1,3 @@ -/** - * @image html img/widget/toggle/preview-00.png - * @image latex img/widget/toggle/preview-00.eps - * - * @brief A toggle is a slider which can be used to toggle between - * two values. It has two states: on and off. - * - * This widget is deprecated. Please use elm_check_add() instead using the - * toggle style like: - * - * @code - * obj = elm_check_add(parent); - * elm_object_style_set(obj, "toggle"); - * elm_object_part_text_set(obj, "on", "ON"); - * elm_object_part_text_set(obj, "off", "OFF"); - * @endcode - * - * Signals that you can add callbacks for are: - * @li "changed" - Whenever the toggle value has been changed. Is not called - * until the toggle is released by the cursor (assuming it - * has been triggered by the cursor in the first place). - * - * Default content parts of the toggle widget that you can use for are: - * @li "icon" - An icon of the toggle - * - * Default text parts of the toggle widget that you can use for are: - * @li "elm.text" - Label of the toggle - * - * @ref tutorial_toggle show how to use a toggle. - * @{ - */ - -/** - * @brief Add a toggle to @p parent. - * - * @param parent The parent object - * - * @return The toggle object - */ -EINA_DEPRECATED EAPI Evas_Object *elm_toggle_add(Evas_Object *parent); - -/** - * @brief Sets the label to be displayed with the toggle. - * - * @param obj The toggle object - * @param label The label to be displayed - * - * @deprecated use elm_object_text_set() instead. - */ -EINA_DEPRECATED EAPI void elm_toggle_label_set(Evas_Object *obj, const char *label); - -/** - * @brief Gets the label of the toggle - * - * @param obj toggle object - * @return The label of the toggle - * - * @deprecated use elm_object_text_get() instead. - */ -EINA_DEPRECATED EAPI const char *elm_toggle_label_get(const Evas_Object *obj); - -/** - * @brief Set the icon used for the toggle - * - * @param obj The toggle object - * @param icon The icon object for the button - * - * 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_toggle_icon_unset() function. - * - * @deprecated use elm_object_part_content_set() instead. - */ -EINA_DEPRECATED EAPI void elm_toggle_icon_set(Evas_Object *obj, Evas_Object *icon); - -/** - * @brief Get the icon used for the toggle - * - * @param obj The toggle object - * @return The icon object that is being used - * - * Return the icon object which is set for this widget. - * - * @deprecated use elm_object_part_content_get() instead. - */ -EINA_DEPRECATED EAPI Evas_Object *elm_toggle_icon_get(const Evas_Object *obj); - -/** - * @brief Unset the icon used for the toggle - * - * @param obj The toggle 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_toggle_icon_unset(Evas_Object *obj); - -/** - * @brief Sets the labels to be associated with the on and off states of the toggle. - * - * @param obj The toggle object - * @param onlabel The label displayed when the toggle is in the "on" state - * @param offlabel The label displayed when the toggle is in the "off" state - * - * @deprecated use elm_object_part_text_set() for "on" and "off" parts - * instead. - */ -EINA_DEPRECATED EAPI void elm_toggle_states_labels_set(Evas_Object *obj, const char *onlabel, const char *offlabel); - -/** - * @brief Gets the labels associated with the on and off states of the - * toggle. - * - * @param obj The toggle object - * @param onlabel A char** to place the onlabel of @p obj into - * @param offlabel A char** to place the offlabel of @p obj into - * - * @deprecated use elm_object_part_text_get() for "on" and "off" parts - * instead. - */ -EINA_DEPRECATED EAPI void elm_toggle_states_labels_get(const Evas_Object *obj, const char **onlabel, const char **offlabel); - -/** - * @brief Sets the state of the toggle to @p state. - * - * @param obj The toggle object - * @param state The state of @p obj - * - * @deprecated use elm_check_state_set() instead. - */ -EINA_DEPRECATED EAPI void elm_toggle_state_set(Evas_Object *obj, Eina_Bool state); - -/** - * @brief Gets the state of the toggle to @p state. - * - * @param obj The toggle object - * @return The state of @p obj - * - * @deprecated use elm_check_state_get() instead. - */ -EINA_DEPRECATED EAPI Eina_Bool elm_toggle_state_get(const Evas_Object *obj); - -/** - * @brief Sets the state pointer of the toggle to @p statep. - * - * @param obj The toggle object - * @param statep The state pointer of @p obj - * - * @deprecated use elm_check_state_pointer_set() instead. - */ -EINA_DEPRECATED EAPI void elm_toggle_state_pointer_set(Evas_Object *obj, Eina_Bool *statep); - -/** - * @} - */ EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_add(Evas_Object *parent); EINA_DEPRECATED EAPI void elm_scrolled_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line); diff --git a/legacy/elementary/src/lib/elm_removed.h b/legacy/elementary/src/lib/elm_removed.h index 353bca963b..cc39ad9fb6 100644 --- a/legacy/elementary/src/lib/elm_removed.h +++ b/legacy/elementary/src/lib/elm_removed.h @@ -11,6 +11,164 @@ #error "do not include this" +/** + * @image html img/widget/toggle/preview-00.png + * @image latex img/widget/toggle/preview-00.eps + * + * @brief A toggle is a slider which can be used to toggle between + * two values. It has two states: on and off. + * + * This widget is deprecated. Please use elm_check_add() instead using the + * toggle style like: + * + * @code + * obj = elm_check_add(parent); + * elm_object_style_set(obj, "toggle"); + * elm_object_part_text_set(obj, "on", "ON"); + * elm_object_part_text_set(obj, "off", "OFF"); + * @endcode + * + * Signals that you can add callbacks for are: + * @li "changed" - Whenever the toggle value has been changed. Is not called + * until the toggle is released by the cursor (assuming it + * has been triggered by the cursor in the first place). + * + * Default content parts of the toggle widget that you can use for are: + * @li "icon" - An icon of the toggle + * + * Default text parts of the toggle widget that you can use for are: + * @li "elm.text" - Label of the toggle + * + * @ref tutorial_toggle show how to use a toggle. + * @{ + */ + +/** + * @brief Add a toggle to @p parent. + * + * @param parent The parent object + * + * @return The toggle object + */ +EINA_DEPRECATED EAPI Evas_Object *elm_toggle_add(Evas_Object *parent); + +/** + * @brief Sets the label to be displayed with the toggle. + * + * @param obj The toggle object + * @param label The label to be displayed + * + * @deprecated use elm_object_text_set() instead. + */ +EINA_DEPRECATED EAPI void elm_toggle_label_set(Evas_Object *obj, const char *label); + +/** + * @brief Gets the label of the toggle + * + * @param obj toggle object + * @return The label of the toggle + * + * @deprecated use elm_object_text_get() instead. + */ +EINA_DEPRECATED EAPI const char *elm_toggle_label_get(const Evas_Object *obj); + +/** + * @brief Set the icon used for the toggle + * + * @param obj The toggle object + * @param icon The icon object for the button + * + * 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_toggle_icon_unset() function. + * + * @deprecated use elm_object_part_content_set() instead. + */ +EINA_DEPRECATED EAPI void elm_toggle_icon_set(Evas_Object *obj, Evas_Object *icon); + +/** + * @brief Get the icon used for the toggle + * + * @param obj The toggle object + * @return The icon object that is being used + * + * Return the icon object which is set for this widget. + * + * @deprecated use elm_object_part_content_get() instead. + */ +EINA_DEPRECATED EAPI Evas_Object *elm_toggle_icon_get(const Evas_Object *obj); + +/** + * @brief Unset the icon used for the toggle + * + * @param obj The toggle 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_toggle_icon_unset(Evas_Object *obj); + +/** + * @brief Sets the labels to be associated with the on and off states of the toggle. + * + * @param obj The toggle object + * @param onlabel The label displayed when the toggle is in the "on" state + * @param offlabel The label displayed when the toggle is in the "off" state + * + * @deprecated use elm_object_part_text_set() for "on" and "off" parts + * instead. + */ +EINA_DEPRECATED EAPI void elm_toggle_states_labels_set(Evas_Object *obj, const char *onlabel, const char *offlabel); + +/** + * @brief Gets the labels associated with the on and off states of the + * toggle. + * + * @param obj The toggle object + * @param onlabel A char** to place the onlabel of @p obj into + * @param offlabel A char** to place the offlabel of @p obj into + * + * @deprecated use elm_object_part_text_get() for "on" and "off" parts + * instead. + */ +EINA_DEPRECATED EAPI void elm_toggle_states_labels_get(const Evas_Object *obj, const char **onlabel, const char **offlabel); + +/** + * @brief Sets the state of the toggle to @p state. + * + * @param obj The toggle object + * @param state The state of @p obj + * + * @deprecated use elm_check_state_set() instead. + */ +EINA_DEPRECATED EAPI void elm_toggle_state_set(Evas_Object *obj, Eina_Bool state); + +/** + * @brief Gets the state of the toggle to @p state. + * + * @param obj The toggle object + * @return The state of @p obj + * + * @deprecated use elm_check_state_get() instead. + */ +EINA_DEPRECATED EAPI Eina_Bool elm_toggle_state_get(const Evas_Object *obj); + +/** + * @brief Sets the state pointer of the toggle to @p statep. + * + * @param obj The toggle object + * @param statep The state pointer of @p obj + * + * @deprecated use elm_check_state_pointer_set() instead. + */ +EINA_DEPRECATED EAPI void elm_toggle_state_pointer_set(Evas_Object *obj, Eina_Bool *statep); + +/** + * @} + */ + /** * @brief Get Elementary's rendering engine in use. *