[entry] fixed bug in non-editable entry selection handlers and fixed migration issue

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

diff --git a/src/lib/elm_diskselector.h b/src/lib/elm_diskselector.h
index 2015eb7..76eed8d 100644 (file)
--- a/src/lib/elm_diskselector.h
+++ b/src/lib/elm_diskselector.h
@@ -13,22 +13,28 @@
  * reduced for a defined length for side items.
  *
  * Smart callbacks one can listen to:
- * - "selected" - when item is selected, i.e. scroller stops.
+ * @li "selected" - when item is selected, i.e. scroller stops.
+ * @li "scroll,anim,start" - scrolling animation has started
+ * @li "scroll,anim,stop" - scrolling animation has stopped
+ * @li "scroll,drag,start" - dragging the diskselector has started
+ * @li "scroll,drag,stop" - dragging the diskselector has stopped
+ * @note The "scroll,anim,*" and "scroll,drag,*" signals are only emitted by
+ * user intervention.
  *
  * Available styles for it:
  * - @c "default"
  *
- * Default contents parts of the diskselector items that you can use for are:
+ * Default content parts of the diskselector items that you can use for are:
  * @li "icon" - An icon in the diskselector item
  *
  * Default text parts of the diskselector items that you can use for are:
  * @li "default" - Label of the diskselector item
  *
  * Supported elm_object_item common APIs.
- * @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 @ref elm_object_item_part_text_set
+ * @li @ref elm_object_item_part_text_get
+ * @li @ref elm_object_item_part_content_set
+ * @li @ref elm_object_item_part_content_get
  *
  * List of examples:
  * @li @ref diskselector_example_01
@@ -57,23 +63,23 @@ EAPI Evas_Object           *elm_diskselector_add(Evas_Object *parent);
  * Enable or disable round mode.
  *
  * @param obj The diskselector object.
- * @param round @c EINA_TRUE to enable round mode or @c EINA_FALSE to
+ * @param enabled @c EINA_TRUE to enable round mode or @c EINA_FALSE to
  * disable it.
  *
  * Disabled by default. If round mode is enabled the items list will
- * work like a circle list, so when the user reaches the last item,
+ * work like a circular list, so when the user reaches the last item,
  * the first one will popup.
  *
- * @see elm_diskselector_round_get()
+ * @see elm_diskselector_round_enabled_get()
  *
  * @ingroup Diskselector
  */
-EAPI void                   elm_diskselector_round_set(Evas_Object *obj, Eina_Bool round);
+EAPI void                   elm_diskselector_round_enabled_set(Evas_Object *obj, Eina_Bool enabled);
 
 /**
  * Get a value whether round mode is enabled or not.
  *
- * @see elm_diskselector_round_set() for details.
+ * @see elm_diskselector_round_enabled_set() for details.
  *
  * @param obj The diskselector object.
  * @return @c EINA_TRUE means round mode is enabled. @c EINA_FALSE indicates
@@ -81,12 +87,12 @@ EAPI void                   elm_diskselector_round_set(Evas_Object *obj, Eina_Bo
  *
  * @ingroup Diskselector
  */
-EAPI Eina_Bool              elm_diskselector_round_get(const Evas_Object *obj);
+EAPI Eina_Bool              elm_diskselector_round_enabled_get(const Evas_Object *obj);
 
 /**
  * Get the side labels max length.
  *
- * @see elm_diskselector_side_label_length_set() for details.
+ * @see elm_diskselector_side_text_max_length_set() for details.
  *
  * @param obj The diskselector object.
  * @return The max length defined for side labels, or 0 if not a valid
@@ -94,7 +100,7 @@ EAPI Eina_Bool              elm_diskselector_round_get(const Evas_Object *obj);
  *
  * @ingroup Diskselector
  */
-EAPI int                    elm_diskselector_side_label_length_get(const Evas_Object *obj);
+EAPI int                    elm_diskselector_side_text_max_length_get(const Evas_Object *obj);
 
 /**
  * Set the side labels max length.
@@ -121,7 +127,7 @@ EAPI int                    elm_diskselector_side_label_length_get(const Evas_Ob
  *
  * @ingroup Diskselector
  */
-EAPI void                   elm_diskselector_side_label_length_set(Evas_Object *obj, int len);
+EAPI void                   elm_diskselector_side_text_max_length_set(Evas_Object *obj, int len);
 
 /**
  * Set the number of items to be displayed.
@@ -286,7 +292,7 @@ EAPI const Eina_List       *elm_diskselector_items_get(const Evas_Object *obj);
  * disk = elm_diskselector_add(win);
  * ic = elm_icon_add(win);
  * elm_icon_file_set(ic, "path/to/image", NULL);
- * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
+ * elm_icon_resizable_set(ic, EINA_TRUE, EINA_TRUE);
  * elm_diskselector_item_append(disk, "label", ic, NULL, NULL);
  * @endcode
  *
@@ -311,7 +317,7 @@ EAPI Elm_Object_Item *elm_diskselector_item_append(Evas_Object *obj, const char
  * The selected item always will be centered on diskselector, with
  * full label displayed, i.e., max length set to side labels won't
  * apply on the selected item. More details on
- * elm_diskselector_side_label_length_set().
+ * elm_diskselector_side_text_max_length_set().
  *
  * @ingroup Diskselector
  */
@@ -432,4 +438,3 @@ EAPI Elm_Object_Item *elm_diskselector_item_next_get(const Elm_Object_Item *it);
 /**
  * @}
  */
-