elementary: add elm_genlist_item_index_get.
[framework/uifw/elementary.git] / src / lib / elm_genlist.h
1 #ifndef ELM_GEN_H_
2 # define ELM_GEN_H_
3
4 #include <Elementary.h>
5 #include <Elementary_Cursor.h>
6 #include "elm_priv.h"
7
8 #define ELM_GEN_ITEM_FROM_INLIST(it) \
9    ((it) ? EINA_INLIST_CONTAINER_GET(it, Elm_Gen_Item) : NULL)
10
11 #define SWIPE_MOVES         12
12
13 typedef struct Elm_Gen_Item_Type Elm_Gen_Item_Type;
14 typedef struct Elm_Gen_Item_Tooltip Elm_Gen_Item_Tooltip;
15 typedef struct _Widget_Data Widget_Data;
16
17 typedef enum _Elm_Genlist_Item_Scrollto_Type
18   {
19      ELM_GENLIST_ITEM_SCROLLTO_NONE = 0, /**< no scrollto */
20      ELM_GENLIST_ITEM_SCROLLTO_IN = (1 << 0), /**< show, bring in */
21      ELM_GENLIST_ITEM_SCROLLTO_TOP = (1 << 1), /**< top show, top bring in */
22      ELM_GENLIST_ITEM_SCROLLTO_MIDDLE = (1 << 2) /**< middle show, middle bring in */
23   } Elm_Genlist_Item_Scrollto_Type;
24
25 struct Elm_Gen_Item_Tooltip
26 {
27    const void                 *data;
28    Elm_Tooltip_Item_Content_Cb content_cb;
29    Evas_Smart_Cb               del_cb;
30    const char                 *style;
31    Eina_Bool                   free_size : 1;
32 };
33
34 struct Elm_Gen_Item
35 {
36    ELM_WIDGET_ITEM;
37    EINA_INLIST;
38    Widget_Data                  *wd;
39    Elm_Gen_Item_Type            *item;
40    const Elm_Gen_Item_Class     *itc;
41    Evas_Coord                    x, y, dx, dy;
42    Evas_Object                  *spacer;
43    Elm_Gen_Item                 *parent;
44    Eina_List                    *texts, *contents, *states, *content_objs;
45    Ecore_Timer                  *long_timer;
46    int                           relcount;
47    int                           walking;
48    int                           generation; /* a generation of an item. when the item is created, this value is set to the value of genlist generation. this value will be decreased when the item is going to be deleted */
49    const char                   *mouse_cursor;
50
51    struct
52    {
53       Evas_Smart_Cb func;
54       const void   *data;
55    } func;
56
57    Elm_Gen_Item_Tooltip tooltip;
58    Ecore_Cb    del_cb, sel_cb, highlight_cb;
59    Ecore_Cb    unsel_cb, unhighlight_cb, unrealize_cb;
60
61    int         position;
62
63    Eina_Bool   position_update : 1;
64    Eina_Bool   want_unrealize : 1;
65    Eina_Bool   display_only : 1;
66    Eina_Bool   realized : 1;
67    Eina_Bool   selected : 1;
68    Eina_Bool   highlighted : 1;
69    Eina_Bool   disabled : 1;
70    Eina_Bool   dragging : 1;
71    Eina_Bool   down : 1;
72    Eina_Bool   group : 1;
73    Eina_Bool   reorder : 1;
74    Eina_Bool   mode_set : 1; /* item uses style mode for highlight/select */
75 };
76
77 typedef struct _Pan Pan;
78 struct _Pan
79 {
80    Evas_Object_Smart_Clipped_Data  __clipped_data;
81    Widget_Data                    *wd;
82    Ecore_Job                      *resize_job;
83 };
84
85 struct _Widget_Data
86 {
87    Eina_Inlist_Sorted_State *state;
88    Evas_Object      *obj; /* the genlist object */
89    Evas_Object      *scr; /* a smart scroller object which is used internally in genlist */
90    Evas_Object      *pan_smart; /* "elm_genlist_pan" evas smart object. this is an extern pan of smart scroller(scr). */
91    Eina_List        *selected;
92    Eina_List        *group_items; /* list of groups index items */
93    Eina_Inlist      *items; /* inlist of all items */
94    Elm_Gen_Item     *reorder_it; /* item currently being repositioned */
95    Elm_Gen_Item     *last_selected_item;
96    Pan              *pan; /* pan_smart object's smart data */
97    Ecore_Job        *calc_job;
98    int               walking;
99    int               item_width, item_height;
100    int               group_item_width, group_item_height;
101    int               minw, minh;
102    long              count;
103    Evas_Coord        pan_x, pan_y;
104    Eina_Bool         reorder_mode : 1; /* a flag for reorder mode enable/disable */
105    Eina_Bool         on_hold : 1;
106    Eina_Bool         multi : 1; /* a flag for item multi selection */
107    Eina_Bool         no_select : 1;
108    Eina_Bool         wasselected : 1;
109    Eina_Bool         always_select : 1;
110    Eina_Bool         clear_me : 1; /* a flag whether genlist is marked as to be cleared or not. if this flag is true, genlist clear was already deferred.  */
111    Eina_Bool         h_bounce : 1;
112    Eina_Bool         v_bounce : 1;
113    Ecore_Cb          del_cb, calc_cb, sizing_cb;
114    Ecore_Cb          clear_cb;
115    ////////////////////////////////////
116    Eina_Inlist      *blocks; /* inlist of all blocks. a block consists of a certain number of items. maximum number of items in a block is 'max_items_per_block'. */
117    Evas_Coord        reorder_old_pan_y, w, h, realminw, prev_viewport_w;
118    Ecore_Job        *update_job;
119    Ecore_Idle_Enterer *queue_idle_enterer;
120    Ecore_Idler        *must_recalc_idler;
121    Eina_List        *queue;
122    Elm_Gen_Item     *show_item, *anchor_item, *mode_item, *reorder_rel, *expanded_item;
123    Eina_Inlist      *item_cache; /* an inlist of edje object it cache. */
124    Evas_Coord        anchor_y;
125    Evas_Coord        reorder_start_y; /* reorder it's initial y coordinate in the pan. */
126    Elm_List_Mode     mode;
127    Ecore_Timer      *multi_timer, *scr_hold_timer;
128    Ecore_Animator   *reorder_move_animator;
129    const char       *mode_type;
130    const char       *mode_item_style;
131    unsigned int      start_time;
132    Evas_Coord        prev_x, prev_y, prev_mx, prev_my;
133    Evas_Coord        cur_x, cur_y, cur_mx, cur_my;
134    Eina_Bool         mouse_down : 1;
135    Eina_Bool         multi_down : 1;
136    Eina_Bool         multi_timeout : 1;
137    Eina_Bool         multitouched : 1;
138    Eina_Bool         longpressed : 1;
139    Eina_Bool         bring_in : 1; /* a flag to describe the scroll animation. (show, bring in) */
140    Eina_Bool         compress : 1;
141    Eina_Bool         height_for_width : 1;
142    Eina_Bool         homogeneous : 1;
143    Eina_Bool         swipe : 1;
144    Eina_Bool         reorder_pan_move : 1;
145    Eina_Bool         auto_scroll_enabled : 1;
146    Eina_Bool         pan_changed : 1;
147    Eina_Bool         requeued : 1; /* this is set to EINA_TRUE when the item is re-queued. this happens when the item is un-queued but the rel item is still in the queue. this item will be processed later. */
148    Eina_Bool         check_scroll : 1; /* this flag means genlist is supposed to be scrolled. if this flag is set to EINA_TRUE, genlist checks whether it's ok to scroll genlist now or not. */
149    struct
150    {
151       Evas_Coord x, y;
152    } history[SWIPE_MOVES];
153    int               multi_device;
154    int               item_cache_count;
155    int               item_cache_max; /* maximum number of cached items */
156    int               movements;
157    int               max_items_per_block; /* maximum number of items per block */
158    double            longpress_timeout; /* longpress timeout. this value comes from _elm_config by default. this can be changed by elm_genlist_longpress_timeout_set() */
159    int               generation; /* a generation of genlist. when genlist is cleared, this value will be increased and a new generation will start */
160    Eina_Compare_Cb   item_compare_cb;
161    Eina_Compare_Cb   item_compare_data_cb;
162    Elm_Genlist_Item_Scrollto_Type scrollto_type; /* a scrollto type which remembers where to scroll ex) in, top, middle */
163
164    /* The stuff below directly come from gengrid without any thinking */
165    unsigned int      nmax;
166    Evas_Coord        reorder_item_x, reorder_item_y;
167    Evas_Coord        old_pan_x, old_pan_y;
168    long              items_lost;
169    double            align_x, align_y;
170
171    Eina_Bool         horizontal : 1;
172    Eina_Bool         move_effect_enabled : 1;
173    Eina_Bool         reorder_item_changed : 1;
174 };
175
176 Elm_Gen_Item *
177 _elm_genlist_item_new(Widget_Data              *wd,
178                       const Elm_Gen_Item_Class *itc,
179                       const void               *data,
180                       Elm_Gen_Item             *parent,
181                       Evas_Smart_Cb             func,
182                       const void               *func_data);
183
184 Evas_Object *
185 _elm_genlist_item_widget_get(const Elm_Gen_Item *it);
186
187 void
188 _elm_genlist_page_relative_set(Evas_Object *obj,
189                                double       h_pagerel,
190                                double       v_pagerel);
191
192 void
193 _elm_genlist_page_relative_get(const Evas_Object *obj,
194                                double            *h_pagerel,
195                                double            *v_pagerel);
196
197 void
198 _elm_genlist_page_size_set(Evas_Object *obj,
199                            Evas_Coord   h_pagesize,
200                            Evas_Coord   v_pagesize);
201
202 void
203 _elm_genlist_current_page_get(const Evas_Object *obj,
204                               int               *h_pagenumber,
205                               int               *v_pagenumber);
206
207 void
208 _elm_genlist_last_page_get(const Evas_Object *obj,
209                            int               *h_pagenumber,
210                            int               *v_pagenumber);
211
212 void
213 _elm_genlist_page_show(const Evas_Object *obj,
214                        int                h_pagenumber,
215                        int                v_pagenumber);
216
217 void
218 _elm_genlist_page_bring_in(const Evas_Object *obj,
219                            int                h_pagenumber,
220                            int                v_pagenumber);
221
222 void
223 _elm_genlist_item_unrealize(Elm_Gen_Item *it,
224                             Eina_Bool     calc);
225 void
226 _elm_genlist_item_del_serious(Elm_Gen_Item *it);
227
228 void
229 _elm_genlist_item_del_notserious(Elm_Gen_Item *it);
230
231 #endif