* 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 @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
* @li @ref diskselector_example_02
* 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
*/
*
* @param obj The diskselector object.
*
- * @see elm_diskselector_item_del()
+ * @see elm_object_item_del()
* @see elm_diskselector_item_append()
*
* @ingroup Diskselector
* or @c NULL on failure.
*
* @see elm_diskselector_item_append()
- * @see elm_diskselector_item_del()
+ * @see elm_object_item_del()
* @see elm_diskselector_clear()
*
* @ingroup Diskselector
* to the right.
*
* Items created with this method can be deleted with
- * elm_diskselector_item_del().
+ * elm_object_item_del().
*
* 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
*
- * @see elm_diskselector_item_del()
+ * @see elm_object_item_del()
* @see elm_diskselector_clear()
* @see elm_icon_add()
*
*/
EAPI Elm_Object_Item *elm_diskselector_item_append(Evas_Object *obj, const char *label, Evas_Object *icon, Evas_Smart_Cb func, const void *data);
-
-/**
- * Delete them item from the diskselector.
- *
- * @param it The item of diskselector to be deleted.
- *
- * If deleting all diskselector items is required, elm_diskselector_clear()
- * should be used instead of getting items list and deleting each one.
- *
- * @see elm_diskselector_clear()
- * @see elm_diskselector_item_append()
- *
- * @ingroup Diskselector
- */
-EAPI void elm_diskselector_item_del(Elm_Object_Item *it);
-
/**
* Get the selected item.
*
* 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
EAPI Elm_Object_Item *elm_diskselector_item_next_get(const Elm_Object_Item *it);
/**
- * Set the text to be shown in the diskselector item.
- *
- * @param it Target item
- * @param text The text to set in the content
- *
- * Setup the text as tooltip to object. The item can have only one tooltip,
- * so any previous tooltip data is removed.
- *
- * @see elm_object_tooltip_text_set() for more details.
- *
- * @ingroup Diskselector
- */
-EAPI void elm_diskselector_item_tooltip_text_set(Elm_Object_Item *it, const char *text);
-
-/**
- * Set the content to be shown in the tooltip item.
- *
- * Setup the tooltip to item. The item can have only one tooltip,
- * so any previous tooltip data is removed. @p func(with @p data) will
- * be called every time that need show the tooltip and it should
- * return a valid Evas_Object. This object is then managed fully by
- * tooltip system and is deleted when the tooltip is gone.
- *
- * @param it the diskselector item being attached a tooltip.
- * @param func the function used to create the tooltip contents.
- * @param data what to provide to @a func as callback data/context.
- * @param del_cb called when data is not needed anymore, either when
- * another callback replaces @p func, the tooltip is unset with
- * elm_diskselector_item_tooltip_unset() or the owner @a item
- * dies. This callback receives as the first parameter the
- * given @a data, and @c event_info is the item.
- *
- * @see elm_object_tooltip_content_cb_set() for more details.
- *
- * @ingroup Diskselector
- */
-EAPI void elm_diskselector_item_tooltip_content_cb_set(Elm_Object_Item *it, Elm_Tooltip_Item_Content_Cb func, const void *data, Evas_Smart_Cb del_cb);
-
-/**
- * Unset tooltip from item.
- *
- * @param it diskselector item to remove previously set tooltip.
- *
- * Remove tooltip from item. The callback provided as del_cb to
- * elm_diskselector_item_tooltip_content_cb_set() will be called to notify
- * it is not used anymore.
- *
- * @see elm_object_tooltip_unset() for more details.
- * @see elm_diskselector_item_tooltip_content_cb_set()
- *
- * @ingroup Diskselector
- */
-EAPI void elm_diskselector_item_tooltip_unset(Elm_Object_Item *it);
-
-/**
- * Sets a different style for this item tooltip.
- *
- * @note before you set a style you should define a tooltip with
- * elm_diskselector_item_tooltip_content_cb_set() or
- * elm_diskselector_item_tooltip_text_set()
- *
- * @param it diskselector item with tooltip already set.
- * @param style the theme style to use (default, transparent, ...)
- *
- * @see elm_object_tooltip_style_set() for more details.
- *
- * @ingroup Diskselector
- */
-EAPI void elm_diskselector_item_tooltip_style_set(Elm_Object_Item *it, const char *style);
-
-/**
- * Get the style for this item tooltip.
- *
- * @param it diskselector item with tooltip already set.
- * @return style the theme style in use, defaults to "default". If the
- * object does not have a tooltip set, then NULL is returned.
- *
- * @see elm_object_tooltip_style_get() for more details.
- * @see elm_diskselector_item_tooltip_style_set()
- *
- * @ingroup Diskselector
- */
-EAPI const char *elm_diskselector_item_tooltip_style_get(const Elm_Object_Item *it);
-
-/**
- * Set the cursor to be shown when mouse is over the diskselector item
- *
- * @param it Target item
- * @param cursor the cursor name to be used.
- *
- * @see elm_object_cursor_set() for more details.
- *
- * @ingroup Diskselector
- */
-EAPI void elm_diskselector_item_cursor_set(Elm_Object_Item *it, const char *cursor);
-
-/**
- * Get the cursor to be shown when mouse is over the diskselector item
- *
- * @param it diskselector item with cursor already set.
- * @return the cursor name.
- *
- * @see elm_object_cursor_get() for more details.
- * @see elm_diskselector_cursor_set()
- *
- * @ingroup Diskselector
- */
-EAPI const char *elm_diskselector_item_cursor_get(const Elm_Object_Item *it);
-
-/**
- * Unset the cursor to be shown when mouse is over the diskselector item
- *
- * @param it Target item
- *
- * @see elm_object_cursor_unset() for more details.
- * @see elm_diskselector_cursor_set()
- *
- * @ingroup Diskselector
- */
-EAPI void elm_diskselector_item_cursor_unset(Elm_Object_Item *it);
-
-/**
- * Sets a different style for this item cursor.
- *
- * @note before you set a style you should define a cursor with
- * elm_diskselector_item_cursor_set()
- *
- * @param it diskselector item with cursor already set.
- * @param style the theme style to use (default, transparent, ...)
- *
- * @see elm_object_cursor_style_set() for more details.
- *
- * @ingroup Diskselector
- */
-EAPI void elm_diskselector_item_cursor_style_set(Elm_Object_Item *it, const char *style);
-
-/**
- * Get the style for this item cursor.
- *
- * @param it diskselector item with cursor already set.
- * @return style the theme style in use, defaults to "default". If the
- * object does not have a cursor set, then @c NULL is returned.
- *
- * @see elm_object_cursor_style_get() for more details.
- * @see elm_diskselector_item_cursor_style_set()
- *
- * @ingroup Diskselector
- */
-EAPI const char *elm_diskselector_item_cursor_style_get(const Elm_Object_Item *it);
-
-
-/**
- * Set if the cursor set should be searched on the theme or should use
- * the provided by the engine, only.
- *
- * @note before you set if should look on theme you should define a cursor
- * with elm_diskselector_item_cursor_set().
- * By default it will only look for cursors provided by the engine.
- *
- * @param it widget item with cursor already set.
- * @param engine_only boolean to define if cursors set with
- * elm_diskselector_item_cursor_set() should be searched only
- * between cursors provided by the engine or searched on widget's
- * theme as well.
- *
- * @see elm_object_cursor_engine_only_set() for more details.
- *
- * @ingroup Diskselector
- */
-EAPI void elm_diskselector_item_cursor_engine_only_set(Elm_Object_Item *it, Eina_Bool engine_only);
-
-/**
- * Get the cursor engine only usage for this item cursor.
- *
- * @param it widget item with cursor already set.
- * @return engine_only boolean to define it cursors should be looked only
- * between the provided by the engine or searched on widget's theme as well.
- * If the item does not have a cursor set, then @c EINA_FALSE is returned.
- *
- * @see elm_object_cursor_engine_only_get() for more details.
- * @see elm_diskselector_item_cursor_engine_only_set()
- *
- * @ingroup Diskselector
- */
-EAPI Eina_Bool elm_diskselector_item_cursor_engine_only_get(const Elm_Object_Item *it);
-
-/**
* @}
*/
-
projects / framework / uifw / elementary.git / blobdiff