* 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 diskseletor 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
* 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
*
* @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
*
* @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.
*
* Default side label max length is 3.
*
- * This property will be applyed over all items, included before or
+ * This property will be applied over all items, included before or
* later this function call.
*
* @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.
* @param obj The diskselector object.
* @param num The number of items the diskselector will display.
*
- * Default value is 3, and also it's the minimun. If @p num is less
+ * Default value is 3, and also it's the minimum. If @p num is less
* than 3, it will be set to 3.
*
* Also, it can be set on theme, using data item @c display_item_num
* axis is reached scrolling.
*
* @param obj The diskselector object.
- * @param h_bounce Pointer where to store the bounce state of the horizontal
+ * @param h_bounce Pointer to store the bounce state of the horizontal
* axis.
- * @param v_bounce Pointer where to store the bounce state of the vertical
+ * @param v_bounce Pointer to store the bounce state of the vertical
* axis.
*
* @see elm_scroller_bounce_get()
* @see elm_diskselector_scroller_policy_get() for details.
*
* @param obj The diskselector object.
- * @param policy_h Pointer where to store horizontal scrollbar policy.
- * @param policy_v Pointer where to store vertical scrollbar policy.
+ * @param policy_h Pointer to store horizontal scrollbar policy.
+ * @param policy_v Pointer to store vertical scrollbar policy.
*
* @ingroup Diskselector
*/
* Associated @p data can be properly freed when item is deleted if a
* callback function is set with elm_object_item_del_cb_set().
*
- * If a function is passed as argument, it will be called everytime this item
+ * If a function is passed as argument, it will be called every time this item
* is selected, i.e., the user stops the diskselector with this
* item on center position. If such function isn't needed, just passing
* @c NULL as @p func is enough. The same should be done for @p data.
* 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
*
* diskselector will be selected.
*
* The selected item always will be centered on diskselector, with
- * full label displayed, i.e., max lenght set to side labels won't
+ * 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
*/
* This sets the selected state of the given item @p it.
* @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
*
- * If a new item is selected the previosly selected will be unselected.
- * Previoulsy selected item can be get with function
+ * If a new item is selected the previously selected will be unselected.
+ * Previously selected item can be get with function
* elm_diskselector_selected_item_get().
*
* If the item @p it is unselected, the first item of diskselector will
/**
* @}
*/
-
projects / framework / uifw / elementary.git / blobdiff