summaryrefslogtreecommitdiff
path: root/src/lib/elm_list_eo.h
blob: 3434e073040277d96218a1bffb1bf39b8479d41d (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
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
/**
 * @ingroup List
 *
 * @{
 */
#define ELM_OBJ_LIST_CLASS elm_obj_list_class_get()

 const Eo *elm_obj_list_class_get(void) EINA_CONST;

 extern EAPI Eo_Op ELM_OBJ_LIST_BASE_ID;

 enum
{
   ELM_OBJ_LIST_SUB_ID_GO,
   ELM_OBJ_LIST_SUB_ID_MULTI_SELECT_SET,
   ELM_OBJ_LIST_SUB_ID_MULTI_SELECT_GET,
   ELM_OBJ_LIST_SUB_ID_MODE_SET,
   ELM_OBJ_LIST_SUB_ID_MODE_GET,
   ELM_OBJ_LIST_SUB_ID_HORIZONTAL_SET,
   ELM_OBJ_LIST_SUB_ID_HORIZONTAL_GET,
   ELM_OBJ_LIST_SUB_ID_SELECT_MODE_SET,
   ELM_OBJ_LIST_SUB_ID_SELECT_MODE_GET,
   ELM_OBJ_LIST_SUB_ID_CLEAR,
   ELM_OBJ_LIST_SUB_ID_ITEMS_GET,
   ELM_OBJ_LIST_SUB_ID_SELECTED_ITEM_GET,
   ELM_OBJ_LIST_SUB_ID_SELECTED_ITEMS_GET,
   ELM_OBJ_LIST_SUB_ID_ITEM_APPEND,
   ELM_OBJ_LIST_SUB_ID_ITEM_PREPEND,
   ELM_OBJ_LIST_SUB_ID_ITEM_INSERT_BEFORE,
   ELM_OBJ_LIST_SUB_ID_ITEM_INSERT_AFTER,
   ELM_OBJ_LIST_SUB_ID_ITEM_SORTED_INSERT,
   ELM_OBJ_LIST_SUB_ID_FIRST_ITEM_GET,
   ELM_OBJ_LIST_SUB_ID_LAST_ITEM_GET,
   ELM_OBJ_LIST_SUB_ID_AT_XY_ITEM_GET,
   ELM_OBJ_LIST_SUB_ID_FOCUS_ON_SELECTION_SET,
   ELM_OBJ_LIST_SUB_ID_FOCUS_ON_SELECTION_GET,
   ELM_OBJ_LIST_SUB_ID_LAST
};

#define ELM_OBJ_LIST_ID(sub_id) (ELM_OBJ_LIST_BASE_ID + sub_id)


/**
 * @def elm_obj_list_go
 * @since 1.8
 *
 * Starts the list.
 *
 *
 * @see elm_list_go
 */
#define elm_obj_list_go() ELM_OBJ_LIST_ID(ELM_OBJ_LIST_SUB_ID_GO)

/**
 * @def elm_obj_list_multi_select_set
 * @since 1.8
 *
 * Enable or disable multiple items selection on the list object.
 *
 * @param[in] multi
 *
 * @see elm_list_multi_select_set
 */
#define elm_obj_list_multi_select_set(multi) ELM_OBJ_LIST_ID(ELM_OBJ_LIST_SUB_ID_MULTI_SELECT_SET), EO_TYPECHECK(Eina_Bool, multi)

/**
 * @def elm_obj_list_multi_select_get
 * @since 1.8
 *
 * Get a value whether multiple items selection is enabled or not.
 *
 * @param[out] ret
 *
 * @see elm_list_multi_select_get
 */
#define elm_obj_list_multi_select_get(ret) ELM_OBJ_LIST_ID(ELM_OBJ_LIST_SUB_ID_MULTI_SELECT_GET), EO_TYPECHECK(Eina_Bool *, ret)

/**
 * @def elm_obj_list_mode_set
 * @since 1.8
 *
 * Set which mode to use for the list object.
 *
 * @param[in] mode
 *
 * @see elm_list_mode_set
 */
#define elm_obj_list_mode_set(mode) ELM_OBJ_LIST_ID(ELM_OBJ_LIST_SUB_ID_MODE_SET), EO_TYPECHECK(Elm_List_Mode, mode)

/**
 * @def elm_obj_list_mode_get
 * @since 1.8
 *
 * Get the mode the list is at.
 *
 * @param[out] ret
 *
 * @see elm_list_mode_get
 */
#define elm_obj_list_mode_get(ret) ELM_OBJ_LIST_ID(ELM_OBJ_LIST_SUB_ID_MODE_GET), EO_TYPECHECK(Elm_List_Mode *, ret)

/**
 * @def elm_obj_list_horizontal_set
 * @since 1.8
 *
 * Enable or disable horizontal mode on the list object.
 *
 * @param[in] horizontal
 *
 * @see elm_list_horizontal_set
 */
#define elm_obj_list_horizontal_set(horizontal) ELM_OBJ_LIST_ID(ELM_OBJ_LIST_SUB_ID_HORIZONTAL_SET), EO_TYPECHECK(Eina_Bool, horizontal)

/**
 * @def elm_obj_list_horizontal_get
 * @since 1.8
 *
 * Get a value whether horizontal mode is enabled or not.
 *
 * @param[out] ret
 *
 * @see elm_list_horizontal_get
 */
#define elm_obj_list_horizontal_get(ret) ELM_OBJ_LIST_ID(ELM_OBJ_LIST_SUB_ID_HORIZONTAL_GET), EO_TYPECHECK(Eina_Bool *, ret)

/**
 * @def elm_obj_list_select_mode_set
 * @since 1.8
 *
 * No description supplied by the EAPI.
 *
 * @param[in] mode
 *
 * @see elm_list_select_mode_set
 */
#define elm_obj_list_select_mode_set(mode) ELM_OBJ_LIST_ID(ELM_OBJ_LIST_SUB_ID_SELECT_MODE_SET), EO_TYPECHECK(Elm_Object_Select_Mode, mode)

/**
 * @def elm_obj_list_select_mode_get
 * @since 1.8
 *
 * No description supplied by the EAPI.
 *
 * @param[out] ret
 *
 * @see elm_list_select_mode_get
 */
#define elm_obj_list_select_mode_get(ret) ELM_OBJ_LIST_ID(ELM_OBJ_LIST_SUB_ID_SELECT_MODE_GET), EO_TYPECHECK(Elm_Object_Select_Mode *, ret)

/**
 * @def elm_obj_list_bounce_set
 * @since 1.8
 *
 * Set bouncing behaviour when the scrolled content reaches an edge.
 *
 * @param[in] h_bounce
 * @param[in] v_bounce
 *
 * @see elm_list_bounce_set
 */
#define elm_obj_list_bounce_set(h_bounce, v_bounce) ELM_OBJ_LIST_ID(ELM_OBJ_LIST_SUB_ID_BOUNCE_SET), EO_TYPECHECK(Eina_Bool, h_bounce), EO_TYPECHECK(Eina_Bool, v_bounce)

/**
 * @def elm_obj_list_bounce_get
 * @since 1.8
 *
 * Get the bouncing behaviour of the internal scroller.
 *
 * @param[out] h_bounce
 * @param[out] v_bounce
 *
 * @see elm_list_bounce_get
 */
#define elm_obj_list_bounce_get(h_bounce, v_bounce) ELM_OBJ_LIST_ID(ELM_OBJ_LIST_SUB_ID_BOUNCE_GET), EO_TYPECHECK(Eina_Bool *, h_bounce), EO_TYPECHECK(Eina_Bool *, v_bounce)

/**
 * @def elm_obj_list_scroller_policy_set
 * @since 1.8
 *
 * Set the scrollbar policy.
 *
 * @param[in] policy_h
 * @param[in] policy_v
 *
 * @see elm_list_scroller_policy_set
 */
#define elm_obj_list_scroller_policy_set(policy_h, policy_v) ELM_OBJ_LIST_ID(ELM_OBJ_LIST_SUB_ID_SCROLLER_POLICY_SET), EO_TYPECHECK(Elm_Scroller_Policy, policy_h), EO_TYPECHECK(Elm_Scroller_Policy, policy_v)

/**
 * @def elm_obj_list_scroller_policy_get
 * @since 1.8
 *
 * Get the scrollbar policy.
 *
 * @param[out] policy_h
 * @param[out] policy_v
 *
 * @see elm_list_scroller_policy_get
 */
#define elm_obj_list_scroller_policy_get(policy_h, policy_v) ELM_OBJ_LIST_ID(ELM_OBJ_LIST_SUB_ID_SCROLLER_POLICY_GET), EO_TYPECHECK(Elm_Scroller_Policy *, policy_h), EO_TYPECHECK(Elm_Scroller_Policy *, policy_v)

/**
 * @def elm_obj_list_clear
 * @since 1.8
 *
 * Remove all list's items.
 *
 *
 * @see elm_list_clear
 */
#define elm_obj_list_clear() ELM_OBJ_LIST_ID(ELM_OBJ_LIST_SUB_ID_CLEAR)

/**
 * @def elm_obj_list_items_get
 * @since 1.8
 *
 * Get a list of all the list items.
 *
 * @param[out] ret
 *
 * @see elm_list_items_get
 */
#define elm_obj_list_items_get(ret) ELM_OBJ_LIST_ID(ELM_OBJ_LIST_SUB_ID_ITEMS_GET), EO_TYPECHECK(const Eina_List **, ret)

/**
 * @def elm_obj_list_selected_item_get
 * @since 1.8
 *
 * Get the selected item.
 *
 * @param[out] ret
 *
 * @see elm_list_selected_item_get
 */
#define elm_obj_list_selected_item_get(ret) ELM_OBJ_LIST_ID(ELM_OBJ_LIST_SUB_ID_SELECTED_ITEM_GET), EO_TYPECHECK(Elm_Object_Item **, ret)

/**
 * @def elm_obj_list_selected_items_get
 * @since 1.8
 *
 * Return a list of the currently selected list items.
 *
 * @param[out] ret
 *
 * @see elm_list_selected_items_get
 */
#define elm_obj_list_selected_items_get(ret) ELM_OBJ_LIST_ID(ELM_OBJ_LIST_SUB_ID_SELECTED_ITEMS_GET), EO_TYPECHECK(const Eina_List **, ret)

/**
 * @def elm_obj_list_item_append
 * @since 1.8
 *
 * Append a new item to the list object.
 *
 * @param[in] label
 * @param[in] icon
 * @param[in] end
 * @param[in] func
 * @param[in] data
 * @param[out] ret
 *
 * @see elm_list_item_append
 */
#define elm_obj_list_item_append(label, icon, end, func, data, ret) ELM_OBJ_LIST_ID(ELM_OBJ_LIST_SUB_ID_ITEM_APPEND), EO_TYPECHECK(const char *, label), EO_TYPECHECK(Evas_Object *, icon), EO_TYPECHECK(Evas_Object *, end), EO_TYPECHECK(Evas_Smart_Cb, func), EO_TYPECHECK(const void *, data), EO_TYPECHECK(Elm_Object_Item **, ret)

/**
 * @def elm_obj_list_item_prepend
 * @since 1.8
 *
 * Prepend a new item to the list object.
 *
 * @param[in] label
 * @param[in] icon
 * @param[in] end
 * @param[in] func
 * @param[in] data
 * @param[out] ret
 *
 * @see elm_list_item_prepend
 */
#define elm_obj_list_item_prepend(label, icon, end, func, data, ret) ELM_OBJ_LIST_ID(ELM_OBJ_LIST_SUB_ID_ITEM_PREPEND), EO_TYPECHECK(const char *, label), EO_TYPECHECK(Evas_Object *, icon), EO_TYPECHECK(Evas_Object *, end), EO_TYPECHECK(Evas_Smart_Cb, func), EO_TYPECHECK(const void *, data), EO_TYPECHECK(Elm_Object_Item **, ret)

/**
 * @def elm_obj_list_item_insert_before
 * @since 1.8
 *
 * Insert a new item into the list object before item before.
 *
 * @param[in] before
 * @param[in] label
 * @param[in] icon
 * @param[in] end
 * @param[in] func
 * @param[in] data
 * @param[out] ret
 *
 * @see elm_list_item_insert_before
 */
#define elm_obj_list_item_insert_before(before, label, icon, end, func, data, ret) ELM_OBJ_LIST_ID(ELM_OBJ_LIST_SUB_ID_ITEM_INSERT_BEFORE), EO_TYPECHECK(Elm_Object_Item *, before), EO_TYPECHECK(const char *, label), EO_TYPECHECK(Evas_Object *, icon), EO_TYPECHECK(Evas_Object *, end), EO_TYPECHECK(Evas_Smart_Cb, func), EO_TYPECHECK(const void *, data), EO_TYPECHECK(Elm_Object_Item **, ret)

/**
 * @def elm_obj_list_item_insert_after
 * @since 1.8
 *
 * Insert a new item into the list object after item after.
 *
 * @param[in] after
 * @param[in] label
 * @param[in] icon
 * @param[in] end
 * @param[in] func
 * @param[in] data
 * @param[out] ret
 *
 * @see elm_list_item_insert_after
 */
#define elm_obj_list_item_insert_after(after, label, icon, end, func, data, ret) ELM_OBJ_LIST_ID(ELM_OBJ_LIST_SUB_ID_ITEM_INSERT_AFTER), EO_TYPECHECK(Elm_Object_Item *, after), EO_TYPECHECK(const char *, label), EO_TYPECHECK(Evas_Object *, icon), EO_TYPECHECK(Evas_Object *, end), EO_TYPECHECK(Evas_Smart_Cb, func), EO_TYPECHECK(const void *, data), EO_TYPECHECK(Elm_Object_Item **, ret)

/**
 * @def elm_obj_list_item_sorted_insert
 * @since 1.8
 *
 * Insert a new item into the sorted list object.
 *
 * @param[in] label
 * @param[in] icon
 * @param[in] end
 * @param[in] func
 * @param[in] data
 * @param[in] cmp_func
 * @param[out] ret
 *
 * @see elm_list_item_sorted_insert
 */
#define elm_obj_list_item_sorted_insert(label, icon, end, func, data, cmp_func, ret) ELM_OBJ_LIST_ID(ELM_OBJ_LIST_SUB_ID_ITEM_SORTED_INSERT), EO_TYPECHECK(const char *, label), EO_TYPECHECK(Evas_Object *, icon), EO_TYPECHECK(Evas_Object *, end), EO_TYPECHECK(Evas_Smart_Cb, func), EO_TYPECHECK(const void *, data), EO_TYPECHECK(Eina_Compare_Cb, cmp_func), EO_TYPECHECK(Elm_Object_Item **, ret)

/**
 * @def elm_obj_list_first_item_get
 * @since 1.8
 *
 * Get the first item in the list
 *
 * @param[out] ret
 *
 * @see elm_list_first_item_get
 */
#define elm_obj_list_first_item_get(ret) ELM_OBJ_LIST_ID(ELM_OBJ_LIST_SUB_ID_FIRST_ITEM_GET), EO_TYPECHECK(Elm_Object_Item **, ret)

/**
 * @def elm_obj_list_last_item_get
 * @since 1.8
 *
 * Get the last item in the list
 *
 * @param[out] ret
 *
 * @see elm_list_last_item_get
 */
#define elm_obj_list_last_item_get(ret) ELM_OBJ_LIST_ID(ELM_OBJ_LIST_SUB_ID_LAST_ITEM_GET), EO_TYPECHECK(Elm_Object_Item **, ret)

/**
 * @def elm_obj_list_at_xy_item_get
 * @since 1.8
 *
 * Get the item that is at the x, y canvas coords.
 *
 * @param[in] x
 * @param[in] y
 * @param[out] posret
 * @param[out] ret
 *
 * @see elm_list_at_xy_item_get
 */
#define elm_obj_list_at_xy_item_get(x, y, posret, ret) ELM_OBJ_LIST_ID(ELM_OBJ_LIST_SUB_ID_AT_XY_ITEM_GET), EO_TYPECHECK(Evas_Coord, x), EO_TYPECHECK(Evas_Coord, y), EO_TYPECHECK(int *, posret), EO_TYPECHECK(Elm_Object_Item **, ret)

/**
 * @def elm_obj_list_focus_on_selection_set
 * @since 1.8
 *
 * Set focus to a first from left focusable widget upon item selection.
 *
 * @param[in] enabled
 *
 * @see elm_obj_list_focus_on_selection_get
 */
#define elm_obj_list_focus_on_selection_set(enabled) ELM_OBJ_LIST_ID(ELM_OBJ_LIST_SUB_ID_FOCUS_ON_SELECTION_SET), EO_TYPECHECK(Eina_Bool, enabled)

/**
 * @def elm_obj_list_focus_on_selection_get
 * @since 1.8
 *
 * Get whether the focus will be set to a widget on an item upon it's selection.
 *
 * @param[out] ret
 *
 * @see elm_obj_list_focus_on_selection_set
 */
#define elm_obj_list_focus_on_selection_get(ret) ELM_OBJ_LIST_ID(ELM_OBJ_LIST_SUB_ID_FOCUS_ON_SELECTION_GET), EO_TYPECHECK(Eina_Bool *, ret)

/**
 * @}
 */