elementary - updated doc. will keep going for other widgets later.
authorChunEon Park <hermet@hermet.pe.kr>
Mon, 2 Jan 2012 12:53:29 +0000 (12:53 +0000)
committerChunEon Park <hermet@hermet.pe.kr>
Mon, 2 Jan 2012 12:53:29 +0000 (12:53 +0000)
or someone please help me ;0

SVN revision: 66752

15 files changed:
src/lib/elc_anchorblock.h
src/lib/elc_ctxpopup.h
src/lib/elc_fileselector_button.h
src/lib/elc_fileselector_entry.h
src/lib/elc_hoversel.h
src/lib/elc_multibuttonentry.h
src/lib/elm_actionslider.c
src/lib/elm_actionslider.h
src/lib/elm_bg.h
src/lib/elm_bubble.h
src/lib/elm_button.h
src/lib/elm_calendar.h
src/lib/elm_check.h
src/lib/elm_clock.h
src/lib/elm_object_item.h

index 7c16ab8..6d24699 100644 (file)
  * @see Entry
  * @see Hover
  *
+ * Default text parts of the anchorblock widget that you can use for are:
+ * @li "default" - A label of the anchorblock
+ *
+ * Supported elm_object common APIs.
+ * @li elm_object_part_text_set
+ * @li elm_object_part_text_get
+ *
  * Since examples are usually better than plain words, we might as well
  * try @ref tutorial_anchorblock_example "one".
  */
index 8ae797f..09e6b5e 100644 (file)
  * Default text parts of the ctxpopup items that you can use for are:
  * @li "default" - Title label in the title area
  *
+ * Supported elm_object common APIs.
+ * @li elm_object_part_content_set
+ * @li elm_object_part_content_get
+ * @li elm_object_part_content_unset
+ *
+ * Supported elm_object_item common APIs.
+ * @li elm_object_item_disabled_set
+ * @li elm_object_item_disabled_get
+ * @li elm_object_item_part_text_set
+ * @li elm_object_item_part_text_get
+ * @li elm_object_item_part_content_set
+ * @li elm_object_item_part_content_get
+ * @li elm_object_item_signal_emit
+ *
  * @ref tutorial_ctxpopup shows the usage of a good deal of the API.
  * @{
  */
index 7bba097..99442d6 100644 (file)
  *   pointer comes as the @c event_info data (a stringshared
  *   string)
  *
+ * Default text parts of the fileselector_button widget that you can use for
+ * are:
+ * @li "default" - Label of the fileselector_button
+ *
+ * Supported elm_object common APIs.
+ * @li elm_object_part_text_set
+ * @li elm_object_part_text_get
+ * @li elm_object_disabled_set
+ * @li elm_object_disabled_get
+ *
  * Here is an example on its usage:
  * @li @ref fileselector_button_example
  *
index 681a65a..45b07c8 100644 (file)
  *   selector entry's internal file selector, whose string pointer
  *   comes as the @c event_info data (a stringshared string)
  *
+ * Default text parts of the fileselector_button widget that you can use for
+ * are:
+ * @li "default" - Label of the fileselector_button
+ *
+ * Supported elm_object common APIs.
+ * @li elm_object_part_text_set
+ * @li elm_object_part_text_get
+ * @li elm_object_disabled_set
+ * @li elm_object_disabled_get
+ *
  * Here is an example on its usage:
  * @li @ref fileselector_entry_example
  *
index 63dab9f..6d708b0 100644 (file)
  *
  * Supported elm_object common APIs.
  * @li elm_object_disabled_set
- * @li elm_object_text_set
+ * @li elm_object_disabled_get
  * @li elm_object_part_text_set
- * @li elm_object_text_get
  * @li elm_object_part_text_get
- * @li elm_object_content_set
  * @li elm_object_part_content_set
- * @li elm_object_content_unset
  * @li elm_object_part_content_unset
  *
  * Supported elm_object_item common APIs.
- * @li elm_object_item_text_get
  * @li elm_object_item_part_text_get
  *
  * See @ref tutorial_hoversel for an example.
index 5541d47..c9e5415 100644 (file)
  * Default text parts of the multibuttonentry items that you can use for are:
  * @li "default" - A label of the multibuttonentry item
  *
+ * Supported elm_object common APIs.
+ * @li elm_object_signal_emit
+ * @li elm_object_part_text_set
+ * @li elm_object_part_text_get
+ *
+ * Supported elm_object_item common APIs.
+ * @li elm_object_item_part_text_set
+ * @li elm_object_item_part_text_get
+ *
  */
 
 /**
index 8bdadac..a707461 100644 (file)
@@ -323,7 +323,7 @@ _elm_actionslider_label_set(Evas_Object *obj, const char *item, const char *labe
    Widget_Data *wd = elm_widget_data_get(obj);
    if (!wd) return;
 
-   if (!item || !strcmp(item, "default"))
+   if (!item || !strcmp(item, "indicator"))
      {
         eina_stringshare_replace(&wd->indicator_label, label);
         edje_object_part_text_set(wd->as, "elm.text.indicator",
@@ -333,13 +333,9 @@ _elm_actionslider_label_set(Evas_Object *obj, const char *item, const char *labe
      {
         eina_stringshare_replace(&wd->text_left, label);
         if (!elm_widget_mirrored_get(obj))
-          {
-             edje_object_part_text_set(wd->as, "elm.text.left", wd->text_left);
-          }
+          edje_object_part_text_set(wd->as, "elm.text.left", wd->text_left);
         else
-          {
-             edje_object_part_text_set(wd->as, "elm.text.right", wd->text_left);
-          }
+          edje_object_part_text_set(wd->as, "elm.text.right", wd->text_left);
      }
    else if (!strcmp(item, "center"))
      {
@@ -350,13 +346,9 @@ _elm_actionslider_label_set(Evas_Object *obj, const char *item, const char *labe
      {
         eina_stringshare_replace(&wd->text_right, label);
         if (!elm_widget_mirrored_get(obj))
-          {
-             edje_object_part_text_set(wd->as, "elm.text.right", wd->text_right);
-          }
+          edje_object_part_text_set(wd->as, "elm.text.right", wd->text_right);
         else
-          {
-             edje_object_part_text_set(wd->as, "elm.text.left", wd->text_right);
-          }
+          edje_object_part_text_set(wd->as, "elm.text.left", wd->text_right);
      }
 }
 
@@ -367,22 +359,14 @@ _elm_actionslider_label_get(const Evas_Object *obj, const char *item)
    Widget_Data *wd = elm_widget_data_get(obj);
    if (!wd) return NULL;
 
-   if (!item || !strcmp(item, "default"))
-     {
-        return wd->indicator_label;
-     }
+   if (!item || !strcmp(item, "indicator"))
+     return wd->indicator_label;
    else if (!strcmp(item, "left"))
-     {
-        return wd->text_left;
-     }
+     return wd->text_left;
    else if (!strcmp(item, "center"))
-     {
-        return wd->text_center;
-     }
+     return wd->text_center;
    else if (!strcmp(item, "right"))
-     {
-        return wd->text_right;
-     }
+     return wd->text_right;
 
    return NULL;
 }
index 33110c9..3a9395b 100644 (file)
  *
  * 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" - A 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 elm_object_part_text_set
+ * @li elm_object_part_text_get
+ * 
  * See an example of actionslider usage @ref actionslider_example_page "here"
  * @{
  */
index 2137a92..e3c6ea5 100644 (file)
  * Default contents parts of the bg widget that you can use for are:
  * @li "overlay" - overlay of the bg
  *
+ * Supported elm_object common APIs.
+ * @li elm_object_part_content_set
+ * @li elm_object_part_content_get
+ * @li elm_object_part_content_unset
+ *
  * Here is some sample code using it:
  * @li @ref bg_01_example_page
  * @li @ref bg_02_example_page
index 8776913..533a521 100644 (file)
  * @li "icon" - An icon of the bubble
  *
  * Default text parts of the button widget that you can use for are:
- * @li NULL - Label of the bubble
+ * @li "default" - Label of the bubble
+ * @li "info" - info of the bubble
+ *
+ * Supported elm_object common APIs.
+ * @li elm_object_part_text_set
+ * @li elm_object_part_text_get
+ * @li elm_object_part_content_set
+ * @li elm_object_part_content_get
+ * @li elm_object_part_content_unset
  *
  * For an example of using a buble see @ref bubble_01_example_page "this".
  *
index 3a1cec2..b711f18 100644 (file)
  * Default text parts of the button widget that you can use for are:
  * @li "default" - Label of the button
  *
+ * Supported elm_object common APIs.
+ * @li elm_object_part_text_set
+ * @li elm_object_part_text_get
+ * @li elm_object_part_content_set
+ * @li elm_object_part_content_get
+ * @li elm_object_part_content_unset
+ * @li elm_object_signal_emit
+ * @li elm_object_signal_callback_add
+ * @li elm_object_signal_callback_del
+ * 
  * Follow through a complete example @ref button_example_01 "here".
  * @{
  */
index c83c188..c62d22e 100644 (file)
  *
  * Values don't work as bitmask, only one can be choosen.
  *
+ * Supported elm_object common APIs.
+ * @li elm_object_signal_emit
+ * @li elm_object_signal_callback_add
+ * @li elm_object_signal_callback_del
+ *
  * @see elm_calendar_mark_add()
  *
  * @ingroup Calendar
index 483ecd8..8073615 100644 (file)
  * @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 elm_object_disabled_set
+ * @li elm_object_disabled_get
+ * @li elm_object_part_text_set
+ * @li elm_object_part_text_get
+ * @li elm_object_part_content_set
+ * @li elm_object_part_content_get
+ * @li elm_object_part_content_unset
  *
  * @ref tutorial_check should give you a firm grasp of how to use this widget.
  * 
index 2746d1f..35a8d47 100644 (file)
  * Smart callbacks one can register to:
  * - "changed" - the clock's user changed the time
  *
+ * Supported elm_object common APIs.
+ * @li elm_object_signal_emit
+ * @li elm_object_signal_callback_add
+ * @li elm_object_signal_callbacka_del
+ *
  * Here is an example on its usage:
  * @li @ref clock_example
  */
index e004d3e..00b4b47 100644 (file)
@@ -5,7 +5,7 @@
  * @return The widget object
  *
  * @note This returns the widget object itself that an item belongs to.
- *
+ * @note Every elm_object_item supports this API
  * @ingroup General
  */
 EAPI Evas_Object                 *elm_object_item_object_get(const Elm_Object_Item *it);
@@ -99,6 +99,7 @@ EAPI void                         elm_object_item_access_info_set(Elm_Object_Ite
  * @param it The Elementary object item
  * @return The data associated with @p it
  *
+ * @note Every elm_object_item supports this API
  * @ingroup General
  */
 EAPI void                        *elm_object_item_data_get(const Elm_Object_Item *it);
@@ -108,6 +109,7 @@ EAPI void                        *elm_object_item_data_get(const Elm_Object_Item
  * @param it The Elementary object item
  * @param data The data to be associated with @p it
  *
+ * @note Every elm_object_item supports this API
  * @ingroup General
  */
 EAPI void                         elm_object_item_data_set(Elm_Object_Item *it, void *data);
@@ -171,6 +173,8 @@ EAPI Eina_Bool                    elm_object_item_disabled_get(const Elm_Object_
  * @li Evas_Object * widget object
  * @li Elm_Object_Item * widget item
  *
+ * @note Every elm_object_item supports this API
+ *
  * @see elm_object_item_del()
  * @ingroup General
  */