[elementary] Documentation for the index widget.
[framework/uifw/elementary.git] / src / lib / elm_index.c
1 #include <Elementary.h>
2 #include "elm_priv.h"
3
4 typedef struct _Widget_Data Widget_Data;
5
6 struct _Widget_Data
7 {
8    Evas_Object *base;
9    Evas_Object *event[2];
10    Evas_Object *bx[2]; // 2 - for now all that's supported
11    Eina_List *items; // 1 list. yes N levels, but only 2 for now and # of items will be small
12    int level;
13    Evas_Coord dx, dy;
14    Ecore_Timer *delay;
15    Eina_Bool level_active[2];
16    Eina_Bool horizontal : 1;
17    Eina_Bool active : 1;
18    Eina_Bool down : 1;
19 };
20
21 struct _Elm_Index_Item
22 {
23    Elm_Widget_Item base;
24    const char *letter;
25    int level;
26    Eina_Bool selected : 1;
27 };
28
29 static const char *widtype = NULL;
30 static void _mirrored_set(Evas_Object *obj, Eina_Bool rtl);
31 static void _theme_hook(Evas_Object *obj);
32 static void _sizing_eval(Evas_Object *obj);
33 static void _index_box_auto_fill(Evas_Object *obj, Evas_Object *box, int level);
34 static void _index_box_clear(Evas_Object *obj, Evas_Object *box, int level);
35 static void _item_free(Elm_Index_Item *it);
36
37 static const char SIG_CHANGED[] = "changed";
38 static const char SIG_DELAY_CHANGED[] = "delay,changed";
39 static const char SIG_SELECTED[] = "selected";
40 static const char SIG_LEVEL_UP[] = "level,up";
41 static const char SIG_LEVEL_DOWN[] = "level,down";
42
43 static const Evas_Smart_Cb_Description _signals[] = {
44    {SIG_CHANGED, ""},
45    {SIG_DELAY_CHANGED, ""},
46    {SIG_SELECTED, ""},
47    {SIG_LEVEL_UP, ""},
48    {SIG_LEVEL_DOWN, ""},
49    {NULL, NULL}
50 };
51
52 static void
53 _del_pre_hook(Evas_Object *obj)
54 {
55    Widget_Data *wd = elm_widget_data_get(obj);
56    if (!wd) return;
57    _index_box_clear(obj, wd->bx[wd->level], wd->level);
58    _index_box_clear(obj, wd->bx[0], 0);
59    while (wd->items) _item_free(wd->items->data);
60    if (wd->delay) ecore_timer_del(wd->delay);
61 }
62
63 static void
64 _del_hook(Evas_Object *obj)
65 {
66    Widget_Data *wd = elm_widget_data_get(obj);
67    free(wd);
68 }
69
70 static void
71 _layout(Evas_Object *o, Evas_Object_Box_Data *priv, void *data)
72 {
73    Widget_Data *wd = data;
74    if (!wd) return;
75    _els_box_layout(o, priv, wd->horizontal, 1, 0);
76 }
77
78 static void
79 _signal_emit_hook(Evas_Object *obj, const char *emission, const char *source)
80 {
81    Widget_Data *wd = elm_widget_data_get(obj);
82    if (!wd) return;
83    edje_object_signal_emit(wd->base, emission, source);
84 }
85
86 static void
87 _signal_callback_add_hook(Evas_Object *obj, const char *emission, const char *source, Edje_Signal_Cb func_cb, void *data)
88 {
89    Widget_Data *wd = elm_widget_data_get(obj);
90    if (!wd) return;
91    edje_object_signal_callback_add(wd->base, emission, source, func_cb, data);
92 }
93
94 static void
95 _signal_callback_del_hook(Evas_Object *obj, const char *emission, const char *source, Edje_Signal_Cb func_cb, void *data)
96 {
97    Widget_Data *wd = elm_widget_data_get(obj);
98    edje_object_signal_callback_del_full(wd->base, emission, source, func_cb,
99                                         data);
100 }
101
102 static void
103 _mirrored_set(Evas_Object *obj, Eina_Bool rtl)
104 {
105    Widget_Data *wd = elm_widget_data_get(obj);
106    if (!wd) return;
107    if (!wd->horizontal)
108      edje_object_mirrored_set(wd->base, rtl);
109 }
110
111 static void
112 _theme_hook(Evas_Object *obj)
113 {
114    Evas_Coord minw = 0, minh = 0;
115    Widget_Data *wd = elm_widget_data_get(obj);
116    if (!wd) return;
117    _elm_widget_mirrored_reload(obj);
118
119    _index_box_clear(obj, wd->bx[0], 0);
120    _index_box_clear(obj, wd->bx[1], 1);
121    if (wd->horizontal)
122      _elm_theme_object_set(obj, wd->base, "index", "base/horizontal", elm_widget_style_get(obj));
123    else
124      {
125         _elm_theme_object_set(obj, wd->base, "index", "base/vertical", elm_widget_style_get(obj));
126         _mirrored_set(obj, elm_widget_mirrored_get(obj));
127      }
128    edje_object_part_swallow(wd->base, "elm.swallow.event.0", wd->event[0]);
129    elm_coords_finger_size_adjust(1, &minw, 1, &minh);
130    evas_object_size_hint_min_set(wd->event[0], minw, minh);
131    edje_object_part_swallow(wd->base, "elm.swallow.index.0", wd->bx[0]);
132    if (edje_object_part_exists(wd->base, "elm.swallow.index.1"))
133      {
134         if (!wd->bx[1])
135           {
136              wd->bx[1] = evas_object_box_add(evas_object_evas_get(wd->base));
137              evas_object_box_layout_set(wd->bx[1], _layout, wd, NULL);
138              elm_widget_sub_object_add(obj, wd->bx[1]);
139           }
140         edje_object_part_swallow(wd->base, "elm.swallow.index.1", wd->bx[1]);
141         evas_object_show(wd->bx[1]);
142      }
143    else if (wd->bx[1])
144      {
145         evas_object_del(wd->bx[1]);
146         wd->bx[1] = NULL;
147      }
148    if (edje_object_part_exists(wd->base, "elm.swallow.event.1"))
149      {
150         if (!wd->event[1])
151           {
152              wd->event[1] = evas_object_rectangle_add(evas_object_evas_get(wd->base));
153              evas_object_color_set(wd->event[1], 0, 0, 0, 0);
154              elm_widget_sub_object_add(obj, wd->event[1]);
155           }
156         edje_object_part_swallow(wd->base, "elm.swallow.event.1", wd->event[1]);
157         evas_object_size_hint_min_set(wd->event[1], minw, minh);
158      }
159    else if (wd->event[1])
160      {
161         evas_object_del(wd->event[1]);
162         wd->event[1] = NULL;
163      }
164    edje_object_message_signal_process(wd->base);
165    edje_object_scale_set(wd->base, elm_widget_scale_get(obj) * _elm_config->scale);
166    _sizing_eval(obj);
167    _index_box_auto_fill(obj, wd->bx[0], 0);
168    if (wd->active)
169      if (wd->level == 1)
170        _index_box_auto_fill(obj, wd->bx[1], 1);
171 }
172
173 static void
174 _sizing_eval(Evas_Object *obj)
175 {
176    Widget_Data *wd = elm_widget_data_get(obj);
177    Evas_Coord minw = -1, minh = -1, maxw = -1, maxh = -1;
178    if (!wd) return;
179    edje_object_size_min_calc(wd->base, &minw, &minh);
180    evas_object_size_hint_min_set(obj, minw, minh);
181    evas_object_size_hint_max_set(obj, maxw, maxh);
182 }
183
184 static Elm_Index_Item *
185 _item_new(Evas_Object *obj, const char *letter, const void *item)
186 {
187    Widget_Data *wd = elm_widget_data_get(obj);
188    Elm_Index_Item *it;
189    if (!wd) return NULL;
190    it = elm_widget_item_new(obj, Elm_Index_Item);
191    if (!it) return NULL;
192    it->letter = eina_stringshare_add(letter);
193    it->base.data = item;
194    it->level = wd->level;
195    return it;
196 }
197
198 static Elm_Index_Item *
199 _item_find(Evas_Object *obj, const void *item)
200 {
201    Widget_Data *wd = elm_widget_data_get(obj);
202    Eina_List *l;
203    Elm_Index_Item *it;
204    if (!wd) return NULL;
205    EINA_LIST_FOREACH(wd->items, l, it)
206       if (it->base.data == item) return it;
207    return NULL;
208 }
209
210 static void
211 _item_free(Elm_Index_Item *it)
212 {
213    Widget_Data *wd = elm_widget_data_get(it->base.widget);
214    if (!wd) return;
215    wd->items = eina_list_remove(wd->items, it);
216    elm_widget_item_pre_notify_del(it);
217    eina_stringshare_del(it->letter);
218    elm_widget_item_del(it);
219 }
220
221 // FIXME: always have index filled
222 static void
223 _index_box_auto_fill(Evas_Object *obj, Evas_Object *box, int level)
224 {
225    Widget_Data *wd = elm_widget_data_get(obj);
226    Eina_Bool rtl;
227    Eina_List *l;
228    Elm_Index_Item *it;
229    Evas_Coord mw, mh, w, h;
230    int i = 0;
231    if (!wd) return;
232    if (wd->level_active[level]) return;
233    rtl = elm_widget_mirrored_get(obj);
234    evas_object_geometry_get(box, NULL, NULL, &w, &h);
235    EINA_LIST_FOREACH(wd->items, l, it)
236      {
237         Evas_Object *o;
238         const char *stacking;
239
240         if (it->level != level) continue;
241         o = edje_object_add(evas_object_evas_get(obj));
242         it->base.view = o;
243         edje_object_mirrored_set(it->base.view, rtl);
244         if (i & 0x1)
245           _elm_theme_object_set(obj, o, "index", "item_odd/vertical", elm_widget_style_get(obj));
246         else
247           _elm_theme_object_set(obj, o, "index", "item/vertical", elm_widget_style_get(obj));
248         edje_object_part_text_set(o, "elm.text", it->letter);
249         edje_object_size_min_restricted_calc(o, &mw, &mh, 0, 0);
250         evas_object_size_hint_min_set(o, mw, mh);
251         evas_object_size_hint_weight_set(o, EVAS_HINT_EXPAND, EVAS_HINT_EXPAND);
252         evas_object_size_hint_align_set(o, EVAS_HINT_FILL, EVAS_HINT_FILL);
253         elm_widget_sub_object_add(obj, o);
254         evas_object_box_append(box, o);
255         stacking = edje_object_data_get(o, "stacking");
256         if (stacking)
257           {
258              if (!strcmp(stacking, "below")) evas_object_lower(o);
259              else if (!strcmp(stacking, "above")) evas_object_raise(o);
260           }
261         evas_object_show(o);
262         i++;
263         evas_object_smart_calculate(box); // force a calc so we know the size
264         evas_object_size_hint_min_get(box, &mw, &mh);
265         if (mh > h)
266           {
267              _index_box_clear(obj, box, level);
268              if (i > 0)
269                {
270                   // FIXME: only i objects fit! try again. overflows right now
271                }
272           }
273      }
274    evas_object_smart_calculate(box);
275    wd->level_active[level] = 1;
276 }
277
278 static void
279 _index_box_clear(Evas_Object *obj, Evas_Object *box __UNUSED__, int level)
280 {
281    Widget_Data *wd = elm_widget_data_get(obj);
282    Eina_List *l;
283    Elm_Index_Item *it;
284    if (!wd) return;
285    if (!wd->level_active[level]) return;
286    EINA_LIST_FOREACH(wd->items, l, it)
287      {
288         if (!it->base.view) continue;
289         if (it->level != level) continue;
290         evas_object_del(it->base.view);
291         it->base.view = NULL;
292      }
293    wd->level_active[level] = 0;
294 }
295
296 static Eina_Bool
297 _delay_change(void *data)
298 {
299    Widget_Data *wd = elm_widget_data_get(data);
300    void *d;
301    if (!wd) return ECORE_CALLBACK_CANCEL;
302    wd->delay = NULL;
303    d = (void *)elm_index_item_selected_get(data, wd->level);
304    if (d) evas_object_smart_callback_call(data, SIG_DELAY_CHANGED, d);
305    return ECORE_CALLBACK_CANCEL;
306 }
307
308 static void
309 _sel_eval(Evas_Object *obj, Evas_Coord evx, Evas_Coord evy)
310 {
311    Widget_Data *wd = elm_widget_data_get(obj);
312    Elm_Index_Item *it, *it_closest, *it_last;
313    Eina_List *l;
314    Evas_Coord x, y, w, h, bx, by, bw, bh, xx, yy;
315    double cdv = 0.5;
316    Evas_Coord dist;
317    char *label = NULL, *last = NULL;
318    int i;
319    if (!wd) return;
320    for (i = 0; i <= wd->level; i++)
321      {
322         it_last = NULL;
323         it_closest  = NULL;
324         dist = 0x7fffffff;
325         evas_object_geometry_get(wd->bx[i], &bx, &by, &bw, &bh);
326         EINA_LIST_FOREACH(wd->items, l, it)
327           {
328              if (!((it->level == i) && (it->base.view))) continue;
329              if ((it->base.view) && (it->level != wd->level))
330                {
331                   if (it->selected)
332                     {
333                        it_closest = it;
334                        break;
335                     }
336                   continue;
337                }
338              if (it->selected)
339                {
340                   it_last = it;
341                   it->selected = 0;
342                }
343              evas_object_geometry_get(it->base.view, &x, &y, &w, &h);
344              xx = x + (w / 2);
345              yy = y + (h / 2);
346              x = evx - xx;
347              y = evy - yy;
348              x = (x * x) + (y * y);
349              if ((x < dist) || (!it_closest))
350                {
351                   if (wd->horizontal)
352                     cdv = (double)(xx - bx) / (double)bw;
353                   else
354                     cdv = (double)(yy - by) / (double)bh;
355                   it_closest = it;
356                   dist = x;
357                }
358           }
359         if ((!i) && (!wd->level))
360           edje_object_part_drag_value_set(wd->base, "elm.dragable.index.1",
361                                           cdv, cdv);
362         if (it_closest) it_closest->selected = 1;
363         if (it_closest != it_last)
364           {
365              if (it_last)
366                {
367                   const char *stacking, *selectraise;
368
369                   it = it_last;
370                   edje_object_signal_emit(it->base.view, "elm,state,inactive", "elm");
371                   stacking = edje_object_data_get(it->base.view, "stacking");
372                   selectraise = edje_object_data_get(it->base.view, "selectraise");
373                   if ((selectraise) && (!strcmp(selectraise, "on")))
374                     {
375                        if ((stacking) && (!strcmp(stacking, "below")))
376                          evas_object_lower(it->base.view);
377                     }
378                }
379              if (it_closest)
380                {
381                   const char *selectraise;
382
383                   it = it_closest;
384                   edje_object_signal_emit(it->base.view, "elm,state,active", "elm");
385                   selectraise = edje_object_data_get(it->base.view, "selectraise");
386                   if ((selectraise) && (!strcmp(selectraise, "on")))
387                     evas_object_raise(it->base.view);
388                   evas_object_smart_callback_call((void *)obj, SIG_CHANGED, (void *)it->base.data);
389                   if (wd->delay) ecore_timer_del(wd->delay);
390                   wd->delay = ecore_timer_add(0.2, _delay_change, obj);
391                }
392           }
393         if (it_closest)
394           {
395              it = it_closest;
396              if (!last)
397                last = strdup(it->letter);
398              else
399                {
400                   if (!label) label = strdup(last);
401                   else
402                     {
403                        /* FIXME: realloc return NULL if the request fails */
404                        label = realloc(label, strlen(label) + strlen(last) + 1);
405                        strcat(label, last);
406                     }
407                   free(last);
408                   last = strdup(it->letter);
409                }
410           }
411      }
412    if (!label) label = strdup("");
413    if (!last) last = strdup("");
414    edje_object_part_text_set(wd->base, "elm.text.body", label);
415    edje_object_part_text_set(wd->base, "elm.text", last);
416    free(label);
417    free(last);
418 }
419
420 static void
421 _wheel(void *data, Evas *e __UNUSED__, Evas_Object *o __UNUSED__, void *event_info __UNUSED__)
422 {
423    Widget_Data *wd = elm_widget_data_get(data);
424    //   Evas_Event_Mouse_Wheel *ev = event_info;
425    //   Evas_Object *obj = o;
426    if (!wd) return;
427 }
428
429 static void
430 _mouse_down(void *data, Evas *e __UNUSED__, Evas_Object *o __UNUSED__, void *event_info)
431 {
432    Widget_Data *wd = elm_widget_data_get(data);
433    Evas_Event_Mouse_Down *ev = event_info;
434    Evas_Coord x, y, w;
435    if (!wd) return;
436    if (ev->button != 1) return;
437    wd->down = 1;
438    evas_object_geometry_get(wd->base, &x, &y, &w, NULL);
439    wd->dx = ev->canvas.x - x;
440    wd->dy = ev->canvas.y - y;
441    elm_index_active_set(data, 1);
442    _sel_eval(data, ev->canvas.x, ev->canvas.y);
443    edje_object_part_drag_value_set(wd->base, "elm.dragable.pointer",
444                                    (!edje_object_mirrored_get(wd->base)) ? wd->dx : (wd->dx - w), wd->dy);
445 }
446
447 static void
448 _mouse_up(void *data, Evas *e __UNUSED__, Evas_Object *o __UNUSED__, void *event_info)
449 {
450    Widget_Data *wd = elm_widget_data_get(data);
451    Evas_Event_Mouse_Up *ev = event_info;
452    void *d;
453    if (!wd) return;
454    if (ev->button != 1) return;
455    wd->down = 0;
456    d = (void *)elm_index_item_selected_get(data, wd->level);
457    if (d) evas_object_smart_callback_call(data, SIG_SELECTED, d);
458    elm_index_active_set(data, 0);
459    edje_object_signal_emit(wd->base, "elm,state,level,0", "elm");
460 }
461
462 static void
463 _mouse_move(void *data, Evas *e __UNUSED__, Evas_Object *o __UNUSED__, void *event_info)
464 {
465    Widget_Data *wd = elm_widget_data_get(data);
466    Evas_Event_Mouse_Move *ev = event_info;
467    Evas_Coord minw = 0, minh = 0, x, y, dx, adx, w;
468    char buf[1024];
469    if (!wd) return;
470    if (!wd->down) return;
471    elm_coords_finger_size_adjust(1, &minw, 1, &minh);
472    evas_object_geometry_get(wd->base, &x, &y, &w, NULL);
473    x = ev->cur.canvas.x - x;
474    y = ev->cur.canvas.y - y;
475    dx = x - wd->dx;
476    adx = dx;
477    if (adx < 0) adx = -dx;
478    edje_object_part_drag_value_set(wd->base, "elm.dragable.pointer"
479                                    , (!edje_object_mirrored_get(wd->base)) ? x : (x - w), y);
480    if (!wd->horizontal)
481      {
482         if (adx > minw)
483           {
484              if (!wd->level)
485                {
486                   wd->level = 1;
487                   snprintf(buf, sizeof(buf), "elm,state,level,%i", wd->level);
488                   edje_object_signal_emit(wd->base, buf, "elm");
489                   evas_object_smart_callback_call(data, SIG_LEVEL_UP, NULL);
490                }
491           }
492         else
493           {
494              if (wd->level == 1)
495                {
496                   wd->level = 0;
497                   snprintf(buf, sizeof(buf), "elm,state,level,%i", wd->level);
498                   edje_object_signal_emit(wd->base, buf, "elm");
499                   evas_object_smart_callback_call(data, SIG_LEVEL_DOWN, NULL);
500                }
501           }
502      }
503    _sel_eval(data, ev->cur.canvas.x, ev->cur.canvas.y);
504 }
505
506 EAPI Evas_Object *
507 elm_index_add(Evas_Object *parent)
508 {
509    Evas_Object *obj;
510    Evas_Object *o;
511    Evas *e;
512    Widget_Data *wd;
513    Evas_Coord minw, minh;
514
515    ELM_WIDGET_STANDARD_SETUP(wd, Widget_Data, parent, e, obj, NULL);
516
517    ELM_SET_WIDTYPE(widtype, "index");
518    elm_widget_type_set(obj, "index");
519    elm_widget_sub_object_add(parent, obj);
520    elm_widget_data_set(obj, wd);
521    elm_widget_del_hook_set(obj, _del_hook);
522    elm_widget_del_pre_hook_set(obj, _del_pre_hook);
523    elm_widget_theme_hook_set(obj, _theme_hook);
524    elm_widget_signal_emit_hook_set(obj, _signal_emit_hook);
525    elm_widget_signal_callback_add_hook_set(obj, _signal_callback_add_hook);
526    elm_widget_signal_callback_del_hook_set(obj, _signal_callback_del_hook);
527    elm_widget_can_focus_set(obj, EINA_FALSE);
528
529    wd->horizontal = EINA_FALSE;
530
531    wd->base = edje_object_add(e);
532    _elm_theme_object_set(obj, wd->base, "index", "base/vertical", "default");
533    elm_widget_resize_object_set(obj, wd->base);
534
535    o = evas_object_rectangle_add(e);
536    wd->event[0] = o;
537    evas_object_color_set(o, 0, 0, 0, 0);
538    minw = minh = 0;
539    elm_coords_finger_size_adjust(1, &minw, 1, &minh);
540    evas_object_size_hint_min_set(o, minw, minh);
541    edje_object_part_swallow(wd->base, "elm.swallow.event.0", o);
542    elm_widget_sub_object_add(obj, o);
543    evas_object_event_callback_add(o, EVAS_CALLBACK_MOUSE_WHEEL, _wheel, obj);
544    evas_object_event_callback_add(o, EVAS_CALLBACK_MOUSE_DOWN, _mouse_down, obj);
545    evas_object_event_callback_add(o, EVAS_CALLBACK_MOUSE_UP, _mouse_up, obj);
546    evas_object_event_callback_add(o, EVAS_CALLBACK_MOUSE_MOVE, _mouse_move, obj);
547    evas_object_show(o);
548    if (edje_object_part_exists(wd->base, "elm.swallow.event.1"))
549      {
550         o = evas_object_rectangle_add(e);
551         wd->event[1] = o;
552         evas_object_color_set(o, 0, 0, 0, 0);
553         evas_object_size_hint_min_set(o, minw, minh);
554         edje_object_part_swallow(wd->base, "elm.swallow.event.1", o);
555         elm_widget_sub_object_add(obj, o);
556      }
557
558    wd->bx[0] = evas_object_box_add(e);
559    evas_object_box_layout_set(wd->bx[0], _layout, wd, NULL);
560    elm_widget_sub_object_add(obj, wd->bx[0]);
561    edje_object_part_swallow(wd->base, "elm.swallow.index.0", wd->bx[0]);
562    evas_object_show(wd->bx[0]);
563
564    if (edje_object_part_exists(wd->base, "elm.swallow.index.1"))
565      {
566         wd->bx[1] = evas_object_box_add(e);
567         evas_object_box_layout_set(wd->bx[1], _layout, wd, NULL);
568         elm_widget_sub_object_add(obj, wd->bx[1]);
569         edje_object_part_swallow(wd->base, "elm.swallow.index.1", wd->bx[1]);
570         evas_object_show(wd->bx[1]);
571      }
572
573    evas_object_smart_callbacks_descriptions_set(obj, _signals);
574
575    _mirrored_set(obj, elm_widget_mirrored_get(obj));
576    _sizing_eval(obj);
577    return obj;
578 }
579
580 EAPI void
581 elm_index_active_set(Evas_Object *obj, Eina_Bool active)
582 {
583    ELM_CHECK_WIDTYPE(obj, widtype);
584    Widget_Data *wd = elm_widget_data_get(obj);
585    if (!wd) return;
586    if (wd->active == active) return;
587    wd->active = active;
588    wd->level = 0;
589    if (wd->active)
590      {
591         _index_box_clear(obj, wd->bx[1], 1);
592         _index_box_auto_fill(obj, wd->bx[0], 0);
593         edje_object_signal_emit(wd->base, "elm,state,active", "elm");
594      }
595    else
596      edje_object_signal_emit(wd->base, "elm,state,inactive", "elm");
597 }
598
599 EAPI Eina_Bool
600 elm_index_active_get(const Evas_Object *obj)
601 {
602    ELM_CHECK_WIDTYPE(obj, widtype) EINA_FALSE;
603    Widget_Data *wd = elm_widget_data_get(obj);
604    if (!wd) return EINA_FALSE;
605    return wd->active;
606 }
607
608 EAPI void
609 elm_index_item_level_set(Evas_Object *obj, int level)
610 {
611    ELM_CHECK_WIDTYPE(obj, widtype);
612    Widget_Data *wd = elm_widget_data_get(obj);
613    if (!wd) return;
614    if (wd->level == level) return;
615    wd->level = level;
616 }
617
618 EAPI int
619 elm_index_item_level_get(const Evas_Object *obj)
620 {
621    ELM_CHECK_WIDTYPE(obj, widtype) 0;
622    Widget_Data *wd = elm_widget_data_get(obj);
623    if (!wd) return 0;
624    return wd->level;
625 }
626
627 EAPI void *
628 elm_index_item_selected_get(const Evas_Object *obj, int level)
629 {
630    ELM_CHECK_WIDTYPE(obj, widtype) NULL;
631    Widget_Data *wd = elm_widget_data_get(obj);
632    Eina_List *l;
633    Elm_Index_Item *it;
634    if (!wd) return NULL;
635    EINA_LIST_FOREACH(wd->items, l, it)
636       if ((it->selected) && (it->level == level))
637         return elm_widget_item_data_get(it);
638    return NULL;
639 }
640
641 EAPI void
642 elm_index_item_append(Evas_Object *obj, const char *letter, const void *item)
643 {
644    ELM_CHECK_WIDTYPE(obj, widtype);
645    Widget_Data *wd = elm_widget_data_get(obj);
646    Elm_Index_Item *it;
647    if (!wd) return;
648    it = _item_new(obj, letter, item);
649    if (!it) return;
650    wd->items = eina_list_append(wd->items, it);
651    _index_box_clear(obj, wd->bx[wd->level], wd->level);
652 }
653
654 EAPI void
655 elm_index_item_prepend(Evas_Object *obj, const char *letter, const void *item)
656 {
657    ELM_CHECK_WIDTYPE(obj, widtype);
658    Widget_Data *wd = elm_widget_data_get(obj);
659    Elm_Index_Item *it;
660
661    if (!wd) return;
662    it = _item_new(obj, letter, item);
663    if (!it) return;
664    wd->items = eina_list_prepend(wd->items, it);
665    _index_box_clear(obj, wd->bx[wd->level], wd->level);
666 }
667
668 EAPI void
669 elm_index_item_append_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative)
670 {
671    ELM_CHECK_WIDTYPE(obj, widtype);
672    Widget_Data *wd = elm_widget_data_get(obj);
673    Elm_Index_Item *it, *it_rel;
674    if (!wd) return;
675    if (!relative)
676      {
677         elm_index_item_append(obj, letter, item);
678         return;
679      }
680    it = _item_new(obj, letter, item);
681    it_rel = _item_find(obj, relative);
682    if (!it_rel)
683      {
684         elm_index_item_append(obj, letter, item);
685         return;
686      }
687    if (!it) return;
688    wd->items = eina_list_append_relative(wd->items, it, it_rel);
689    _index_box_clear(obj, wd->bx[wd->level], wd->level);
690 }
691
692 EAPI void
693 elm_index_item_prepend_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative)
694 {
695    ELM_CHECK_WIDTYPE(obj, widtype);
696    Widget_Data *wd = elm_widget_data_get(obj);
697    Elm_Index_Item *it, *it_rel;
698    if (!wd) return;
699    if (!relative)
700      {
701         elm_index_item_prepend(obj, letter, item);
702         return;
703      }
704    it = _item_new(obj, letter, item);
705    it_rel = _item_find(obj, relative);
706    if (!it_rel)
707      {
708         elm_index_item_append(obj, letter, item);
709         return;
710      }
711    if (!it) return;
712    wd->items = eina_list_prepend_relative(wd->items, it, it_rel);
713    _index_box_clear(obj, wd->bx[wd->level], wd->level);
714 }
715
716 EAPI void
717 elm_index_item_sorted_insert(Evas_Object *obj, const char *letter, const void *item, Eina_Compare_Cb cmp_func, Eina_Compare_Cb cmp_data_func)
718 {
719    ELM_CHECK_WIDTYPE(obj, widtype);
720    Widget_Data *wd = elm_widget_data_get(obj);
721    Eina_List *lnear;
722    Elm_Index_Item *it;
723    int cmp;
724
725    if (!wd) return;
726    if (!(wd->items))
727      {
728         elm_index_item_append(obj, letter, item);
729         return;
730      }
731
732    it = _item_new(obj, letter, item);
733    if (!it) return;
734
735    lnear = eina_list_search_sorted_near_list(wd->items, cmp_func, it, &cmp);
736    if (cmp < 0)
737      wd->items =  eina_list_append_relative_list(wd->items, it, lnear);
738    else if (cmp > 0)
739      wd->items = eina_list_prepend_relative_list(wd->items, it, lnear);
740    else
741      {
742         /* If cmp_data_func is not provided, append a duplicated item */
743         if (!cmp_data_func)
744           wd->items =  eina_list_append_relative_list(wd->items, it, lnear);
745         else
746           {
747              Elm_Index_Item *p_it = eina_list_data_get(lnear);
748              if (cmp_data_func(p_it->base.data, it->base.data) >= 0)
749                p_it->base.data = it->base.data;
750              _item_free(it);
751           }
752      }
753
754    _index_box_clear(obj, wd->bx[wd->level], wd->level);
755 }
756
757 EAPI void
758 elm_index_item_del(Evas_Object *obj, const void *item)
759 {
760    ELM_CHECK_WIDTYPE(obj, widtype);
761    Widget_Data *wd = elm_widget_data_get(obj);
762    Elm_Index_Item *it;
763    if (!wd) return;
764    it = _item_find(obj, item);
765    if (!it) return;
766    _item_free(it);
767    _index_box_clear(obj, wd->bx[wd->level], wd->level);
768 }
769
770 EAPI Elm_Index_Item *
771 elm_index_item_find(Evas_Object *obj, const void *item)
772 {
773    ELM_CHECK_WIDTYPE(obj, widtype) NULL;
774    Widget_Data *wd = elm_widget_data_get(obj);
775    if (!wd) return NULL;
776    return _item_find(obj, item);
777 }
778
779 EAPI void
780 elm_index_item_clear(Evas_Object *obj)
781 {
782    ELM_CHECK_WIDTYPE(obj, widtype);
783    Widget_Data *wd = elm_widget_data_get(obj);
784    Elm_Index_Item *it;
785    Eina_List *l, *clear = NULL;
786    if (!wd) return;
787    _index_box_clear(obj, wd->bx[wd->level], wd->level);
788    EINA_LIST_FOREACH(wd->items, l, it)
789      {
790         if (it->level != wd->level) continue;
791         clear = eina_list_append(clear, it);
792      }
793    EINA_LIST_FREE(clear, it) _item_free(it);
794 }
795
796 EAPI void
797 elm_index_item_go(Evas_Object *obj, int level __UNUSED__)
798 {
799    ELM_CHECK_WIDTYPE(obj, widtype);
800    Widget_Data *wd = elm_widget_data_get(obj);
801    if (!wd) return;
802    _index_box_auto_fill(obj, wd->bx[0], 0);
803    if (wd->level == 1) _index_box_auto_fill(obj, wd->bx[1], 1);
804 }
805
806 EAPI void *
807 elm_index_item_data_get(const Elm_Index_Item *it)
808 {
809    ELM_WIDGET_ITEM_WIDTYPE_CHECK_OR_RETURN(it, NULL);
810    return elm_widget_item_data_get(it);
811 }
812
813 EAPI void
814 elm_index_item_data_set(Elm_Index_Item *it, const void *data)
815 {
816    ELM_WIDGET_ITEM_WIDTYPE_CHECK_OR_RETURN(it);
817    elm_widget_item_data_set(it, data);
818 }
819
820 EAPI void
821 elm_index_item_del_cb_set(Elm_Index_Item *it, Evas_Smart_Cb func)
822 {
823    ELM_WIDGET_ITEM_WIDTYPE_CHECK_OR_RETURN(it);
824    elm_widget_item_del_cb_set(it, func);
825 }
826
827 EAPI const char *
828 elm_index_item_letter_get(const Elm_Index_Item *it)
829 {
830    ELM_WIDGET_ITEM_WIDTYPE_CHECK_OR_RETURN(it, NULL);
831    return it->letter;
832 }
833