summaryrefslogtreecommitdiff
path: root/src/lib/elementary/elm_index_item_eo.h
blob: e4dbbf820b98e7d450214acde6fc2aacf8b1c2b4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
#ifndef _ELM_INDEX_ITEM_EO_H_
#define _ELM_INDEX_ITEM_EO_H_

#ifndef _ELM_INDEX_ITEM_EO_CLASS_TYPE
#define _ELM_INDEX_ITEM_EO_CLASS_TYPE

typedef Eo Elm_Index_Item;

#endif

#ifndef _ELM_INDEX_ITEM_EO_TYPES
#define _ELM_INDEX_ITEM_EO_TYPES


#endif
/** Elementary index item class
 *
 * @ingroup Elm_Index_Item
 */
#define ELM_INDEX_ITEM_CLASS elm_index_item_class_get()

EWAPI const Efl_Class *elm_index_item_class_get(void) EINA_CONST;

/**
 * @brief Set the selected state of an item.
 *
 * This sets the selected state of the given item @c it. @c true for selected,
 * @c false for not selected.
 *
 * If a new item is selected the previously selected will be unselected.
 * Previously selected item can be get with function
 * elm_index_selected_item_get().
 *
 * Selected items will be highlighted.
 *
 * @param[in] obj The object.
 * @param[in] selected @c true if selected, @c false otherwise
 *
 * @ingroup Elm_Index_Item
 */
EOAPI void elm_obj_index_item_selected_set(Eo *obj, Eina_Bool selected);

/**
 * @brief Sets the priority of an item.
 *
 * The priority is -1 by default, which means that the item doesn't belong to a
 * group. The value of the priority starts from 0.
 *
 * In elm_index_level_go, the items are sorted in ascending order according to
 * priority. Items of the same priority make a group and the primary group is
 * shown by default.
 *
 * @param[in] obj The object.
 * @param[in] priority The priority
 *
 * @ingroup Elm_Index_Item
 */
EOAPI void elm_obj_index_item_priority_set(Eo *obj, int priority);

/**
 * @brief Get the letter (string) set on a given index widget item.
 *
 * @param[in] obj The object.
 *
 * @return The letter string set on @c item
 *
 * @ingroup Elm_Index_Item
 */
EOAPI const char *elm_obj_index_item_letter_get(const Eo *obj);

#endif