add visual feedback on accessibility mouseover too
[framework/uifw/elementary.git] / src / lib / elm_access.c
1 #include <Elementary.h>
2 #include "elm_priv.h"
3
4 typedef struct _Mod_Api Mod_Api;
5
6 struct _Mod_Api
7 {
8    void (*out_read) (const char *txt);
9    void (*out_read_done) (void);
10    void (*out_cancel) (void);
11    void (*out_done_callback_set) (void (*func) (void *data), const void *data);
12 };
13
14 static int initted = 0;
15 static Elm_Module *mod = NULL;
16 static Mod_Api *mapi = NULL;
17
18 static void
19 _access_init(void)
20 {
21    Elm_Module *m;
22    initted++;
23    if (initted > 1) return;
24    if (!(m = _elm_module_find_as("access/api"))) return;
25    mod = m;
26    m->api = malloc(sizeof(Mod_Api));
27    if (!m->api) return;
28    m->init_func(m);
29    ((Mod_Api *)(m->api)      )->out_read = // called to read out some text
30       _elm_module_symbol_get(m, "out_read");
31    ((Mod_Api *)(m->api)      )->out_read_done = // called to set a done marker so when it is reached the done callback is called
32       _elm_module_symbol_get(m, "out_read_done");
33    ((Mod_Api *)(m->api)      )->out_cancel = // called to read out some text
34       _elm_module_symbol_get(m, "out_cancel");
35    ((Mod_Api *)(m->api)      )->out_done_callback_set = // called when last read done
36       _elm_module_symbol_get(m, "out_done_callback_set");
37    mapi = m->api;
38 }
39
40 static Elm_Access_Item *
41 _access_add_set(Elm_Access_Info *ac, int type)
42 {
43    Elm_Access_Item *ai;
44    Eina_List *l;
45
46    if (!ac) return NULL;
47    EINA_LIST_FOREACH(ac->items, l, ai)
48      {
49         if (ai->type == type)
50           {
51              if (!ai->func)
52                {
53                   if (ai->data) eina_stringshare_del(ai->data);
54                }
55              ai->func = NULL;
56              ai->data = NULL;
57              return ai;
58           }
59      }
60    ai = calloc(1, sizeof(Elm_Access_Item));
61    ai->type = type;
62    ac->items = eina_list_prepend(ac->items, ai);
63    return ai;
64 }
65
66 static Eina_Bool
67 _access_obj_over_timeout_cb(void *data)
68 {
69    Elm_Access_Info *ac = evas_object_data_get(data, "_elm_access");
70    if (!ac) return EINA_FALSE;
71    if (_elm_config->access_mode != ELM_ACCESS_MODE_OFF)
72      {
73         _elm_access_object_hilight(data);
74         _elm_access_read(ac, ELM_ACCESS_CANCEL, data, NULL);
75         _elm_access_read(ac, ELM_ACCESS_TYPE,   data, NULL);
76         _elm_access_read(ac, ELM_ACCESS_INFO,   data, NULL);
77         _elm_access_read(ac, ELM_ACCESS_STATE,  data, NULL);
78         _elm_access_read(ac, ELM_ACCESS_DONE,   data, NULL);
79      }
80    ac->delay_timer = NULL;
81    return EINA_FALSE;
82 }
83
84 static void
85 _access_obj_mouse_in_cb(void *data, Evas *e __UNUSED__, Evas_Object *obj __UNUSED__, void *event_info  __UNUSED__)
86 {
87    Elm_Access_Info *ac = evas_object_data_get(data, "_elm_access");
88    if (!ac) return;
89
90    if (ac->delay_timer)
91      {
92         ecore_timer_del(ac->delay_timer);
93         ac->delay_timer = NULL;
94      }
95    if (_elm_config->access_mode != ELM_ACCESS_MODE_OFF)
96       ac->delay_timer = ecore_timer_add(0.2, _access_obj_over_timeout_cb, data);
97 }
98
99 static void
100 _access_obj_mouse_out_cb(void *data, Evas *e __UNUSED__, Evas_Object *obj __UNUSED__, void *event_info __UNUSED__)
101 {
102    Elm_Access_Info *ac = evas_object_data_get(data, "_elm_access");
103    if (!ac) return;
104    _elm_access_object_unhilight(data);
105    if (ac->delay_timer)
106      {
107         ecore_timer_del(ac->delay_timer);
108         ac->delay_timer = NULL;
109      }
110 }
111
112 static void
113 _access_obj_del_cb(void *data, Evas *e __UNUSED__, Evas_Object *obj, void *event_info __UNUSED__)
114 {
115    Elm_Access_Info *ac;
116
117    evas_object_event_callback_del_full(obj, EVAS_CALLBACK_MOUSE_IN,
118                                        _access_obj_mouse_in_cb, data);
119    evas_object_event_callback_del_full(obj, EVAS_CALLBACK_MOUSE_OUT,
120                                        _access_obj_mouse_out_cb, data);
121    evas_object_event_callback_del_full(obj, EVAS_CALLBACK_DEL,
122                                        _access_obj_del_cb, data);
123    ac = evas_object_data_get(data, "_elm_access");
124    evas_object_data_del(data, "_elm_access");
125    if (ac)
126      {
127         _elm_access_clear(ac);
128         free(ac);
129      }
130 }
131
132 static void
133 _access_read_done(void *data __UNUSED__)
134 {
135    printf("read done\n");
136 }
137
138 //-------------------------------------------------------------------------//
139
140 EAPI void
141 _elm_access_clear(Elm_Access_Info *ac)
142 {
143    Elm_Access_Item *ai;
144
145    if (!ac) return;
146    if (ac->delay_timer)
147      {
148         ecore_timer_del(ac->delay_timer);
149         ac->delay_timer = NULL;
150      }
151    EINA_LIST_FREE(ac->items, ai)
152      {
153         if (!ai->func)
154           {
155              if (ai->data) eina_stringshare_del(ai->data);
156           }
157         free(ai);
158      }
159 }
160
161 EAPI void
162 _elm_access_text_set(Elm_Access_Info *ac, int type, const char *text)
163 {
164    Elm_Access_Item *ai = _access_add_set(ac, type);
165    if (!ai) return;
166    ai->data = eina_stringshare_add(text);
167 }
168
169 EAPI void
170 _elm_access_callback_set(Elm_Access_Info *ac, int type, Elm_Access_Content_Cb func, const void *data)
171 {
172    Elm_Access_Item *ai = _access_add_set(ac, type);
173    if (!ai) return;
174    ai->func = func;
175    ai->data = data;
176 }
177
178 EAPI char *
179 _elm_access_text_get(Elm_Access_Info *ac, int type, Evas_Object *obj, Elm_Widget_Item *item)
180 {
181    Elm_Access_Item *ai;
182    Eina_List *l;
183
184    if (!ac) return NULL;
185    EINA_LIST_FOREACH(ac->items, l, ai)
186      {
187         if (ai->type == type)
188           {
189              if (ai->func) return ai->func((void *)(ai->data), obj, item);
190              else if (ai->data) return strdup(ai->data);
191              return NULL;
192           }
193      }
194    return NULL;
195 }
196
197 EAPI void
198 _elm_access_read(Elm_Access_Info *ac, int type, Evas_Object *obj, Elm_Widget_Item *item)
199 {
200    char *txt = _elm_access_text_get(ac, type, obj, item);
201
202    _access_init();
203    if (mapi)
204      {
205         if (mapi->out_done_callback_set)
206            mapi->out_done_callback_set(_access_read_done, NULL);
207         if (type == ELM_ACCESS_DONE)
208           {
209              if (mapi->out_read_done) mapi->out_read_done();
210           }
211         else if (type == ELM_ACCESS_CANCEL)
212           {
213              if (mapi->out_cancel) mapi->out_cancel();
214           }
215         else
216           {
217              if (txt)
218                {
219                   if (mapi->out_read) mapi->out_read(txt);
220                   if (mapi->out_read) mapi->out_read(".\n");
221                }
222           }
223      }
224    if (txt) free(txt);
225 }
226
227 EAPI void
228 _elm_access_say(const char *txt)
229 {
230    _access_init();
231    if (mapi)
232      {
233         if (mapi->out_done_callback_set)
234            mapi->out_done_callback_set(_access_read_done, NULL);
235         if (mapi->out_cancel) mapi->out_cancel();
236         if (txt)
237           {
238              if (mapi->out_read) mapi->out_read(txt);
239              if (mapi->out_read) mapi->out_read(".\n");
240           }
241         if (mapi->out_read_done) mapi->out_read_done();
242      }
243 }
244
245 EAPI Elm_Access_Info *
246 _elm_access_object_get(Evas_Object *obj)
247 {
248    return evas_object_data_get(obj, "_elm_access");
249 }
250
251 EAPI void
252 _elm_access_object_hilight(Evas_Object *obj)
253 {
254    Evas_Object *o;
255    
256    o = evas_object_name_find(evas_object_evas_get(obj), "_elm_access_disp");
257    if (!o)
258      {
259         o = edje_object_add(evas_object_evas_get(obj));
260         evas_object_name_set(o, "_elm_access_disp");
261         evas_object_layer_set(o, ELM_OBJECT_LAYER_TOOLTIP);
262      }
263    else
264      {
265         Evas_Object *ptarget = evas_object_data_get(o, "_elm_access_target");
266         if (ptarget)
267           {
268              evas_object_data_del(o, "_elm_access_target");
269              // FIXME: delete move/resize/del callbacks from ptarget
270           }
271      }
272    evas_object_data_set(o, "_elm_access_target", obj);
273    // FIXME: track obj pos/size until hilight removed
274    _elm_theme_object_set(obj, o, "access", "base", "default");
275    evas_object_raise(o);
276
277      {
278         Evas_Coord x, y, w, h;
279         evas_object_geometry_get(obj, &x, &y, &w, &h);
280         evas_object_move(o, x, y);
281         evas_object_resize(o, w, h);
282      }
283    
284    evas_object_show(o);
285    // if hilight obj doesnt exist - create and attach to window
286    // make sure its on a high layer
287    // show it and emit signal
288    // if exists, move and resize to obj object location
289    // ** try use dragables to specify pos+size??
290 }
291
292 EAPI void
293 _elm_access_object_unhilight(Evas_Object *obj)
294 {
295    Evas_Object *o, *ptarget;
296    
297    o = evas_object_name_find(evas_object_evas_get(obj), "_elm_access_disp");
298    if (!o) return;
299    ptarget = evas_object_data_get(o, "_elm_access_target");
300    if (ptarget == obj) evas_object_del(o);
301 }
302
303 EAPI void
304 _elm_access_object_register(Evas_Object *obj, Evas_Object *hoverobj)
305 {
306    Elm_Access_Info *ac;
307
308    evas_object_event_callback_add(hoverobj, EVAS_CALLBACK_MOUSE_IN,
309                                   _access_obj_mouse_in_cb, obj);
310    evas_object_event_callback_add(hoverobj, EVAS_CALLBACK_MOUSE_OUT,
311                                   _access_obj_mouse_out_cb, obj);
312    evas_object_event_callback_add(hoverobj, EVAS_CALLBACK_DEL,
313                                   _access_obj_del_cb, obj);
314    ac = calloc(1, sizeof(Elm_Access_Info));
315    evas_object_data_set(obj, "_elm_access", ac);
316 }
317
318 static void
319 _access_2nd_click_del_cb(void *data __UNUSED__, Evas *e __UNUSED__, Evas_Object *obj, void *event_info __UNUSED__)
320 {
321    Ecore_Timer *t;
322
323    evas_object_event_callback_del_full(obj, EVAS_CALLBACK_DEL,
324                                        _access_2nd_click_del_cb, NULL);
325    t = evas_object_data_get(obj, "_elm_2nd_timeout");
326    if (t)
327      {
328         ecore_timer_del(t);
329         evas_object_data_del(obj, "_elm_2nd_timeout");
330      }
331 }
332
333 static Eina_Bool
334 _access_2nd_click_timeout_cb(void *data)
335 {
336    evas_object_event_callback_del_full(data, EVAS_CALLBACK_DEL,
337                                        _access_2nd_click_del_cb, NULL);
338    evas_object_data_del(data, "_elm_2nd_timeout");
339    return EINA_FALSE;
340 }
341
342 EAPI Eina_Bool
343 _elm_access_2nd_click_timeout(Evas_Object *obj)
344 {
345    Ecore_Timer *t;
346
347    t = evas_object_data_get(obj, "_elm_2nd_timeout");
348    if (t)
349      {
350         ecore_timer_del(t);
351         evas_object_data_del(obj, "_elm_2nd_timeout");
352         evas_object_event_callback_del_full(obj, EVAS_CALLBACK_DEL,
353                                             _access_2nd_click_del_cb, NULL);
354         return EINA_TRUE;
355      }
356    t = ecore_timer_add(0.3, _access_2nd_click_timeout_cb, obj);
357    evas_object_data_set(obj, "_elm_2nd_timeout", t);
358    evas_object_event_callback_add(obj, EVAS_CALLBACK_DEL,
359                                   _access_2nd_click_del_cb, NULL);
360    return EINA_FALSE;
361 }
362
363 // XXX special version for items
364 //EAPI void
365 //_elm_access_item_hover_register(Elm_Widget_Item *item, Evas_Object *hoverobj)
366 //{
367 //}