[elementary] Documenting/exemplifying file selector
[framework/uifw/elementary.git] / src / lib / elc_fileselector_entry.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 *edje;
9    Evas_Object *button;
10    Evas_Object *entry;
11 };
12
13 static const char *widtype = NULL;
14
15 static const char SIG_CHANGED[] = "changed";
16 static const char SIG_ACTIVATED[] = "activated";
17 static const char SIG_PRESS[] = "press";
18 static const char SIG_LONGPRESSED[] = "longpressed";
19 static const char SIG_CLICKED[] = "clicked";
20 static const char SIG_CLICKED_DOUBLE[] = "clicked,double";
21 static const char SIG_FOCUSED[] = "focused";
22 static const char SIG_UNFOCUSED[] = "unfocused";
23 static const char SIG_SELECTION_PASTE[] = "selection,paste";
24 static const char SIG_SELECTION_COPY[] = "selection,copy";
25 static const char SIG_SELECTION_CUT[] = "selection,cut";
26 static const char SIG_UNPRESSED[] = "unpressed";
27 static const char SIG_FILE_CHOSEN[] = "file,chosen";
28 static const Evas_Smart_Cb_Description _signals[] =
29 {
30   {SIG_CHANGED, ""},
31   {SIG_ACTIVATED, ""},
32   {SIG_PRESS, ""},
33   {SIG_LONGPRESSED, ""},
34   {SIG_CLICKED, ""},
35   {SIG_CLICKED_DOUBLE, ""},
36   {SIG_FOCUSED, ""},
37   {SIG_UNFOCUSED, ""},
38   {SIG_SELECTION_PASTE, ""},
39   {SIG_SELECTION_COPY, ""},
40   {SIG_SELECTION_CUT, ""},
41   {SIG_UNPRESSED, ""},
42   {SIG_FILE_CHOSEN, "s"},
43   {NULL, NULL}
44 };
45
46 #define SIG_FWD(name)                                                    \
47 static void                                                              \
48 _##name##_fwd(void *data, Evas_Object *obj __UNUSED__, void *event_info) \
49 {                                                                        \
50    evas_object_smart_callback_call(data, SIG_##name, event_info);        \
51 }
52 SIG_FWD(CHANGED)
53 SIG_FWD(PRESS)
54 SIG_FWD(LONGPRESSED)
55 SIG_FWD(CLICKED)
56 SIG_FWD(CLICKED_DOUBLE)
57 SIG_FWD(FOCUSED)
58 SIG_FWD(UNFOCUSED)
59 SIG_FWD(SELECTION_PASTE)
60 SIG_FWD(SELECTION_COPY)
61 SIG_FWD(SELECTION_CUT)
62 SIG_FWD(UNPRESSED)
63 #undef SIG_FWD
64
65 static void _mirrored_set(Evas_Object *obj, Eina_Bool rtl);
66
67 static void
68 _FILE_CHOSEN_fwd(void *data, Evas_Object *obj __UNUSED__, void *event_info)
69 {
70    Widget_Data *wd = elm_widget_data_get(data);
71    const char *file = event_info;
72    elm_entry_entry_set(wd->entry, file);
73    evas_object_smart_callback_call(data, SIG_FILE_CHOSEN, event_info);
74 }
75
76 static void
77 _ACTIVATED_fwd(void *data, Evas_Object *obj __UNUSED__, void *event_info)
78 {
79    Widget_Data *wd = elm_widget_data_get(data);
80    const char *file = elm_entry_entry_get(wd->entry);
81    elm_fileselector_button_path_set(wd->button, file);
82    evas_object_smart_callback_call(data, SIG_ACTIVATED, event_info);
83 }
84
85 static void
86 _del_hook(Evas_Object *obj)
87 {
88    Widget_Data *wd = elm_widget_data_get(obj);
89    free(wd);
90 }
91
92 static void
93 _sizing_eval(Evas_Object *obj)
94 {
95    Widget_Data *wd = elm_widget_data_get(obj);
96    Evas_Coord minw = -1, minh = -1;
97    if (!wd) return;
98    edje_object_size_min_calc(wd->edje, &minw, &minh);
99    evas_object_size_hint_min_set(obj, minw, minh);
100    evas_object_size_hint_max_set(obj, -1, -1);
101 }
102
103 static Eina_Bool
104 _elm_fileselector_entry_focus_next_hook(const Evas_Object *obj, Elm_Focus_Direction dir, Evas_Object **next)
105 {
106    Widget_Data *wd = elm_widget_data_get(obj);
107
108    if (!wd)
109      return EINA_FALSE;
110
111    Evas_Object *chain[2];
112
113    /* Direction */
114    if (dir == ELM_FOCUS_PREVIOUS)
115      {
116         chain[0] = wd->button;
117         chain[1] = wd->entry;
118      }
119    else if (dir == ELM_FOCUS_NEXT)
120      {
121         chain[0] = wd->entry;
122         chain[1] = wd->button;
123      }
124    else
125      return EINA_FALSE;
126
127    unsigned char i = elm_widget_focus_get(chain[1]);
128
129    if (elm_widget_focus_next_get(chain[i], dir, next))
130      return EINA_TRUE;
131
132    i = !i;
133
134    Evas_Object *to_focus;
135    if (elm_widget_focus_next_get(chain[i], dir, &to_focus))
136      {
137         *next = to_focus;
138         return !!i;
139      }
140
141    return EINA_FALSE;
142 }
143
144 static void
145 _mirrored_set(Evas_Object *obj, Eina_Bool rtl)
146 {
147    Widget_Data *wd = elm_widget_data_get(obj);
148    if (!wd) return;
149    elm_widget_mirrored_set(wd->button, rtl);
150    edje_object_mirrored_set(wd->edje, rtl);
151 }
152
153 static void
154 _theme_hook(Evas_Object *obj)
155 {
156    Widget_Data *wd = elm_widget_data_get(obj);
157    const char *style = elm_widget_style_get(obj);
158    char buf[1024];
159
160    if (!wd) return;
161    _elm_widget_mirrored_reload(obj);
162    _mirrored_set(obj, elm_widget_mirrored_get(obj));
163
164    _elm_theme_object_set(obj, wd->edje, "fileselector_entry", "base", style);
165    if (elm_object_disabled_get(obj))
166       edje_object_signal_emit(wd->edje, "elm,state,disabled", "elm");
167
168    if (!style) style = "default";
169    snprintf(buf, sizeof(buf), "fileselector_entry/%s", style);
170    elm_widget_style_set(wd->button, buf);
171    elm_widget_style_set(wd->entry, buf);
172
173    edje_object_part_swallow(obj, "elm.swallow.button", wd->button);
174    edje_object_part_swallow(obj, "elm.swallow.entry", wd->entry);
175
176    edje_object_message_signal_process(wd->edje);
177    edje_object_scale_set
178      (wd->edje, elm_widget_scale_get(obj) * _elm_config->scale);
179    _sizing_eval(obj);
180 }
181
182 static void
183 _disable_hook(Evas_Object *obj)
184 {
185    Widget_Data *wd = elm_widget_data_get(obj);
186    Eina_Bool val = elm_widget_disabled_get(obj);
187    if (!wd) return;
188    if (val)
189      edje_object_signal_emit(wd->edje, "elm,state,disabled", "elm");
190    else
191      edje_object_signal_emit(wd->edje, "elm,state,enabled", "elm");
192
193    elm_widget_disabled_set(wd->button, val);
194    elm_widget_disabled_set(wd->entry, val);
195 }
196
197 static void
198 _changed_size_hints(void *data, Evas *e __UNUSED__, Evas_Object *obj __UNUSED__, void *event_info __UNUSED__)
199 {
200    _sizing_eval(data);
201 }
202
203 static void
204 _elm_fileselector_entry_button_label_set(Evas_Object *obj, const char *item, const char *label)
205 {
206    ELM_CHECK_WIDTYPE(obj, widtype);
207    Widget_Data *wd = elm_widget_data_get(obj);
208    if (item && strcmp(item, "default")) return;
209    if (!wd) return;
210    elm_object_text_set(wd->button, label);
211 }
212
213 static const char *
214 _elm_fileselector_entry_button_label_get(const Evas_Object *obj, const char *item)
215 {
216    ELM_CHECK_WIDTYPE(obj, widtype) NULL;
217    Widget_Data *wd = elm_widget_data_get(obj);
218    if (item && strcmp(item, "default")) return NULL;
219    if (!wd) return NULL;
220    return elm_object_text_get(wd->button);
221 }
222
223 EAPI Evas_Object *
224 elm_fileselector_entry_add(Evas_Object *parent)
225 {
226    Evas_Object *obj;
227    Evas *e;
228    Widget_Data *wd;
229
230    ELM_WIDGET_STANDARD_SETUP(wd, Widget_Data, parent, e, obj, NULL);
231
232    ELM_SET_WIDTYPE(widtype, "fileselector_entry");
233    elm_widget_type_set(obj, "fileselector_entry");
234    elm_widget_sub_object_add(parent, obj);
235    elm_widget_data_set(obj, wd);
236    elm_widget_del_hook_set(obj, _del_hook);
237    elm_widget_disable_hook_set(obj, _disable_hook);
238    elm_widget_focus_next_hook_set(obj, _elm_fileselector_entry_focus_next_hook);
239    elm_widget_can_focus_set(obj, EINA_FALSE);
240    elm_widget_theme_hook_set(obj, _theme_hook);
241    elm_widget_text_set_hook_set(obj, _elm_fileselector_entry_button_label_set);
242    elm_widget_text_get_hook_set(obj, _elm_fileselector_entry_button_label_get);
243
244    wd->edje = edje_object_add(e);
245    _elm_theme_object_set(obj, wd->edje, "fileselector_entry", "base", "default");
246    elm_widget_resize_object_set(obj, wd->edje);
247
248    wd->button = elm_fileselector_button_add(obj);
249    elm_widget_mirrored_automatic_set(wd->button, EINA_FALSE);
250    ELM_SET_WIDTYPE(widtype, "fileselector_entry");
251    elm_widget_style_set(wd->button, "fileselector_entry/default");
252    edje_object_part_swallow(wd->edje, "elm.swallow.button", wd->button);
253    elm_widget_sub_object_add(obj, wd->button);
254    evas_object_event_callback_add
255       (wd->button, EVAS_CALLBACK_CHANGED_SIZE_HINTS, _changed_size_hints, obj);
256    elm_fileselector_button_expandable_set(wd->button,
257                                           _elm_config->fileselector_expand_enable);
258
259 #define SIG_FWD(name)                                                   \
260    evas_object_smart_callback_add(wd->button, SIG_##name, _##name##_fwd, obj)
261    SIG_FWD(CLICKED);
262    SIG_FWD(UNPRESSED);
263    SIG_FWD(FILE_CHOSEN);
264 #undef SIG_FWD
265
266    wd->entry = elm_entry_add(obj);
267    elm_entry_scrollable_set(wd->entry, EINA_TRUE);
268    elm_widget_mirrored_automatic_set(wd->entry, EINA_FALSE);
269    elm_widget_style_set(wd->entry, "fileselector_entry/default");
270    elm_entry_single_line_set(wd->entry, EINA_TRUE);
271    elm_entry_editable_set(wd->entry, EINA_TRUE);
272    edje_object_part_swallow(wd->edje, "elm.swallow.entry", wd->entry);
273    elm_widget_sub_object_add(obj, wd->entry);
274    evas_object_event_callback_add
275       (wd->entry, EVAS_CALLBACK_CHANGED_SIZE_HINTS, _changed_size_hints, obj);
276
277 #define SIG_FWD(name)                                                   \
278    evas_object_smart_callback_add(wd->entry, SIG_##name, _##name##_fwd, obj)
279    SIG_FWD(CHANGED);
280    SIG_FWD(ACTIVATED);
281    SIG_FWD(PRESS);
282    SIG_FWD(LONGPRESSED);
283    SIG_FWD(CLICKED);
284    SIG_FWD(CLICKED_DOUBLE);
285    SIG_FWD(FOCUSED);
286    SIG_FWD(UNFOCUSED);
287    SIG_FWD(SELECTION_PASTE);
288    SIG_FWD(SELECTION_COPY);
289    SIG_FWD(SELECTION_CUT);
290 #undef SIG_FWD
291
292    _mirrored_set(obj, elm_widget_mirrored_get(obj));
293    _sizing_eval(obj);
294
295    // TODO: convert Elementary to subclassing of Evas_Smart_Class
296    // TODO: and save some bytes, making descriptions per-class and not instance!
297    evas_object_smart_callbacks_descriptions_set(obj, _signals);
298    return obj;
299 }
300
301 EAPI void
302 elm_fileselector_entry_button_label_set(Evas_Object *obj, const char *label)
303 {
304    _elm_fileselector_entry_button_label_set(obj, NULL, label);
305 }
306
307 EAPI const char *
308 elm_fileselector_entry_button_label_get(const Evas_Object *obj)
309 {
310    return _elm_fileselector_entry_button_label_get(obj, NULL);
311 }
312
313 EAPI void
314 elm_fileselector_entry_selected_set(Evas_Object *obj, const char *path)
315 {
316    ELM_CHECK_WIDTYPE(obj, widtype);
317    Widget_Data *wd = elm_widget_data_get(obj);
318    if (!wd) return;
319    elm_fileselector_button_path_set(wd->button, path);
320 }
321
322 EAPI const char *
323 elm_fileselector_entry_selected_get(const Evas_Object *obj)
324 {
325    ELM_CHECK_WIDTYPE(obj, widtype) NULL;
326    Widget_Data *wd = elm_widget_data_get(obj);
327    if (!wd) return NULL;
328    return elm_fileselector_button_path_get(wd->button);
329 }
330
331 EAPI void
332 elm_fileselector_entry_window_title_set(Evas_Object *obj, const char *title)
333 {
334    ELM_CHECK_WIDTYPE(obj, widtype);
335    Widget_Data *wd = elm_widget_data_get(obj);
336    if (!wd) return;
337    elm_fileselector_button_window_title_set(wd->button, title);
338 }
339
340 EAPI const char *
341 elm_fileselector_entry_window_title_get(const Evas_Object *obj)
342 {
343    ELM_CHECK_WIDTYPE(obj, widtype) NULL;
344    Widget_Data *wd = elm_widget_data_get(obj);
345    if (!wd) return NULL;
346    return elm_fileselector_button_window_title_get(wd->button);
347 }
348
349 EAPI void
350 elm_fileselector_entry_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height)
351 {
352    ELM_CHECK_WIDTYPE(obj, widtype);
353    Widget_Data *wd = elm_widget_data_get(obj);
354    if (!wd) return;
355    elm_fileselector_button_window_size_set(wd->button, width, height);
356 }
357
358 EAPI void
359 elm_fileselector_entry_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height)
360 {
361    ELM_CHECK_WIDTYPE(obj, widtype);
362    Widget_Data *wd = elm_widget_data_get(obj);
363    if (!wd) return;
364    elm_fileselector_button_window_size_get(wd->button, width, height);
365 }
366
367 EAPI void
368 elm_fileselector_entry_path_set(Evas_Object *obj, const char *path)
369 {
370    ELM_CHECK_WIDTYPE(obj, widtype);
371    Widget_Data *wd = elm_widget_data_get(obj);
372    if (!wd) return;
373    elm_fileselector_button_path_set(wd->button, path);
374    elm_entry_entry_set(wd->entry, path);
375 }
376
377 EAPI const char *
378 elm_fileselector_entry_path_get(const Evas_Object *obj)
379 {
380    ELM_CHECK_WIDTYPE(obj, widtype) NULL;
381    Widget_Data *wd = elm_widget_data_get(obj);
382    if (!wd) return NULL;
383    return elm_entry_entry_get(wd->entry);
384 }
385
386 EAPI void
387 elm_fileselector_entry_expandable_set(Evas_Object *obj, Eina_Bool value)
388 {
389    ELM_CHECK_WIDTYPE(obj, widtype);
390    Widget_Data *wd = elm_widget_data_get(obj);
391    if (!wd) return;
392    elm_fileselector_button_expandable_set(wd->button, value);
393 }
394
395 EAPI Eina_Bool
396 elm_fileselector_entry_expandable_get(const Evas_Object *obj)
397 {
398    ELM_CHECK_WIDTYPE(obj, widtype) EINA_FALSE;
399    Widget_Data *wd = elm_widget_data_get(obj);
400    if (!wd) return EINA_FALSE;
401    return elm_fileselector_button_expandable_get(wd->button);
402 }
403
404 EAPI void
405 elm_fileselector_entry_folder_only_set(Evas_Object *obj, Eina_Bool value)
406 {
407    ELM_CHECK_WIDTYPE(obj, widtype);
408    Widget_Data *wd = elm_widget_data_get(obj);
409    if (!wd) return;
410    elm_fileselector_button_folder_only_set(wd->button, value);
411 }
412
413 EAPI Eina_Bool
414 elm_fileselector_entry_folder_only_get(const Evas_Object *obj)
415 {
416    ELM_CHECK_WIDTYPE(obj, widtype) EINA_FALSE;
417    Widget_Data *wd = elm_widget_data_get(obj);
418    if (!wd) return EINA_FALSE;
419    return elm_fileselector_button_folder_only_get(wd->button);
420 }
421
422 EAPI void
423 elm_fileselector_entry_is_save_set(Evas_Object *obj, Eina_Bool value)
424 {
425    ELM_CHECK_WIDTYPE(obj, widtype);
426    Widget_Data *wd = elm_widget_data_get(obj);
427    if (!wd) return;
428    elm_fileselector_button_is_save_set(wd->button, value);
429 }
430
431 EAPI Eina_Bool
432 elm_fileselector_entry_is_save_get(const Evas_Object *obj)
433 {
434    ELM_CHECK_WIDTYPE(obj, widtype) EINA_FALSE;
435    Widget_Data *wd = elm_widget_data_get(obj);
436    if (!wd) return EINA_FALSE;
437    return elm_fileselector_button_is_save_get(wd->button);
438 }
439
440 EAPI void
441 elm_fileselector_entry_inwin_mode_set(Evas_Object *obj, Eina_Bool value)
442 {
443    ELM_CHECK_WIDTYPE(obj, widtype);
444    Widget_Data *wd = elm_widget_data_get(obj);
445    if (!wd) return;
446    elm_fileselector_button_inwin_mode_set(wd->button, value);
447 }
448
449 EAPI Eina_Bool
450 elm_fileselector_entry_inwin_mode_get(const Evas_Object *obj)
451 {
452    ELM_CHECK_WIDTYPE(obj, widtype) EINA_FALSE;
453    Widget_Data *wd = elm_widget_data_get(obj);
454    if (!wd) return EINA_FALSE;
455    return elm_fileselector_button_inwin_mode_get(wd->button);
456 }
457
458 EAPI void
459 elm_fileselector_entry_button_icon_set(Evas_Object *obj, Evas_Object *icon)
460 {
461    ELM_CHECK_WIDTYPE(obj, widtype);
462    Widget_Data *wd = elm_widget_data_get(obj);
463    if (!wd) return;
464    elm_fileselector_button_icon_set(wd->button, icon);
465 }
466
467 EAPI Evas_Object *
468 elm_fileselector_entry_button_icon_get(const Evas_Object *obj)
469 {
470    ELM_CHECK_WIDTYPE(obj, widtype) NULL;
471    Widget_Data *wd = elm_widget_data_get(obj);
472    if (!wd) return NULL;
473    return elm_fileselector_button_icon_get(wd->button);
474 }
475
476 EAPI Evas_Object *
477 elm_fileselector_entry_button_icon_unset(Evas_Object *obj)
478 {
479    ELM_CHECK_WIDTYPE(obj, widtype) NULL;
480    Widget_Data *wd = elm_widget_data_get(obj);
481    if (!wd) return NULL;
482    return elm_fileselector_button_icon_unset(wd->button);
483 }