summaryrefslogtreecommitdiff
path: root/src/lib/elm_index_eo.h
blob: 1834f05efde5859fd75df10a85557953f404bf83 (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
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
/**
 * @ingroup Index
 *
 * @{
 */
#define ELM_OBJ_INDEX_CLASS elm_obj_index_class_get()

const Eo *elm_obj_index_class_get(void) EINA_CONST;

extern EAPI Eo_Op ELM_OBJ_INDEX_BASE_ID;

enum
{
   ELM_OBJ_INDEX_SUB_ID_AUTOHIDE_DISABLED_SET,
   ELM_OBJ_INDEX_SUB_ID_AUTOHIDE_DISABLED_GET,
   ELM_OBJ_INDEX_SUB_ID_ITEM_LEVEL_SET,
   ELM_OBJ_INDEX_SUB_ID_ITEM_LEVEL_GET,
   ELM_OBJ_INDEX_SUB_ID_SELECTED_ITEM_GET,
   ELM_OBJ_INDEX_SUB_ID_ITEM_APPEND,
   ELM_OBJ_INDEX_SUB_ID_ITEM_PREPEND,
   ELM_OBJ_INDEX_SUB_ID_ITEM_INSERT_AFTER,
   ELM_OBJ_INDEX_SUB_ID_ITEM_INSERT_BEFORE,
   ELM_OBJ_INDEX_SUB_ID_ITEM_SORTED_INSERT,
   ELM_OBJ_INDEX_SUB_ID_ITEM_FIND,
   ELM_OBJ_INDEX_SUB_ID_ITEM_CLEAR,
   ELM_OBJ_INDEX_SUB_ID_LEVEL_GO,
   ELM_OBJ_INDEX_SUB_ID_INDICATOR_DISABLED_SET,
   ELM_OBJ_INDEX_SUB_ID_INDICATOR_DISABLED_GET,
   ELM_OBJ_INDEX_SUB_ID_HORIZONTAL_SET,
   ELM_OBJ_INDEX_SUB_ID_HORIZONTAL_GET,
   ELM_OBJ_INDEX_SUB_ID_DELAY_CHANGE_TIME_SET,
   ELM_OBJ_INDEX_SUB_ID_DELAY_CHANGE_TIME_GET,
   ELM_OBJ_INDEX_SUB_ID_OMIT_ENABLED_SET,
   ELM_OBJ_INDEX_SUB_ID_OMIT_ENABLED_GET,
   ELM_OBJ_INDEX_SUB_ID_LAST
};

#define ELM_OBJ_INDEX_ID(sub_id) (ELM_OBJ_INDEX_BASE_ID + sub_id)


/**
 * @def elm_obj_index_autohide_disabled_set
 * @since 1.8
 *
 * Enable or disable auto hiding feature for a given index widget.
 *
 * @param[in] disabled
 *
 * @see elm_index_autohide_disabled_set
 */
#define elm_obj_index_autohide_disabled_set(disabled) ELM_OBJ_INDEX_ID(ELM_OBJ_INDEX_SUB_ID_AUTOHIDE_DISABLED_SET), EO_TYPECHECK(Eina_Bool, disabled)

/**
 * @def elm_obj_index_autohide_disabled_get
 * @since 1.8
 *
 * Get whether auto hiding feature is enabled or not for a given index widget.
 *
 * @param[out] ret
 *
 * @see elm_index_autohide_disabled_get
 */
#define elm_obj_index_autohide_disabled_get(ret) ELM_OBJ_INDEX_ID(ELM_OBJ_INDEX_SUB_ID_AUTOHIDE_DISABLED_GET), EO_TYPECHECK(Eina_Bool *, ret)

/**
 * @def elm_obj_index_item_level_set
 * @since 1.8
 *
 * Set the items level for a given index widget.
 *
 * @param[in] level
 *
 * @see elm_index_item_level_set
 */
#define elm_obj_index_item_level_set(level) ELM_OBJ_INDEX_ID(ELM_OBJ_INDEX_SUB_ID_ITEM_LEVEL_SET), EO_TYPECHECK(int, level)

/**
 * @def elm_obj_index_item_level_get
 * @since 1.8
 *
 * Get the items level set for a given index widget.
 *
 * @param[out] ret
 *
 * @see elm_index_item_level_get
 */
#define elm_obj_index_item_level_get(ret) ELM_OBJ_INDEX_ID(ELM_OBJ_INDEX_SUB_ID_ITEM_LEVEL_GET), EO_TYPECHECK(int *, ret)

/**
 * @def elm_obj_index_selected_item_get
 * @since 1.8
 *
 * Returns the last selected item, for a given index widget.
 *
 * @param[in] level
 * @param[out] ret
 *
 * @see elm_index_selected_item_get
 */
#define elm_obj_index_selected_item_get(level, ret) ELM_OBJ_INDEX_ID(ELM_OBJ_INDEX_SUB_ID_SELECTED_ITEM_GET), EO_TYPECHECK(int, level), EO_TYPECHECK(Elm_Object_Item **, ret)

/**
 * @def elm_obj_index_item_append
 * @since 1.8
 *
 * Append a new item on a given index widget.
 *
 * @param[in] letter
 * @param[in] func
 * @param[in] data
 * @param[out] ret
 *
 * @see elm_index_item_append
 */
#define elm_obj_index_item_append(letter, func, data, ret) ELM_OBJ_INDEX_ID(ELM_OBJ_INDEX_SUB_ID_ITEM_APPEND), EO_TYPECHECK(const char *, letter), EO_TYPECHECK(Evas_Smart_Cb, func), EO_TYPECHECK(const void *, data), EO_TYPECHECK(Elm_Object_Item **, ret)

/**
 * @def elm_obj_index_item_prepend
 * @since 1.8
 *
 * Prepend a new item on a given index widget.
 *
 * @param[in] letter
 * @param[in] func
 * @param[in] data
 * @param[out] ret
 *
 * @see elm_index_item_prepend
 */
#define elm_obj_index_item_prepend(letter, func, data, ret) ELM_OBJ_INDEX_ID(ELM_OBJ_INDEX_SUB_ID_ITEM_PREPEND), EO_TYPECHECK(const char *, letter), EO_TYPECHECK(Evas_Smart_Cb, func), EO_TYPECHECK(const void *, data), EO_TYPECHECK(Elm_Object_Item **, ret)

/**
 * @def elm_obj_index_item_insert_after
 * @since 1.8
 *
 * Insert a new item into the index object after item after.
 *
 * @param[in] after
 * @param[in] letter
 * @param[in] func
 * @param[in] data
 * @param[out] ret
 *
 * @see elm_index_item_insert_after
 */
#define elm_obj_index_item_insert_after(after, letter, func, data, ret) ELM_OBJ_INDEX_ID(ELM_OBJ_INDEX_SUB_ID_ITEM_INSERT_AFTER), EO_TYPECHECK(Elm_Object_Item *, after), EO_TYPECHECK(const char *, letter), EO_TYPECHECK(Evas_Smart_Cb, func), EO_TYPECHECK(const void *, data), EO_TYPECHECK(Elm_Object_Item **, ret)

/**
 * @def elm_obj_index_item_insert_before
 * @since 1.8
 *
 * Insert a new item into the index object before item before.
 *
 * @param[in] before
 * @param[in] letter
 * @param[in] func
 * @param[in] data
 * @param[out] ret
 *
 * @see elm_index_item_insert_before
 */
#define elm_obj_index_item_insert_before(before, letter, func, data, ret) ELM_OBJ_INDEX_ID(ELM_OBJ_INDEX_SUB_ID_ITEM_INSERT_BEFORE), EO_TYPECHECK(Elm_Object_Item *, before), EO_TYPECHECK(const char *, letter), EO_TYPECHECK(Evas_Smart_Cb, func), EO_TYPECHECK(const void *, data), EO_TYPECHECK(Elm_Object_Item **, ret)

/**
 * @def elm_obj_index_item_sorted_insert
 * @since 1.8
 *
 * Insert a new item into the given index widget, using cmp_func
 *
 * @param[in] letter
 * @param[in] func
 * @param[in] data
 * @param[in] cmp_func
 * @param[in] cmp_data_func
 * @param[out] ret
 *
 * @see elm_index_item_sorted_insert
 */
#define elm_obj_index_item_sorted_insert(letter, func, data, cmp_func, cmp_data_func, ret) ELM_OBJ_INDEX_ID(ELM_OBJ_INDEX_SUB_ID_ITEM_SORTED_INSERT), EO_TYPECHECK(const char *, letter), EO_TYPECHECK(Evas_Smart_Cb, func), EO_TYPECHECK(const void *, data), EO_TYPECHECK(Eina_Compare_Cb, cmp_func), EO_TYPECHECK(Eina_Compare_Cb, cmp_data_func), EO_TYPECHECK(Elm_Object_Item **, ret)

/**
 * @def elm_obj_index_item_find
 * @since 1.8
 *
 * Find a given index widget's item, <b>using item data</b>.
 *
 * @param[in] data
 * @param[out] ret
 *
 * @see elm_index_item_find
 */
#define elm_obj_index_item_find(data, ret) ELM_OBJ_INDEX_ID(ELM_OBJ_INDEX_SUB_ID_ITEM_FIND), EO_TYPECHECK(const void *, data), EO_TYPECHECK(Elm_Object_Item **, ret)

/**
 * @def elm_obj_index_item_clear
 * @since 1.8
 *
 * Removes all items from a given index widget.
 *
 *
 * @see elm_index_item_clear
 */
#define elm_obj_index_item_clear() ELM_OBJ_INDEX_ID(ELM_OBJ_INDEX_SUB_ID_ITEM_CLEAR)

/**
 * @def elm_obj_index_level_go
 * @since 1.8
 *
 * Go to a given items level on a index widget
 *
 * @param[in] level
 *
 * @see elm_index_level_go
 */
#define elm_obj_index_level_go(level) ELM_OBJ_INDEX_ID(ELM_OBJ_INDEX_SUB_ID_LEVEL_GO), EO_TYPECHECK(int, level)

/**
 * @def elm_obj_index_indicator_disabled_set
 * @since 1.8
 *
 * Set the indicator as to be disabled.
 *
 * @param[in] disabled
 *
 * @see elm_index_indicator_disabled_set
 */
#define elm_obj_index_indicator_disabled_set(disabled) ELM_OBJ_INDEX_ID(ELM_OBJ_INDEX_SUB_ID_INDICATOR_DISABLED_SET), EO_TYPECHECK(Eina_Bool, disabled)

/**
 * @def elm_obj_index_indicator_disabled_get
 * @since 1.8
 *
 * Get the value of indicator's disabled status.
 *
 * @param[out] ret
 *
 * @see elm_index_indicator_disabled_get
 */
#define elm_obj_index_indicator_disabled_get(ret) ELM_OBJ_INDEX_ID(ELM_OBJ_INDEX_SUB_ID_INDICATOR_DISABLED_GET), EO_TYPECHECK(Eina_Bool *, ret)

/**
 * @def elm_obj_index_horizontal_set
 * @since 1.8
 *
 * Enable or disable horizontal mode on the index object
 *
 * @param[in] horizontal
 *
 * @see elm_index_horizontal_set
 */
#define elm_obj_index_horizontal_set(horizontal) ELM_OBJ_INDEX_ID(ELM_OBJ_INDEX_SUB_ID_HORIZONTAL_SET), EO_TYPECHECK(Eina_Bool, horizontal)

/**
 * @def elm_obj_index_horizontal_get
 * @since 1.8
 *
 * Get a value whether horizontal mode is enabled or not.
 *
 * @param[out] ret
 *
 * @see elm_index_horizontal_get
 */
#define elm_obj_index_horizontal_get(ret) ELM_OBJ_INDEX_ID(ELM_OBJ_INDEX_SUB_ID_HORIZONTAL_GET), EO_TYPECHECK(Eina_Bool *, ret)

/**
 * @def elm_obj_index_delay_change_time_set
 * @since 1.8
 *
 * Change index delay change time.
 *
 * @param[in] ret
 *
 * @see elm_index_delay_change_time_get
 */
#define elm_obj_index_delay_change_time_set(dtime) ELM_OBJ_INDEX_ID(ELM_OBJ_INDEX_SUB_ID_DELAY_CHANGE_TIME_SET), EO_TYPECHECK(double, dtime)

/**
 * @def elm_obj_index_delay_change_time_get
 * @since 1.8
 *
 * Get index delay change time.
 *
 * @param[out] ret
 *
 * @see elm_index_delay_change_time_set
 */
#define elm_obj_index_delay_change_time_get(ret) ELM_OBJ_INDEX_ID(ELM_OBJ_INDEX_SUB_ID_DELAY_CHANGE_TIME_GET), EO_TYPECHECK(double *, ret)

/**
 * @def elm_obj_index_omit_enabled_set
 * @since 1.8
 *
 * Enable or disable omit feature for a given index widget.
 *
 * @param[in] enabled
 *
 * @see elm_index_omit_enabled_set
 */
#define elm_obj_index_omit_enabled_set(enabled) ELM_OBJ_INDEX_ID(ELM_OBJ_INDEX_SUB_ID_OMIT_ENABLED_SET), EO_TYPECHECK(Eina_Bool, enabled)

/**
 * @def elm_obj_index_omit_enabled_get
 * @since 1.8
 *
 * Get whether omit feature is enabled or not for a given index widget.
 *
 * @param[out] ret
 *
 * @see elm_index_omit_enabled_get
 */
#define elm_obj_index_omit_enabled_get(ret) ELM_OBJ_INDEX_ID(ELM_OBJ_INDEX_SUB_ID_OMIT_ENABLED_GET), EO_TYPECHECK(Eina_Bool *, ret)


/**
 * @}
 */