Macros | Functions
Diskselector

Macros

#define ELM_DISKSELECTOR_CLASS   elm_diskselector_class_get()
 Elementary diskselector class.
 

Functions

EINA_DEPRECATED void elm_diskselector_bounce_set (Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce)
 Set bouncing behaviour when the scrolled content reaches an edge. More...
 
EINA_DEPRECATED void elm_diskselector_bounce_get (const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce)
 Get the bouncing behaviour of the internal scroller. More...
 
EINA_DEPRECATED void elm_diskselector_scroller_policy_get (const Evas_Object *obj, Elm_Scroller_Policy *policy_h, Elm_Scroller_Policy *policy_v)
 Get the scrollbar policy. More...
 
EINA_DEPRECATED void elm_diskselector_scroller_policy_set (Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v)
 Set the scrollbar policy. More...
 
EOAPI void elm_obj_diskselector_side_text_max_length_set (Eo *obj, int len)
 Set the side labels max length. More...
 
EOAPI int elm_obj_diskselector_side_text_max_length_get (const Eo *obj)
 Get the side labels max length. More...
 
EOAPI void elm_obj_diskselector_round_enabled_set (Eo *obj, Eina_Bool enabled)
 Enable or disable round mode. More...
 
EOAPI Eina_Bool elm_obj_diskselector_round_enabled_get (const Eo *obj)
 Get a value whether round mode is enabled or not. More...
 
EOAPI void elm_obj_diskselector_display_item_num_set (Eo *obj, int num)
 Set the number of items to be displayed. More...
 
EOAPI int elm_obj_diskselector_display_item_num_get (const Eo *obj)
 Get the number of items in the diskselector object. More...
 
EOAPI Elm_Widget_Itemelm_obj_diskselector_first_item_get (const Eo *obj)
 Get the first item of the diskselector. More...
 
EOAPI const Eina_Listelm_obj_diskselector_items_get (const Eo *obj)
 Get a list of all the diskselector items. More...
 
EOAPI Elm_Widget_Itemelm_obj_diskselector_last_item_get (const Eo *obj)
 Get the last item of the diskselector. More...
 
EOAPI Elm_Widget_Itemelm_obj_diskselector_selected_item_get (const Eo *obj)
 Get the selected item. More...
 
EOAPI Elm_Widget_Itemelm_obj_diskselector_item_append (Eo *obj, const char *label, Efl_Canvas_Object *icon, Evas_Smart_Cb func, const void *data)
 Appends a new item to the diskselector object. More...
 
EOAPI void elm_obj_diskselector_clear (Eo *obj)
 Remove all diskselector's items. More...
 
Evas_Objectelm_diskselector_add (Evas_Object *parent)
 Add a new diskselector widget to the given parent Elementary (container) object. More...
 
EINA_DEPRECATED int elm_diskselector_side_label_lenght_get (const Evas_Object *obj)
 Get the side labels max length. More...
 
EINA_DEPRECATED void elm_diskselector_side_label_lenght_set (Evas_Object *obj, int len)
 Set the side labels max length. More...
 
EINA_DEPRECATED void * elm_diskselector_item_data_get (const Elm_Object_Item *it)
 Get the data associated to the item. More...
 
EINA_DEPRECATED void elm_diskselector_item_icon_set (Elm_Object_Item *it, Evas_Object *icon)
 Set the icon associated to the item. More...
 
Evas_Objectelm_diskselector_item_icon_get (const Elm_Object_Item *it)
 Get the icon associated to the item. More...
 
EINA_DEPRECATED void elm_diskselector_item_label_set (Elm_Object_Item *it, const char *label)
 Set the label of item. More...
 
EINA_DEPRECATED const char * elm_diskselector_item_label_get (const Elm_Object_Item *it)
 Get the label of item. More...
 
EINA_DEPRECATED void elm_diskselector_item_del_cb_set (Elm_Object_Item *it, Evas_Smart_Cb func)
 Set the function called when a diskselector item is freed. More...
 
EINA_DEPRECATED void elm_diskselector_item_del (Elm_Object_Item *it)
 Delete them item from the diskselector. More...
 
EINA_DEPRECATED void elm_diskselector_item_tooltip_text_set (Elm_Object_Item *it, const char *text)
 Set the text to be shown in the diskselector item. More...
 
EINA_DEPRECATED 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)
 Set the content to be shown in the tooltip item. More...
 
EINA_DEPRECATED void elm_diskselector_item_tooltip_unset (Elm_Object_Item *it)
 Unset tooltip from item. More...
 
EINA_DEPRECATED void elm_diskselector_item_tooltip_style_set (Elm_Object_Item *it, const char *style)
 Sets a different style for this item tooltip. More...
 
EINA_DEPRECATED const char * elm_diskselector_item_tooltip_style_get (const Elm_Object_Item *it)
 Get the style for this item tooltip. More...
 
EINA_DEPRECATED void elm_diskselector_item_cursor_set (Elm_Object_Item *it, const char *cursor)
 Set the cursor to be shown when mouse is over the diskselector item. More...
 
EINA_DEPRECATED const char * elm_diskselector_item_cursor_get (const Elm_Object_Item *it)
 Get the cursor to be shown when mouse is over the diskselector item. More...
 
EINA_DEPRECATED void elm_diskselector_item_cursor_unset (Elm_Object_Item *it)
 Unset the cursor to be shown when mouse is over the diskselector item. More...
 
EINA_DEPRECATED void elm_diskselector_item_cursor_style_set (Elm_Object_Item *it, const char *style)
 Sets a different style for this item cursor. More...
 
EINA_DEPRECATED const char * elm_diskselector_item_cursor_style_get (const Elm_Object_Item *it)
 Get the style for this item cursor. More...
 
EINA_DEPRECATED void elm_diskselector_item_cursor_engine_only_set (Elm_Object_Item *it, Eina_Bool engine_only)
 Set if the cursor set should be searched on the theme or should use the provided by the engine, only. More...
 
EINA_DEPRECATED Eina_Bool elm_diskselector_item_cursor_engine_only_get (const Elm_Object_Item *it)
 Get the cursor engine only usage for this item cursor. More...
 

Detailed Description

diskselector_inheritance_tree.png
preview-00.png

A diskselector is a kind of list widget. It scrolls horizontally, and can contain label and icon objects. Three items are displayed with the selected one in the middle.

It can act like a circular list with round mode and labels can be reduced for a defined length for side items.

This widget implements the The Elementary Scrollable Interface interface, so that all (non-deprecated) functions for the base Scroller widget also work for diskselectors.

Some calls on the diskselector's API are marked as deprecated, as they just wrap the scrollable widgets counterpart functions. Use the ones we point you to, for each case of deprecation here, instead – eventually the deprecated ones will be discarded (next major release).

This widget emits the following signals, besides the ones sent from Layout :

Note
The "scroll,anim,*" and "scroll,drag,*" signals are only emitted by user intervention.

Available styles for it:

Default content parts of the diskselector items that you can use for are:

Default text parts of the diskselector items that you can use for are:

Supported elm_object_item common APIs.

List of examples:

Function Documentation

◆ elm_diskselector_bounce_set()

EINA_DEPRECATED void elm_diskselector_bounce_set ( Evas_Object obj,
Eina_Bool  h_bounce,
Eina_Bool  v_bounce 
)

Set bouncing behaviour when the scrolled content reaches an edge.

Tell the internal scroller object whether it should bounce or not when it reaches the respective edges for each axis.

Parameters
objThe diskselector object.
h_bounceWhether to bounce or not in the horizontal axis.
v_bounceWhether to bounce or not in the vertical axis.
Deprecated:
Use elm_scroller_bounce_set() instead.
See also
elm_scroller_bounce_set()

◆ elm_diskselector_bounce_get()

EINA_DEPRECATED void elm_diskselector_bounce_get ( const Evas_Object obj,
Eina_Bool h_bounce,
Eina_Bool v_bounce 
)

Get the bouncing behaviour of the internal scroller.

Get whether the internal scroller should bounce when the edge of each axis is reached scrolling.

Parameters
objThe diskselector object.
h_bouncePointer to store the bounce state of the horizontal axis.
v_bouncePointer to store the bounce state of the vertical axis.
Deprecated:
Use elm_scroller_bounce_get() instead.
See also
elm_scroller_bounce_get()
elm_diskselector_bounce_set()

◆ elm_diskselector_scroller_policy_get()

EINA_DEPRECATED void elm_diskselector_scroller_policy_get ( const Evas_Object obj,
Elm_Scroller_Policy policy_h,
Elm_Scroller_Policy policy_v 
)

Get the scrollbar policy.

See also
elm_diskselector_scroller_policy_get() for details.
Parameters
objThe diskselector object.
policy_hPointer to store horizontal scrollbar policy.
policy_vPointer to store vertical scrollbar policy.
Deprecated:
Use elm_scroller_policy_get() instead.
See also
elm_scroller_policy_get()

◆ elm_diskselector_scroller_policy_set()

EINA_DEPRECATED void elm_diskselector_scroller_policy_set ( Evas_Object obj,
Elm_Scroller_Policy  policy_h,
Elm_Scroller_Policy  policy_v 
)

Set the scrollbar policy.

Parameters
objThe diskselector object.
policy_hHorizontal scrollbar policy.
policy_vVertical scrollbar policy.

This sets the scrollbar visibility policy for the given scroller. ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it is needed, and otherwise kept hidden. ELM_SCROLLER_POLICY_ON turns it on all the time, and ELM_SCROLLER_POLICY_OFF always keeps it off. This applies respectively for the horizontal and vertical scrollbars.

The both are disabled by default, i.e., are set to ELM_SCROLLER_POLICY_OFF.

Deprecated:
Use elm_scroller_policy_set() instead.
See also
elm_scroller_policy_set()

◆ elm_obj_diskselector_side_text_max_length_set()

EOAPI void elm_obj_diskselector_side_text_max_length_set ( Eo *  obj,
int  len 
)

Set the side labels max length.

Length is the number of characters of items' label that will be visible when it's set on side positions. It will just crop the string after defined size. E.g.:

An item with label "January" would be displayed on side position as "Jan" if max length is set to 3, or "Janu", if this property is set to 4.

When it's selected, the entire label will be displayed, except for width restrictions. In this case label will be cropped and "..." will be concatenated.

Default side label max length is 3.

This property will be applied over all items, included before or later this function call.

Parameters
[in]objThe object.
[in]lenThe max length defined for side labels.

◆ elm_obj_diskselector_side_text_max_length_get()

EOAPI int elm_obj_diskselector_side_text_max_length_get ( const Eo *  obj)

Get the side labels max length.

See also elm_obj_diskselector_side_text_max_length_set for details.

Parameters
[in]objThe object.
Returns
The max length defined for side labels.

◆ elm_obj_diskselector_round_enabled_set()

EOAPI void elm_obj_diskselector_round_enabled_set ( Eo *  obj,
Eina_Bool  enabled 
)

Enable or disable round mode.

Disabled by default. If round mode is enabled the items list will work like a circular list, so when the user reaches the last item, the first one will popup.

See also elm_obj_diskselector_round_enabled_get.

Parameters
[in]objThe object.
[in]enabledtrue to enable round mode or false to disable it.

◆ elm_obj_diskselector_round_enabled_get()

EOAPI Eina_Bool elm_obj_diskselector_round_enabled_get ( const Eo *  obj)

Get a value whether round mode is enabled or not.

See also elm_obj_diskselector_round_enabled_set for details.

Parameters
[in]objThe object.
Returns
true to enable round mode or false to disable it.

◆ elm_obj_diskselector_display_item_num_set()

EOAPI void elm_obj_diskselector_display_item_num_set ( Eo *  obj,
int  num 
)

Set the number of items to be displayed.

Default value is 3, and also it's the minimum. If num is less than 3, it will be set to 3.

Also, it can be set on theme, using data item display_item_num on group "elm/diskselector/item/X", where X is style set.

Parameters
[in]objThe object.
[in]numThe number of items the diskselector will display.

◆ elm_obj_diskselector_display_item_num_get()

EOAPI int elm_obj_diskselector_display_item_num_get ( const Eo *  obj)

Get the number of items in the diskselector object.

Parameters
[in]objThe object.
Returns
The number of items the diskselector will display.

◆ elm_obj_diskselector_first_item_get()

EOAPI Elm_Widget_Item* elm_obj_diskselector_first_item_get ( const Eo *  obj)

Get the first item of the diskselector.

The list of items follows append order. So it will return the first item appended to the widget that wasn't deleted.

See also elm_obj_diskselector_item_append, elm_obj_diskselector_items_get.

Parameters
[in]objThe object.
Returns
The first item, or null if none.

◆ elm_obj_diskselector_items_get()

EOAPI const Eina_List* elm_obj_diskselector_items_get ( const Eo *  obj)

Get a list of all the diskselector items.

See also elm_obj_diskselector_item_append, elm_object_item_del, elm_obj_diskselector_clear.

Parameters
[in]objThe object.
Returns
A list of diskselector items, or ull on failure.

◆ elm_obj_diskselector_last_item_get()

EOAPI Elm_Widget_Item* elm_obj_diskselector_last_item_get ( const Eo *  obj)

Get the last item of the diskselector.

The list of items follows append order. So it will return last first item appended to the widget that wasn't deleted.

See also elm_obj_diskselector_item_append, elm_obj_diskselector_items_get.

Parameters
[in]objThe object.
Returns
The last item, or null if none.

◆ elm_obj_diskselector_selected_item_get()

EOAPI Elm_Widget_Item* elm_obj_diskselector_selected_item_get ( const Eo *  obj)

Get the selected item.

The selected item can be unselected with elm_obj_diskselector_item_selected_set, and the first item of diskselector will be selected.

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_obj_diskselector_side_text_max_length_set.

Parameters
[in]objThe object.
Returns
The selected diskselector item.

◆ elm_obj_diskselector_item_append()

EOAPI Elm_Widget_Item* elm_obj_diskselector_item_append ( Eo *  obj,
const char *  label,
Efl_Canvas_Object icon,
Evas_Smart_Cb  func,
const void *  data 
)

Appends a new item to the diskselector object.

A new item will be created and appended to the diskselector, i.e., will be set as last item. Also, if there is no selected item, it will be selected. This will always happens for the first appended item.

If no icon is set, label will be centered on item position, otherwise the icon will be placed at left of the label, that will be shifted to the right.

Items created with this method can be deleted with elm_object_item_del.

Associated 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 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 null as func is enough. The same should be done for data.

See also elm_object_item_del, elm_obj_diskselector_clear, elm_icon_add.

Parameters
[in]objThe object.
[in]labelThe label of the diskselector item.
[in]iconThe icon object to use at left side of the item. An icon can be any Evas object, but usually it is an icon created with elm_icon_add().
[in]funcThe function to call when the item is selected.
[in]dataThe data to associate with the item for related callbacks.
Returns
New item

◆ elm_obj_diskselector_clear()

EOAPI void elm_obj_diskselector_clear ( Eo *  obj)

Remove all diskselector's items.

See also elm_object_item_del, elm_obj_diskselector_item_append.

Parameters
[in]objThe object.

◆ elm_diskselector_add()

Evas_Object* elm_diskselector_add ( Evas_Object parent)

Add a new diskselector widget to the given parent Elementary (container) object.

Parameters
parentThe parent object.
Returns
a new diskselector widget handle or NULL, on errors.

This function inserts a new diskselector widget on the canvas.

References EINA_SAFETY_ON_NULL_RETURN_VAL.

◆ elm_diskselector_side_label_lenght_get()

EINA_DEPRECATED int elm_diskselector_side_label_lenght_get ( const Evas_Object obj)

Get the side labels max length.

Deprecated:
use elm_diskselector_side_label_length_get() instead:
Parameters
objThe diskselector object.
Returns
The max length defined for side labels, or 0 if not a valid diskselector.

◆ elm_diskselector_side_label_lenght_set()

EINA_DEPRECATED void elm_diskselector_side_label_lenght_set ( Evas_Object obj,
int  len 
)

Set the side labels max length.

Deprecated:
use elm_diskselector_side_label_length_set() instead:
Parameters
objThe diskselector object.
lenThe max length defined for side labels.

◆ elm_diskselector_item_data_get()

EINA_DEPRECATED void* elm_diskselector_item_data_get ( const Elm_Object_Item it)

Get the data associated to the item.

Parameters
itThe diskselector item
Returns
The data associated to it

The return value is a pointer to data associated to item when it was created, with function elm_diskselector_item_append(). If no data was passed as argument, it will return NULL.

See also
elm_diskselector_item_append()
Deprecated:
Use elm_object_item_data_get()

◆ elm_diskselector_item_icon_set()

EINA_DEPRECATED void elm_diskselector_item_icon_set ( Elm_Object_Item it,
Evas_Object icon 
)

Set the icon associated to the item.

Parameters
itThe diskselector item
iconThe icon object to associate with it

The icon object to use at left side of the item. An icon can be any Evas object, but usually it is an icon created with elm_icon_add().

Once the icon object is set, a previously set one will be deleted.

Warning
Setting the same icon for two items will cause the icon to disappear from the first item.

If an icon was passed as argument on item creation, with function elm_diskselector_item_append(), it will be already associated to the item.

See also
elm_diskselector_item_append()
elm_diskselector_item_icon_get()
Deprecated:
Use elm_object_item_part_content_set() instead

◆ elm_diskselector_item_icon_get()

Evas_Object* elm_diskselector_item_icon_get ( const Elm_Object_Item it)

Get the icon associated to the item.

Parameters
itThe diskselector item
Returns
The icon associated to it

The return value is a pointer to the icon associated to item when it was created, with function elm_diskselector_item_append(), or later with function elm_diskselector_item_icon_set. If no icon was passed as argument, it will return NULL.

See also
elm_diskselector_item_append()
elm_diskselector_item_icon_set()
Deprecated:
Use elm_object_item_part_content_set() instead

◆ elm_diskselector_item_label_set()

EINA_DEPRECATED void elm_diskselector_item_label_set ( Elm_Object_Item it,
const char *  label 
)

Set the label of item.

Parameters
itThe item of diskselector.
labelThe label of item.

The label to be displayed by the item.

If no icon is set, label will be centered on item position, otherwise the icon will be placed at left of the label, that will be shifted to the right.

An item with label "January" would be displayed on side position as "Jan" if max length is set to 3 with function elm_diskselector_side_label_length_set(), or "Janu", if this property is set to 4.

When this item is selected, the entire label will be displayed, except for width restrictions. In this case label will be cropped and "..." will be concatenated, but only for display purposes. It will keep the entire string, so if diskselector is resized the remaining characters will be displayed.

If a label was passed as argument on item creation, with function elm_diskselector_item_append(), it will be already displayed by the item.

See also
elm_diskselector_side_label_length_set()
elm_diskselector_item_label_get()
elm_diskselector_item_append()
Deprecated:
Use elm_object_item_text_set() instead

◆ elm_diskselector_item_label_get()

EINA_DEPRECATED const char* elm_diskselector_item_label_get ( const Elm_Object_Item it)

Get the label of item.

Parameters
itThe item of diskselector.
Returns
The label of item.

The return value is a pointer to the label associated to item when it was created, with function elm_diskselector_item_append(), or later with function elm_diskselector_item_label_set. If no label was passed as argument, it will return NULL.

See also
elm_diskselector_item_label_set() for more details.
elm_diskselector_item_append()
Deprecated:
Use elm_object_item_text_get() instead

◆ elm_diskselector_item_del_cb_set()

EINA_DEPRECATED void elm_diskselector_item_del_cb_set ( Elm_Object_Item it,
Evas_Smart_Cb  func 
)

Set the function called when a diskselector item is freed.

Parameters
itThe item to set the callback on
funcThe function called

If there is a func, then it will be called prior item's memory release. That will be called with the following arguments:

  • item's data;
  • item's Evas object;
  • item itself;

This way, a data associated to a diskselector item could be properly freed.

Deprecated:
Use elm_object_item_del_cb_set() instead

◆ elm_diskselector_item_del()

EINA_DEPRECATED void elm_diskselector_item_del ( Elm_Object_Item it)

Delete them item from the diskselector.

Parameters
itThe 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.

Deprecated:
Use elm_object_item_del() instead
See also
elm_diskselector_clear()
elm_diskselector_item_append()

◆ elm_diskselector_item_tooltip_text_set()

EINA_DEPRECATED void elm_diskselector_item_tooltip_text_set ( Elm_Object_Item it,
const char *  text 
)

Set the text to be shown in the diskselector item.

Parameters
itTarget item
textThe 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.

Deprecated:
Use elm_object_item_tooltip_text_set() instead
See also
elm_object_tooltip_text_set() for more details.

◆ elm_diskselector_item_tooltip_content_cb_set()

EINA_DEPRECATED 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 
)

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. func(with 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.

Parameters
itthe diskselector item being attached a tooltip.
functhe function used to create the tooltip contents.
datawhat to provide to func as callback data/context.
del_cbcalled when data is not needed anymore, either when another callback replaces func, the tooltip is unset with elm_diskselector_item_tooltip_unset() or the owner item dies. This callback receives as the first parameter the given data, and event_info is the item.
Deprecated:
Use elm_object_item_tooltip_content_cb_set() instead
See also
elm_object_tooltip_content_cb_set() for more details.

◆ elm_diskselector_item_tooltip_unset()

EINA_DEPRECATED void elm_diskselector_item_tooltip_unset ( Elm_Object_Item it)

Unset tooltip from item.

Parameters
itdiskselector 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.

Deprecated:
Use elm_object_item_tooltip_unset() instead
See also
elm_object_tooltip_unset() for more details.
elm_diskselector_item_tooltip_content_cb_set()

◆ elm_diskselector_item_tooltip_style_set()

EINA_DEPRECATED void elm_diskselector_item_tooltip_style_set ( Elm_Object_Item it,
const char *  style 
)

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()
Parameters
itdiskselector item with tooltip already set.
stylethe theme style to use (default, transparent, ...)
Deprecated:
Use elm_object_item_tooltip_style_set() instead
See also
elm_object_tooltip_style_set() for more details.

◆ elm_diskselector_item_tooltip_style_get()

EINA_DEPRECATED const char* elm_diskselector_item_tooltip_style_get ( const Elm_Object_Item it)

Get the style for this item tooltip.

Parameters
itdiskselector item with tooltip already set.
Returns
style the theme style in use, defaults to "default". If the object does not have a tooltip set, then NULL is returned.
Deprecated:
Use elm_object_item_tooltip_style_get() instead
See also
elm_object_tooltip_style_get() for more details.
elm_diskselector_item_tooltip_style_set()

◆ elm_diskselector_item_cursor_set()

EINA_DEPRECATED void elm_diskselector_item_cursor_set ( Elm_Object_Item it,
const char *  cursor 
)

Set the cursor to be shown when mouse is over the diskselector item.

Parameters
itTarget item
cursorthe cursor name to be used.
See also
elm_object_cursor_set() for more details.
Deprecated:
Use elm_object_item_cursor_set() instead

◆ elm_diskselector_item_cursor_get()

EINA_DEPRECATED const char* elm_diskselector_item_cursor_get ( const Elm_Object_Item it)

Get the cursor to be shown when mouse is over the diskselector item.

Parameters
itdiskselector item with cursor already set.
Returns
the cursor name.
See also
elm_object_cursor_get() for more details.
elm_diskselector_item_cursor_set()
Deprecated:
Use elm_object_item_cursor_get() instead

◆ elm_diskselector_item_cursor_unset()

EINA_DEPRECATED void elm_diskselector_item_cursor_unset ( Elm_Object_Item it)

Unset the cursor to be shown when mouse is over the diskselector item.

Parameters
itTarget item
See also
elm_object_cursor_unset() for more details.
elm_diskselector_item_cursor_set()
Deprecated:
use elm_object_item_cursor_unset() instead

◆ elm_diskselector_item_cursor_style_set()

EINA_DEPRECATED void elm_diskselector_item_cursor_style_set ( Elm_Object_Item it,
const char *  style 
)

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()
Parameters
itdiskselector item with cursor already set.
stylethe theme style to use (default, transparent, ...)
See also
elm_object_cursor_style_set() for more details.
Deprecated:
Use elm_object_item_cursor_style_set() instead

◆ elm_diskselector_item_cursor_style_get()

EINA_DEPRECATED const char* elm_diskselector_item_cursor_style_get ( const Elm_Object_Item it)

Get the style for this item cursor.

Parameters
itdiskselector item with cursor already set.
Returns
style the theme style in use, defaults to "default". If the object does not have a cursor set, then NULL is returned.
See also
elm_object_cursor_style_get() for more details.
elm_diskselector_item_cursor_style_set()
Deprecated:
Use elm_object_item_cursor_style_get() instead

◆ elm_diskselector_item_cursor_engine_only_set()

EINA_DEPRECATED void elm_diskselector_item_cursor_engine_only_set ( Elm_Object_Item it,
Eina_Bool  engine_only 
)

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.
Parameters
itwidget item with cursor already set.
engine_onlyboolean 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.
Deprecated:
Use elm_object_item_cursor_engine_only_set() instead

◆ elm_diskselector_item_cursor_engine_only_get()

EINA_DEPRECATED Eina_Bool elm_diskselector_item_cursor_engine_only_get ( const Elm_Object_Item it)

Get the cursor engine only usage for this item cursor.

Parameters
itwidget item with cursor already set.
Returns
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 EINA_FALSE is returned.
See also
elm_diskselector_item_cursor_engine_only_set()
Deprecated:
Use elm_object_item_cursor_engine_only_get() instead