1 #include <Elementary.h>
5 * @defgroup File_Selector_Entry File Selector Entry
7 * An entry that shows to enter/display path and have an associated
8 * button to allow selecting the file from a dialog.
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.
16 typedef struct _Widget_Data Widget_Data;
25 static const char *widtype = NULL;
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[] =
45 {SIG_LONGPRESSED, ""},
47 {SIG_CLICKED_DOUBLE, ""},
50 {SIG_SELECTION_PASTE, ""},
51 {SIG_SELECTION_COPY, ""},
52 {SIG_SELECTION_CUT, ""},
54 {SIG_FILE_CHOSEN, "s"},
58 #define SIG_FWD(name) \
60 _##name##_fwd(void *data, Evas_Object *obj __UNUSED__, void *event_info) \
62 evas_object_smart_callback_call(data, SIG_##name, event_info); \
68 SIG_FWD(CLICKED_DOUBLE)
71 SIG_FWD(SELECTION_PASTE)
72 SIG_FWD(SELECTION_COPY)
73 SIG_FWD(SELECTION_CUT)
77 static void _mirrored_set(Evas_Object *obj, Eina_Bool rtl);
80 _FILE_CHOSEN_fwd(void *data, Evas_Object *obj __UNUSED__, void *event_info)
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);
89 _ACTIVATED_fwd(void *data, Evas_Object *obj __UNUSED__, void *event_info)
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);
98 _del_hook(Evas_Object *obj)
100 Widget_Data *wd = elm_widget_data_get(obj);
105 _sizing_eval(Evas_Object *obj)
107 Widget_Data *wd = elm_widget_data_get(obj);
108 Evas_Coord minw = -1, minh = -1;
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);
116 _elm_fileselector_entry_focus_next_hook(const Evas_Object *obj, Elm_Focus_Direction dir, Evas_Object **next)
118 Widget_Data *wd = elm_widget_data_get(obj);
123 Evas_Object *chain[2];
126 if (dir == ELM_FOCUS_PREVIOUS)
128 chain[0] = wd->button;
129 chain[1] = wd->entry;
131 else if (dir == ELM_FOCUS_NEXT)
133 chain[0] = wd->entry;
134 chain[1] = wd->button;
139 unsigned char i = elm_widget_focus_get(chain[1]);
141 if (elm_widget_focus_next_get(chain[i], dir, next))
146 Evas_Object *to_focus;
147 if (elm_widget_focus_next_get(chain[i], dir, &to_focus))
157 _mirrored_set(Evas_Object *obj, Eina_Bool rtl)
159 Widget_Data *wd = elm_widget_data_get(obj);
161 elm_widget_mirrored_set(wd->button, rtl);
162 edje_object_mirrored_set(wd->edje, rtl);
166 _theme_hook(Evas_Object *obj)
168 Widget_Data *wd = elm_widget_data_get(obj);
169 const char *style = elm_widget_style_get(obj);
173 _elm_widget_mirrored_reload(obj);
174 _mirrored_set(obj, elm_widget_mirrored_get(obj));
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");
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);
185 edje_object_part_swallow(obj, "elm.swallow.button", wd->button);
186 edje_object_part_swallow(obj, "elm.swallow.entry", wd->entry);
188 edje_object_message_signal_process(wd->edje);
189 edje_object_scale_set
190 (wd->edje, elm_widget_scale_get(obj) * _elm_config->scale);
195 _disable_hook(Evas_Object *obj)
197 Widget_Data *wd = elm_widget_data_get(obj);
198 Eina_Bool val = elm_widget_disabled_get(obj);
201 edje_object_signal_emit(wd->edje, "elm,state,disabled", "elm");
203 edje_object_signal_emit(wd->edje, "elm,state,enabled", "elm");
205 elm_widget_disabled_set(wd->button, val);
206 elm_widget_disabled_set(wd->entry, val);
210 _changed_size_hints(void *data, Evas *e __UNUSED__, Evas_Object *obj __UNUSED__, void *event_info __UNUSED__)
216 * Add a new file selector entry into the parent object.
218 * @param parent The parent object
219 * @return The new object or NULL if it cannot be created
221 * @ingroup File_Selector_Entry
224 elm_fileselector_entry_add(Evas_Object *parent)
227 Evas *e = evas_object_evas_get(parent);
231 EINA_SAFETY_ON_NULL_RETURN_VAL(parent, NULL);
233 wd = ELM_NEW(Widget_Data);
235 obj = elm_widget_add(e);
236 ELM_SET_WIDTYPE(widtype, "fileselector_entry");
237 elm_widget_type_set(obj, "fileselector_entry");
238 elm_widget_sub_object_add(parent, obj);
239 elm_widget_data_set(obj, wd);
240 elm_widget_del_hook_set(obj, _del_hook);
241 elm_widget_disable_hook_set(obj, _disable_hook);
242 elm_widget_focus_next_hook_set(obj, _elm_fileselector_entry_focus_next_hook);
243 elm_widget_can_focus_set(obj, EINA_FALSE);
244 elm_widget_theme_hook_set(obj, _theme_hook);
246 wd->edje = edje_object_add(e);
247 _elm_theme_object_set(obj, wd->edje, "fileselector_entry", "base", "default");
248 elm_widget_resize_object_set(obj, wd->edje);
250 wd->button = elm_fileselector_button_add(obj);
251 elm_widget_mirrored_automatic_set(wd->button, EINA_FALSE);
252 ELM_SET_WIDTYPE(widtype, "fileselector_entry");
253 elm_widget_style_set(wd->button, "fileselector_entry/default");
254 edje_object_part_swallow(wd->edje, "elm.swallow.button", wd->button);
255 elm_widget_sub_object_add(obj, wd->button);
256 evas_object_event_callback_add
257 (wd->button, EVAS_CALLBACK_CHANGED_SIZE_HINTS, _changed_size_hints, obj);
258 elm_fileselector_button_expandable_set(wd->button,
259 _elm_config->fileselector_expand_enable);
261 #define SIG_FWD(name) \
262 evas_object_smart_callback_add(wd->button, SIG_##name, _##name##_fwd, obj)
265 SIG_FWD(FILE_CHOSEN);
268 wd->entry = elm_scrolled_entry_add(obj);
269 elm_widget_mirrored_automatic_set(wd->entry, EINA_FALSE);
270 elm_widget_style_set(wd->entry, "fileselector_entry/default");
271 elm_scrolled_entry_single_line_set(wd->entry, EINA_TRUE);
272 elm_scrolled_entry_editable_set(wd->entry, EINA_TRUE);
273 edje_object_part_swallow(wd->edje, "elm.swallow.entry", wd->entry);
274 elm_widget_sub_object_add(obj, wd->entry);
275 evas_object_event_callback_add
276 (wd->entry, EVAS_CALLBACK_CHANGED_SIZE_HINTS, _changed_size_hints, obj);
278 #define SIG_FWD(name) \
279 evas_object_smart_callback_add(wd->entry, SIG_##name, _##name##_fwd, obj)
283 SIG_FWD(LONGPRESSED);
285 SIG_FWD(CLICKED_DOUBLE);
288 SIG_FWD(SELECTION_PASTE);
289 SIG_FWD(SELECTION_COPY);
290 SIG_FWD(SELECTION_CUT);
293 _mirrored_set(obj, elm_widget_mirrored_get(obj));
296 // TODO: convert Elementary to subclassing of Evas_Smart_Class
297 // TODO: and save some bytes, making descriptions per-class and not instance!
298 evas_object_smart_callbacks_descriptions_set(obj, _signals);
303 * Set the label used in the file selector entry.
305 * @param obj The entry object
306 * @param label The text label text to be displayed on the entry
308 * @ingroup File_Selector_Entry
311 elm_fileselector_entry_button_label_set(Evas_Object *obj, const char *label)
313 ELM_CHECK_WIDTYPE(obj, widtype);
314 Widget_Data *wd = elm_widget_data_get(obj);
316 elm_fileselector_button_label_set(wd->button, label);
320 elm_fileselector_entry_button_label_get(const Evas_Object *obj)
322 ELM_CHECK_WIDTYPE(obj, widtype) NULL;
323 Widget_Data *wd = elm_widget_data_get(obj);
324 if (!wd) return NULL;
325 return elm_fileselector_button_label_get(wd->button);
329 * Set the path to start the entry's file selector with, when clicked.
331 * @param obj The entry object
332 * @param path Path to a file/directory
334 * Default path is "HOME" environment variable's value.
336 * @ingroup File_Selector_Entry
339 elm_fileselector_entry_selected_set(Evas_Object *obj, const char *path)
341 ELM_CHECK_WIDTYPE(obj, widtype);
342 Widget_Data *wd = elm_widget_data_get(obj);
344 elm_fileselector_button_path_set(wd->button, path);
348 * Get the <b>last</b> path which the entry's file selector was set to.
350 * @param obj The entry object
351 * @param path Path to a file/directory
353 * Default path is "HOME" environment variable's value.
355 * @ingroup File_Selector_Entry
358 elm_fileselector_entry_selected_get(const Evas_Object *obj)
360 ELM_CHECK_WIDTYPE(obj, widtype) NULL;
361 Widget_Data *wd = elm_widget_data_get(obj);
362 if (!wd) return NULL;
363 return elm_fileselector_button_path_get(wd->button);
367 * Set the title of the file selector entry's window.
369 * @param obj The entry object
370 * @param title The title string
372 * Note that it will only take any effect if the fileselector entry
373 * not at "inwin mode".
375 * @ingroup File_Selector_Entry
378 elm_fileselector_entry_window_title_set(Evas_Object *obj, const char *title)
380 ELM_CHECK_WIDTYPE(obj, widtype);
381 Widget_Data *wd = elm_widget_data_get(obj);
383 elm_fileselector_button_window_title_set(wd->button, title);
387 * Get the title of the file selector entry's window.
389 * @param obj The entry object
391 * @ingroup File_Selector_Entry
394 elm_fileselector_entry_window_title_get(const Evas_Object *obj)
396 ELM_CHECK_WIDTYPE(obj, widtype) NULL;
397 Widget_Data *wd = elm_widget_data_get(obj);
398 if (!wd) return NULL;
399 return elm_fileselector_button_window_title_get(wd->button);
403 * Set the size of the file selector entry's window.
405 * @param obj The entry object
406 * @param width The width
407 * @param height The height
409 * Note that it will only take any effect if the fileselector entry not at
410 * "inwin mode". Default size for the window (when applicable) is 400x400.
412 * @ingroup File_Selector_Entry
415 elm_fileselector_entry_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height)
417 ELM_CHECK_WIDTYPE(obj, widtype);
418 Widget_Data *wd = elm_widget_data_get(obj);
420 elm_fileselector_button_window_size_set(wd->button, width, height);
424 * Get the size of the file selector entry's window.
426 * @param obj The entry object
427 * @param width Pointer into which to store the width value
428 * @param height Pointer into which to store the height value
430 * @ingroup File_Selector_Entry
433 elm_fileselector_entry_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height)
435 ELM_CHECK_WIDTYPE(obj, widtype);
436 Widget_Data *wd = elm_widget_data_get(obj);
438 elm_fileselector_button_window_size_get(wd->button, width, height);
442 * Set the starting path of the file selector entry's window.
444 * @param obj The entry object
445 * @param path The path string
447 * It must be a <b>directory</b> path.
449 * @ingroup File_Selector_Entry
452 elm_fileselector_entry_path_set(Evas_Object *obj, const char *path)
454 ELM_CHECK_WIDTYPE(obj, widtype);
455 Widget_Data *wd = elm_widget_data_get(obj);
457 elm_fileselector_button_path_set(wd->button, path);
458 elm_scrolled_entry_entry_set(wd->entry, path);
462 * Get the <b>last</b> path of the file selector entry's window.
464 * @param obj The entry object
466 * @ingroup File_Selector_Entry
469 elm_fileselector_entry_path_get(const Evas_Object *obj)
471 ELM_CHECK_WIDTYPE(obj, widtype) NULL;
472 Widget_Data *wd = elm_widget_data_get(obj);
473 if (!wd) return NULL;
474 return elm_scrolled_entry_entry_get(wd->entry);
478 * Set whether the entry's file selector is to present itself as an
479 * Elementary Generic List (which will expand its entries for nested
480 * directories) or as canonical list, which will be rendered again
481 * with the contents of each selected directory.
483 * @param obj The entry object
484 * @param value The expandable flag
486 * @ingroup File_Selector_Entry
489 elm_fileselector_entry_expandable_set(Evas_Object *obj, Eina_Bool value)
491 ELM_CHECK_WIDTYPE(obj, widtype);
492 Widget_Data *wd = elm_widget_data_get(obj);
494 elm_fileselector_button_expandable_set(wd->button, value);
498 * Get the entry's file selector expandable flag.
500 * @param obj The entry object
501 * @return value The expandable flag
503 * @ingroup File_Selector_Entry
506 elm_fileselector_entry_expandable_get(const Evas_Object *obj)
508 ELM_CHECK_WIDTYPE(obj, widtype) EINA_FALSE;
509 Widget_Data *wd = elm_widget_data_get(obj);
510 if (!wd) return EINA_FALSE;
511 return elm_fileselector_button_expandable_get(wd->button);
515 * Set whether the entry's file selector list is to display folders
516 * only or the directory contents, as well.
518 * @param obj The entry object
519 * @param value The "folder only" flag
521 * @ingroup File_Selector_Entry
524 elm_fileselector_entry_folder_only_set(Evas_Object *obj, Eina_Bool value)
526 ELM_CHECK_WIDTYPE(obj, widtype);
527 Widget_Data *wd = elm_widget_data_get(obj);
529 elm_fileselector_button_folder_only_set(wd->button, value);
533 * Get the entry's file selector "folder only" flag.
535 * @param obj The entry object
536 * @return value The "folder only" flag
538 * @ingroup File_Selector_Entry
541 elm_fileselector_entry_folder_only_get(const Evas_Object *obj)
543 ELM_CHECK_WIDTYPE(obj, widtype) EINA_FALSE;
544 Widget_Data *wd = elm_widget_data_get(obj);
545 if (!wd) return EINA_FALSE;
546 return elm_fileselector_button_folder_only_get(wd->button);
550 * Set whether the entry's file selector has an editable text entry
551 * which will hold its current selection.
553 * @param obj The entry object
554 * @param value The "is save" flag
556 * @ingroup File_Selector_Entry
559 elm_fileselector_entry_is_save_set(Evas_Object *obj, Eina_Bool value)
561 ELM_CHECK_WIDTYPE(obj, widtype);
562 Widget_Data *wd = elm_widget_data_get(obj);
564 elm_fileselector_button_is_save_set(wd->button, value);
568 * Get the entry's file selector "is save" flag.
570 * @param obj The entry object
571 * @return value The "is save" flag
573 * @ingroup File_Selector_Entry
576 elm_fileselector_entry_is_save_get(const Evas_Object *obj)
578 ELM_CHECK_WIDTYPE(obj, widtype) EINA_FALSE;
579 Widget_Data *wd = elm_widget_data_get(obj);
580 if (!wd) return EINA_FALSE;
581 return elm_fileselector_button_is_save_get(wd->button);
585 * Set whether the entry's file selector will raise an Elementary
586 * Inner Window, instead of a dedicated Elementary Window. By default,
589 * @param obj The entry object
590 * @param value The "inwin mode" flag
592 * @ingroup File_Selector_Entry
595 elm_fileselector_entry_inwin_mode_set(Evas_Object *obj, Eina_Bool value)
597 ELM_CHECK_WIDTYPE(obj, widtype);
598 Widget_Data *wd = elm_widget_data_get(obj);
600 elm_fileselector_button_inwin_mode_set(wd->button, value);
604 * Get the entry's file selector "inwin mode" flag.
606 * @param obj The entry object
607 * @return value The "inwin mode" flag
609 * @ingroup File_Selector_Entry
612 elm_fileselector_entry_inwin_mode_get(const Evas_Object *obj)
614 ELM_CHECK_WIDTYPE(obj, widtype) EINA_FALSE;
615 Widget_Data *wd = elm_widget_data_get(obj);
616 if (!wd) return EINA_FALSE;
617 return elm_fileselector_button_inwin_mode_get(wd->button);
621 * Set the icon used for the entry button
623 * Once the icon object is set, a previously set one will be deleted.
625 * @param obj The entry object
626 * @param icon The image for the entry
628 * @ingroup File_Selector_Entry
631 elm_fileselector_entry_button_icon_set(Evas_Object *obj, Evas_Object *icon)
633 ELM_CHECK_WIDTYPE(obj, widtype);
634 Widget_Data *wd = elm_widget_data_get(obj);
636 elm_fileselector_button_icon_set(wd->button, icon);
640 * Get the icon used for the entry button
642 * @param obj The entry object
643 * @return The image for the entry
645 * @ingroup File_Selector_Entry
648 elm_fileselector_entry_button_icon_get(const Evas_Object *obj)
650 ELM_CHECK_WIDTYPE(obj, widtype) NULL;
651 Widget_Data *wd = elm_widget_data_get(obj);
652 if (!wd) return NULL;
653 return elm_fileselector_button_icon_get(wd->button);
657 * Unset the icon used for the entry button
659 * Unparent and return the icon object which was set for this widget.
661 * @param obj The entry object
662 * @return The icon object that was being used
664 * @ingroup File_Selector_Entry
667 elm_fileselector_entry_button_icon_unset(Evas_Object *obj)
669 ELM_CHECK_WIDTYPE(obj, widtype) NULL;
670 Widget_Data *wd = elm_widget_data_get(obj);
671 if (!wd) return NULL;
672 return elm_fileselector_button_icon_unset(wd->button);