Elementary migration around 2011/04/06
[framework/uifw/elementary.git] / src / lib / elc_fileselector_entry.c
1 #include <Elementary.h>
2 #include "elm_priv.h"
3
4  /**
5  * @defgroup File_Selector_Entry File Selector Entry
6  *
7  * An entry that shows to enter/display path and have an associated
8  * button to allow selecting the file from a dialog.
9  *
10  * The button, when clicked, creates an Elementary window (or inner
11  * window) with an Elementary File Selector within. When a file is
12  * chosen, the (inner) window is closed and the selected file is
13  * exposed as an evas_object_smart_callback_call() of the button.
14  */
15
16 typedef struct _Widget_Data Widget_Data;
17
18 struct _Widget_Data
19 {
20    Evas_Object *edje;
21    Evas_Object *button;
22    Evas_Object *entry;
23 };
24
25 static const char *widtype = NULL;
26
27 static const char SIG_CHANGED[] = "changed";
28 static const char SIG_ACTIVATED[] = "activated";
29 static const char SIG_PRESS[] = "press";
30 static const char SIG_LONGPRESSED[] = "longpressed";
31 static const char SIG_CLICKED[] = "clicked";
32 static const char SIG_CLICKED_DOUBLE[] = "clicked,double";
33 static const char SIG_FOCUSED[] = "focused";
34 static const char SIG_UNFOCUSED[] = "unfocused";
35 static const char SIG_SELECTION_PASTE[] = "selection,paste";
36 static const char SIG_SELECTION_COPY[] = "selection,copy";
37 static const char SIG_SELECTION_CUT[] = "selection,cut";
38 static const char SIG_UNPRESSED[] = "unpressed";
39 static const char SIG_FILE_CHOSEN[] = "file,chosen";
40 static const Evas_Smart_Cb_Description _signals[] =
41 {
42   {SIG_CHANGED, ""},
43   {SIG_ACTIVATED, ""},
44   {SIG_PRESS, ""},
45   {SIG_LONGPRESSED, ""},
46   {SIG_CLICKED, ""},
47   {SIG_CLICKED_DOUBLE, ""},
48   {SIG_FOCUSED, ""},
49   {SIG_UNFOCUSED, ""},
50   {SIG_SELECTION_PASTE, ""},
51   {SIG_SELECTION_COPY, ""},
52   {SIG_SELECTION_CUT, ""},
53   {SIG_UNPRESSED, ""},
54   {SIG_FILE_CHOSEN, "s"},
55   {NULL, NULL}
56 };
57
58 #define SIG_FWD(name)                                                    \
59 static void                                                              \
60 _##name##_fwd(void *data, Evas_Object *obj __UNUSED__, void *event_info) \
61 {                                                                        \
62    evas_object_smart_callback_call(data, SIG_##name, event_info);        \
63 }
64 SIG_FWD(CHANGED)
65 SIG_FWD(PRESS)
66 SIG_FWD(LONGPRESSED)
67 SIG_FWD(CLICKED)
68 SIG_FWD(CLICKED_DOUBLE)
69 SIG_FWD(FOCUSED)
70 SIG_FWD(UNFOCUSED)
71 SIG_FWD(SELECTION_PASTE)
72 SIG_FWD(SELECTION_COPY)
73 SIG_FWD(SELECTION_CUT)
74 SIG_FWD(UNPRESSED)
75 #undef SIG_FWD
76
77 static void _mirrored_set(Evas_Object *obj, Eina_Bool rtl);
78
79 static void
80 _FILE_CHOSEN_fwd(void *data, Evas_Object *obj __UNUSED__, void *event_info)
81 {
82    Widget_Data *wd = elm_widget_data_get(data);
83    const char *file = event_info;
84    elm_scrolled_entry_entry_set(wd->entry, file);
85    evas_object_smart_callback_call(data, SIG_FILE_CHOSEN, event_info);
86 }
87
88 static void
89 _ACTIVATED_fwd(void *data, Evas_Object *obj __UNUSED__, void *event_info)
90 {
91    Widget_Data *wd = elm_widget_data_get(data);
92    const char *file = elm_scrolled_entry_entry_get(wd->entry);
93    elm_fileselector_button_path_set(wd->button, file);
94    evas_object_smart_callback_call(data, SIG_ACTIVATED, event_info);
95 }
96
97 static void
98 _del_hook(Evas_Object *obj)
99 {
100    Widget_Data *wd = elm_widget_data_get(obj);
101    free(wd);
102 }
103
104 static void
105 _sizing_eval(Evas_Object *obj)
106 {
107    Widget_Data *wd = elm_widget_data_get(obj);
108    Evas_Coord minw = -1, minh = -1;
109    if (!wd) return;
110    edje_object_size_min_calc(wd->edje, &minw, &minh);
111    evas_object_size_hint_min_set(obj, minw, minh);
112    evas_object_size_hint_max_set(obj, -1, -1);
113 }
114
115 static Eina_Bool
116 _elm_fileselector_entry_focus_next_hook(const Evas_Object *obj, Elm_Focus_Direction dir, Evas_Object **next)
117 {
118    Widget_Data *wd = elm_widget_data_get(obj);
119
120    if (!wd)
121      return EINA_FALSE;
122
123    Evas_Object *chain[2];
124
125    /* Direction */
126    if (dir == ELM_FOCUS_PREVIOUS)
127      {
128         chain[0] = wd->button;
129         chain[1] = wd->entry;
130      }
131    else if (dir == ELM_FOCUS_NEXT)
132      {
133         chain[0] = wd->entry;
134         chain[1] = wd->button;
135      }
136    else
137      return EINA_FALSE;
138
139    unsigned char i = elm_widget_focus_get(chain[1]);
140
141    if (elm_widget_focus_next_get(chain[i], dir, next))
142      return EINA_TRUE;
143
144    i = !i;
145
146    Evas_Object *to_focus;
147    if (elm_widget_focus_next_get(chain[i], dir, &to_focus))
148      {
149         *next = to_focus;
150         return !!i;
151      }
152
153    return EINA_FALSE;
154 }
155
156 static void
157 _mirrored_set(Evas_Object *obj, Eina_Bool rtl)
158 {
159    Widget_Data *wd = elm_widget_data_get(obj);
160    if (!wd) return;
161    elm_widget_mirrored_set(wd->button, rtl);
162    edje_object_mirrored_set(wd->edje, rtl);
163 }
164
165 static void
166 _theme_hook(Evas_Object *obj)
167 {
168    Widget_Data *wd = elm_widget_data_get(obj);
169    const char *style = elm_widget_style_get(obj);
170    char buf[1024];
171
172    if (!wd) return;
173    _elm_widget_mirrored_reload(obj);
174    _mirrored_set(obj, elm_widget_mirrored_get(obj));
175
176    _elm_theme_object_set(obj, wd->edje, "fileselector_entry", "base", style);
177    if (elm_object_disabled_get(obj))
178       edje_object_signal_emit(wd->edje, "elm,state,disabled", "elm");
179
180    if (!style) style = "default";
181    snprintf(buf, sizeof(buf), "fileselector_entry/%s", style);
182    elm_widget_style_set(wd->button, buf);
183    elm_widget_style_set(wd->entry, buf);
184
185    edje_object_part_swallow(obj, "elm.swallow.button", wd->button);
186    edje_object_part_swallow(obj, "elm.swallow.entry", wd->entry);
187
188    edje_object_message_signal_process(wd->edje);
189    edje_object_scale_set
190      (wd->edje, elm_widget_scale_get(obj) * _elm_config->scale);
191    _sizing_eval(obj);
192 }
193
194 static void
195 _disable_hook(Evas_Object *obj)
196 {
197    Widget_Data *wd = elm_widget_data_get(obj);
198    Eina_Bool val = elm_widget_disabled_get(obj);
199    if (!wd) return;
200    if (val)
201      edje_object_signal_emit(wd->edje, "elm,state,disabled", "elm");
202    else
203      edje_object_signal_emit(wd->edje, "elm,state,enabled", "elm");
204
205    elm_widget_disabled_set(wd->button, val);
206    elm_widget_disabled_set(wd->entry, val);
207 }
208
209 static void
210 _changed_size_hints(void *data, Evas *e __UNUSED__, Evas_Object *obj __UNUSED__, void *event_info __UNUSED__)
211 {
212    _sizing_eval(data);
213 }
214
215 /**
216  * Add a new file selector entry into the parent object.
217  *
218  * @param parent The parent object
219  * @return The new object or NULL if it cannot be created
220  *
221  * @ingroup File_Selector_Entry
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
242    wd->edje = edje_object_add(e);
243    _elm_theme_object_set(obj, wd->edje, "fileselector_entry", "base", "default");
244    elm_widget_resize_object_set(obj, wd->edje);
245
246    wd->button = elm_fileselector_button_add(obj);
247    elm_widget_mirrored_automatic_set(wd->button, EINA_FALSE);
248    ELM_SET_WIDTYPE(widtype, "fileselector_entry");
249    elm_widget_style_set(wd->button, "fileselector_entry/default");
250    edje_object_part_swallow(wd->edje, "elm.swallow.button", wd->button);
251    elm_widget_sub_object_add(obj, wd->button);
252    evas_object_event_callback_add
253       (wd->button, EVAS_CALLBACK_CHANGED_SIZE_HINTS, _changed_size_hints, obj);
254    elm_fileselector_button_expandable_set(wd->button,
255                                           _elm_config->fileselector_expand_enable);
256
257 #define SIG_FWD(name)                                                   \
258    evas_object_smart_callback_add(wd->button, SIG_##name, _##name##_fwd, obj)
259    SIG_FWD(CLICKED);
260    SIG_FWD(UNPRESSED);
261    SIG_FWD(FILE_CHOSEN);
262 #undef SIG_FWD
263
264    wd->entry = elm_scrolled_entry_add(obj);
265    elm_widget_mirrored_automatic_set(wd->entry, EINA_FALSE);
266    elm_widget_style_set(wd->entry, "fileselector_entry/default");
267    elm_scrolled_entry_single_line_set(wd->entry, EINA_TRUE);
268    elm_scrolled_entry_editable_set(wd->entry, EINA_TRUE);
269    edje_object_part_swallow(wd->edje, "elm.swallow.entry", wd->entry);
270    elm_widget_sub_object_add(obj, wd->entry);
271    evas_object_event_callback_add
272       (wd->entry, EVAS_CALLBACK_CHANGED_SIZE_HINTS, _changed_size_hints, obj);
273
274 #define SIG_FWD(name)                                                   \
275    evas_object_smart_callback_add(wd->entry, SIG_##name, _##name##_fwd, obj)
276    SIG_FWD(CHANGED);
277    SIG_FWD(ACTIVATED);
278    SIG_FWD(PRESS);
279    SIG_FWD(LONGPRESSED);
280    SIG_FWD(CLICKED);
281    SIG_FWD(CLICKED_DOUBLE);
282    SIG_FWD(FOCUSED);
283    SIG_FWD(UNFOCUSED);
284    SIG_FWD(SELECTION_PASTE);
285    SIG_FWD(SELECTION_COPY);
286    SIG_FWD(SELECTION_CUT);
287 #undef SIG_FWD
288
289    _mirrored_set(obj, elm_widget_mirrored_get(obj));
290    _sizing_eval(obj);
291
292    // TODO: convert Elementary to subclassing of Evas_Smart_Class
293    // TODO: and save some bytes, making descriptions per-class and not instance!
294    evas_object_smart_callbacks_descriptions_set(obj, _signals);
295    return obj;
296 }
297
298 /**
299  * Set the label used in the file selector entry.
300  *
301  * @param obj The entry object
302  * @param label The text label text to be displayed on the entry
303  *
304  * @ingroup File_Selector_Entry
305  */
306 EAPI void
307 elm_fileselector_entry_button_label_set(Evas_Object *obj, const char *label)
308 {
309    ELM_CHECK_WIDTYPE(obj, widtype);
310    Widget_Data *wd = elm_widget_data_get(obj);
311    if (!wd) return;
312    elm_fileselector_button_label_set(wd->button, label);
313 }
314
315 EAPI const char *
316 elm_fileselector_entry_button_label_get(const Evas_Object *obj)
317 {
318    ELM_CHECK_WIDTYPE(obj, widtype) NULL;
319    Widget_Data *wd = elm_widget_data_get(obj);
320    if (!wd) return NULL;
321    return elm_fileselector_button_label_get(wd->button);
322 }
323
324 /**
325  * Set the path to start the entry's file selector with, when clicked.
326  *
327  * @param obj The entry object
328  * @param path Path to a file/directory
329  *
330  * Default path is "HOME" environment variable's value.
331  *
332  * @ingroup File_Selector_Entry
333  */
334 EAPI void
335 elm_fileselector_entry_selected_set(Evas_Object *obj, const char *path)
336 {
337    ELM_CHECK_WIDTYPE(obj, widtype);
338    Widget_Data *wd = elm_widget_data_get(obj);
339    if (!wd) return;
340    elm_fileselector_button_path_set(wd->button, path);
341 }
342
343 /**
344  * Get the <b>last</b> path which the entry's file selector was set to.
345  *
346  * @param obj The entry object
347  * @param path Path to a file/directory
348  *
349  * Default path is "HOME" environment variable's value.
350  *
351  * @ingroup File_Selector_Entry
352  */
353 EAPI const char *
354 elm_fileselector_entry_selected_get(const Evas_Object *obj)
355 {
356    ELM_CHECK_WIDTYPE(obj, widtype) NULL;
357    Widget_Data *wd = elm_widget_data_get(obj);
358    if (!wd) return NULL;
359    return elm_fileselector_button_path_get(wd->button);
360 }
361
362 /**
363  * Set the title of the file selector entry's window.
364  *
365  * @param obj The entry object
366  * @param title The title string
367  *
368  * Note that it will only take any effect if the fileselector entry
369  * not at "inwin mode".
370  *
371  * @ingroup File_Selector_Entry
372  */
373 EAPI void
374 elm_fileselector_entry_window_title_set(Evas_Object *obj, const char *title)
375 {
376    ELM_CHECK_WIDTYPE(obj, widtype);
377    Widget_Data *wd = elm_widget_data_get(obj);
378    if (!wd) return;
379    elm_fileselector_button_window_title_set(wd->button, title);
380 }
381
382 /**
383  * Get the title of the file selector entry's window.
384  *
385  * @param obj The entry object
386  *
387  * @ingroup File_Selector_Entry
388  */
389 EAPI const char *
390 elm_fileselector_entry_window_title_get(const Evas_Object *obj)
391 {
392    ELM_CHECK_WIDTYPE(obj, widtype) NULL;
393    Widget_Data *wd = elm_widget_data_get(obj);
394    if (!wd) return NULL;
395    return elm_fileselector_button_window_title_get(wd->button);
396 }
397
398 /**
399  * Set the size of the file selector entry's window.
400  *
401  * @param obj The entry object
402  * @param width The width
403  * @param height The height
404  *
405  * Note that it will only take any effect if the fileselector entry not at
406  * "inwin mode". Default size for the window (when applicable) is 400x400.
407  *
408  * @ingroup File_Selector_Entry
409  */
410 EAPI void
411 elm_fileselector_entry_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height)
412 {
413    ELM_CHECK_WIDTYPE(obj, widtype);
414    Widget_Data *wd = elm_widget_data_get(obj);
415    if (!wd) return;
416    elm_fileselector_button_window_size_set(wd->button, width, height);
417 }
418
419 /**
420  * Get the size of the file selector entry's window.
421  *
422  * @param obj The entry object
423  * @param width Pointer into which to store the width value
424  * @param height Pointer into which to store the height value
425  *
426  * @ingroup File_Selector_Entry
427  */
428 EAPI void
429 elm_fileselector_entry_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height)
430 {
431    ELM_CHECK_WIDTYPE(obj, widtype);
432    Widget_Data *wd = elm_widget_data_get(obj);
433    if (!wd) return;
434    elm_fileselector_button_window_size_get(wd->button, width, height);
435 }
436
437 /**
438  * Set the starting path of the file selector entry's window.
439  *
440  * @param obj The entry object
441  * @param path The path string
442  *
443  * It must be a <b>directory</b> path.
444  *
445  * @ingroup File_Selector_Entry
446  */
447 EAPI void
448 elm_fileselector_entry_path_set(Evas_Object *obj, const char *path)
449 {
450    ELM_CHECK_WIDTYPE(obj, widtype);
451    Widget_Data *wd = elm_widget_data_get(obj);
452    if (!wd) return;
453    elm_fileselector_button_path_set(wd->button, path);
454    elm_scrolled_entry_entry_set(wd->entry, path);
455 }
456
457 /**
458  * Get the <b>last</b> path of the file selector entry's window.
459  *
460  * @param obj The entry object
461  *
462  * @ingroup File_Selector_Entry
463  */
464 EAPI const char *
465 elm_fileselector_entry_path_get(const Evas_Object *obj)
466 {
467    ELM_CHECK_WIDTYPE(obj, widtype) NULL;
468    Widget_Data *wd = elm_widget_data_get(obj);
469    if (!wd) return NULL;
470    return elm_scrolled_entry_entry_get(wd->entry);
471 }
472
473 /**
474  * Set whether the entry's file selector is to present itself as an
475  * Elementary Generic List (which will expand its entries for nested
476  * directories) or as canonical list, which will be rendered again
477  * with the contents of each selected directory.
478  *
479  * @param obj The entry object
480  * @param value The expandable flag
481  *
482  * @ingroup File_Selector_Entry
483  */
484 EAPI void
485 elm_fileselector_entry_expandable_set(Evas_Object *obj, Eina_Bool value)
486 {
487    ELM_CHECK_WIDTYPE(obj, widtype);
488    Widget_Data *wd = elm_widget_data_get(obj);
489    if (!wd) return;
490    elm_fileselector_button_expandable_set(wd->button, value);
491 }
492
493 /**
494  * Get the entry's file selector expandable flag.
495  *
496  * @param obj The entry object
497  * @return value The expandable flag
498  *
499  * @ingroup File_Selector_Entry
500  */
501 EAPI Eina_Bool
502 elm_fileselector_entry_expandable_get(const Evas_Object *obj)
503 {
504    ELM_CHECK_WIDTYPE(obj, widtype) EINA_FALSE;
505    Widget_Data *wd = elm_widget_data_get(obj);
506    if (!wd) return EINA_FALSE;
507    return elm_fileselector_button_expandable_get(wd->button);
508 }
509
510 /**
511  * Set whether the entry's file selector list is to display folders
512  * only or the directory contents, as well.
513  *
514  * @param obj The entry object
515  * @param value The "folder only" flag
516  *
517  * @ingroup File_Selector_Entry
518  */
519 EAPI void
520 elm_fileselector_entry_folder_only_set(Evas_Object *obj, Eina_Bool value)
521 {
522    ELM_CHECK_WIDTYPE(obj, widtype);
523    Widget_Data *wd = elm_widget_data_get(obj);
524    if (!wd) return;
525    elm_fileselector_button_folder_only_set(wd->button, value);
526 }
527
528 /**
529  * Get the entry's file selector "folder only" flag.
530  *
531  * @param obj The entry object
532  * @return value The "folder only" flag
533  *
534  * @ingroup File_Selector_Entry
535  */
536 EAPI Eina_Bool
537 elm_fileselector_entry_folder_only_get(const Evas_Object *obj)
538 {
539    ELM_CHECK_WIDTYPE(obj, widtype) EINA_FALSE;
540    Widget_Data *wd = elm_widget_data_get(obj);
541    if (!wd) return EINA_FALSE;
542    return elm_fileselector_button_folder_only_get(wd->button);
543 }
544
545 /**
546  * Set whether the entry's file selector has an editable text entry
547  * which will hold its current selection.
548  *
549  * @param obj The entry object
550  * @param value The "is save" flag
551  *
552  * @ingroup File_Selector_Entry
553  */
554 EAPI void
555 elm_fileselector_entry_is_save_set(Evas_Object *obj, Eina_Bool value)
556 {
557    ELM_CHECK_WIDTYPE(obj, widtype);
558    Widget_Data *wd = elm_widget_data_get(obj);
559    if (!wd) return;
560    elm_fileselector_button_is_save_set(wd->button, value);
561 }
562
563 /**
564  * Get the entry's file selector "is save" flag.
565  *
566  * @param obj The entry object
567  * @return value The "is save" flag
568  *
569  * @ingroup File_Selector_Entry
570  */
571 EAPI Eina_Bool
572 elm_fileselector_entry_is_save_get(const Evas_Object *obj)
573 {
574    ELM_CHECK_WIDTYPE(obj, widtype) EINA_FALSE;
575    Widget_Data *wd = elm_widget_data_get(obj);
576    if (!wd) return EINA_FALSE;
577    return elm_fileselector_button_is_save_get(wd->button);
578 }
579
580 /**
581  * Set whether the entry's file selector will raise an Elementary
582  * Inner Window, instead of a dedicated Elementary Window. By default,
583  * it won't.
584  *
585  * @param obj The entry object
586  * @param value The "inwin mode" flag
587  *
588  * @ingroup File_Selector_Entry
589  */
590 EAPI void
591 elm_fileselector_entry_inwin_mode_set(Evas_Object *obj, Eina_Bool value)
592 {
593    ELM_CHECK_WIDTYPE(obj, widtype);
594    Widget_Data *wd = elm_widget_data_get(obj);
595    if (!wd) return;
596    elm_fileselector_button_inwin_mode_set(wd->button, value);
597 }
598
599 /**
600  * Get the entry's file selector "inwin mode" flag.
601  *
602  * @param obj The entry object
603  * @return value The "inwin mode" flag
604  *
605  * @ingroup File_Selector_Entry
606  */
607 EAPI Eina_Bool
608 elm_fileselector_entry_inwin_mode_get(const Evas_Object *obj)
609 {
610    ELM_CHECK_WIDTYPE(obj, widtype) EINA_FALSE;
611    Widget_Data *wd = elm_widget_data_get(obj);
612    if (!wd) return EINA_FALSE;
613    return elm_fileselector_button_inwin_mode_get(wd->button);
614 }
615
616 /**
617  * Set the icon used for the entry button
618  *
619  * Once the icon object is set, a previously set one will be deleted.
620  *
621  * @param obj The entry object
622  * @param icon  The image for the entry
623  *
624  * @ingroup File_Selector_Entry
625  */
626 EAPI void
627 elm_fileselector_entry_button_icon_set(Evas_Object *obj, Evas_Object *icon)
628 {
629    ELM_CHECK_WIDTYPE(obj, widtype);
630    Widget_Data *wd = elm_widget_data_get(obj);
631    if (!wd) return;
632    elm_fileselector_button_icon_set(wd->button, icon);
633 }
634
635 /**
636  * Get the icon used for the entry button
637  *
638  * @param obj The entry object
639  * @return The image for the entry
640  *
641  * @ingroup File_Selector_Entry
642  */
643 EAPI Evas_Object *
644 elm_fileselector_entry_button_icon_get(const Evas_Object *obj)
645 {
646    ELM_CHECK_WIDTYPE(obj, widtype) NULL;
647    Widget_Data *wd = elm_widget_data_get(obj);
648    if (!wd) return NULL;
649    return elm_fileselector_button_icon_get(wd->button);
650 }
651
652 /**
653  * Unset the icon used for the entry button
654  *
655  * Unparent and return the icon object which was set for this widget.
656  *
657  * @param obj The entry object
658  * @return The icon object that was being used
659  *
660  * @ingroup File_Selector_Entry
661  */
662 EAPI Evas_Object *
663 elm_fileselector_entry_button_icon_unset(Evas_Object *obj)
664 {
665    ELM_CHECK_WIDTYPE(obj, widtype) NULL;
666    Widget_Data *wd = elm_widget_data_get(obj);
667    if (!wd) return NULL;
668    return elm_fileselector_button_icon_unset(wd->button);
669 }