2 * @defgroup File_Selector_Entry File Selector Entry
5 * @image html fileselector_entry_inheritance_tree.png
6 * @image latex fileselector_entry_inheritance_tree.eps
8 * @image html img/widget/fileselector_entry/preview-00.png
9 * @image latex img/widget/fileselector_entry/preview-00.eps
11 * This is an entry made to be filled with or display a <b>file
12 * system path string</b>. Besides the entry itself, the widget has
13 * a @ref File_Selector_Button "file selector button" on its side,
14 * which will raise an internal @ref Fileselector "file selector widget",
15 * when clicked, for path selection aided by file system
18 * This file selector may appear in an Elementary window or in an
19 * inner window. When a file is chosen from it, the (inner) window
20 * is closed and the selected file's path string is exposed both as
21 * a smart event and as the new text on the entry.
23 * This widget inherits from the @ref Layout one, so that all the
24 * functions acting on it also work for file selector entry objects
27 * This widget encapsulates operations on its internal file
28 * selector on its own API. There is less control over its file
29 * selector than that one would have instantiating one directly.
31 * Smart callbacks one can register to:
32 * - @c "changed" - The text within the entry was changed
33 * - @c "activated" - The entry has had editing finished and
34 * changes are to be "committed"
35 * - @c "press" - The entry has been clicked
36 * - @c "longpressed" - The entry has been clicked (and held) for a
38 * - @c "clicked" - The entry has been clicked
39 * - @c "clicked,double" - The entry has been double clicked
40 * - @c "focused" - The entry has received focus
41 * - @c "unfocused" - The entry has lost focus
42 * - @c "selection,paste" - A paste action has occurred on the
44 * - @c "selection,copy" - A copy action has occurred on the entry
45 * - @c "selection,cut" - A cut action has occurred on the entry
46 * - @c "unpressed" - The file selector entry's button was released
47 * after being pressed.
48 * - @c "file,chosen" - The user has selected a path via the file
49 * selector entry's internal file selector, whose string pointer
50 * comes as the @c event_info data (a stringshared string)
52 * Default text parts of the fileselector_button widget that you can use for
54 * @li "default" - Label of the fileselector_button
56 * Default content parts of the fileselector_entry widget that you can use for
58 * @li "button icon" - Button icon of the fileselector_entry
60 * Supported elm_object common APIs.
61 * @li @ref elm_object_part_text_set
62 * @li @ref elm_object_part_text_get
63 * @li @ref elm_object_part_content_set
64 * @li @ref elm_object_part_content_get
65 * @li @ref elm_object_part_content_unset
66 * @li @ref elm_object_disabled_set
67 * @li @ref elm_object_disabled_get
69 * Here is an example on its usage:
70 * @li @ref fileselector_entry_example
72 * @see @ref File_Selector_Button for a similar widget.
77 * Add a new file selector entry widget to the given parent
78 * Elementary (container) object
80 * @param parent The parent object
81 * @return a new file selector entry widget handle or @c NULL, on
84 * @ingroup File_Selector_Entry
86 EAPI Evas_Object *elm_fileselector_entry_add(Evas_Object *parent);
89 * Set the title for a given file selector entry widget's window
91 * @param obj The file selector entry widget
92 * @param title The title string
94 * This will change the window's title, when the file selector pops
95 * out after a click on the entry's button. Those windows have the
96 * default (unlocalized) value of @c "Select a file" as titles.
98 * @note It will only take any effect if the file selector
99 * entry widget is @b not under "inwin mode".
101 * @see elm_fileselector_entry_window_title_get()
103 * @ingroup File_Selector_Entry
105 EAPI void elm_fileselector_entry_window_title_set(Evas_Object *obj, const char *title);
108 * Get the title set for a given file selector entry widget's
111 * @param obj The file selector entry widget
112 * @return Title of the file selector entry's window
114 * @see elm_fileselector_entry_window_title_get() for more details
116 * @ingroup File_Selector_Entry
118 EAPI const char *elm_fileselector_entry_window_title_get(const Evas_Object *obj);
121 * Set the size of a given file selector entry widget's window,
122 * holding the file selector itself.
124 * @param obj The file selector entry widget
125 * @param width The window's width
126 * @param height The window's height
128 * @note it will only take any effect if the file selector entry
129 * widget is @b not under "inwin mode". The default size for the
130 * window (when applicable) is 400x400 pixels.
132 * @see elm_fileselector_entry_window_size_get()
134 * @ingroup File_Selector_Entry
136 EAPI void elm_fileselector_entry_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height);
139 * Get the size of a given file selector entry widget's window,
140 * holding the file selector itself.
142 * @param obj The file selector entry widget
143 * @param width Pointer into which to store the width value
144 * @param height Pointer into which to store the height value
146 * @note Use @c NULL pointers on the size values you're not
147 * interested in: they'll be ignored by the function.
149 * @see elm_fileselector_entry_window_size_set(), for more details
151 * @ingroup File_Selector_Entry
153 EAPI void elm_fileselector_entry_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height);
156 * Set the initial file system path and the entry's path string for
157 * a given file selector entry widget
159 * @param obj The file selector entry widget
160 * @param path The path string
162 * It must be a <b>directory</b> path, which will have the contents
163 * displayed initially in the file selector's view, when invoked
164 * from @p obj. The default initial path is the @c "HOME"
165 * environment variable's value.
167 * @see elm_fileselector_entry_path_get()
169 * @ingroup File_Selector_Entry
171 EAPI void elm_fileselector_entry_path_set(Evas_Object *obj, const char *path);
174 * Get the entry's path string for a given file selector entry
177 * @param obj The file selector entry widget
178 * @return path The path string
180 * @see elm_fileselector_entry_path_set() for more details
182 * @ingroup File_Selector_Entry
184 EAPI const char *elm_fileselector_entry_path_get(const Evas_Object *obj);
187 * Enable/disable a tree view in the given file selector entry
188 * widget's internal file selector
190 * @param obj The file selector entry widget
191 * @param value @c EINA_TRUE to enable tree view, @c EINA_FALSE to disable
193 * This has the same effect as elm_fileselector_expandable_set(),
194 * but now applied to a file selector entry's internal file
197 * @note There's no way to put a file selector entry's internal
198 * file selector in "grid mode", as one may do with "pure" file
201 * @see elm_fileselector_expandable_get()
203 * @ingroup File_Selector_Entry
205 EAPI void elm_fileselector_entry_expandable_set(Evas_Object *obj, Eina_Bool value);
208 * Get whether tree view is enabled for the given file selector
209 * entry widget's internal file selector
211 * @param obj The file selector entry widget
212 * @return @c EINA_TRUE if @p obj widget's internal file selector
213 * is in tree view, @c EINA_FALSE otherwise (and or errors)
215 * @see elm_fileselector_expandable_set() for more details
217 * @ingroup File_Selector_Entry
219 EAPI Eina_Bool elm_fileselector_entry_expandable_get(const Evas_Object *obj);
222 * Set whether a given file selector entry widget's internal file
223 * selector is to display folders only or the directory contents,
226 * @param obj The file selector entry widget
227 * @param value @c EINA_TRUE to make @p obj widget's internal file
228 * selector only display directories, @c EINA_FALSE to make files
229 * to be displayed in it too
231 * This has the same effect as elm_fileselector_folder_only_set(),
232 * but now applied to a file selector entry's internal file
235 * @see elm_fileselector_folder_only_get()
237 * @ingroup File_Selector_Entry
239 EAPI void elm_fileselector_entry_folder_only_set(Evas_Object *obj, Eina_Bool value);
242 * Get whether a given file selector entry widget's internal file
243 * selector is displaying folders only or the directory contents,
246 * @param obj The file selector entry widget
247 * @return @c EINA_TRUE if @p obj widget's internal file
248 * selector is only displaying directories, @c EINA_FALSE if files
249 * are being displayed in it too (and on errors)
251 * @see elm_fileselector_entry_folder_only_set() for more details
253 * @ingroup File_Selector_Entry
255 EAPI Eina_Bool elm_fileselector_entry_folder_only_get(const Evas_Object *obj);
258 * Enable/disable the file name entry box where the user can type
259 * in a name for a file, in a given file selector entry widget's
260 * internal file selector.
262 * @param obj The file selector entry widget
263 * @param value @c EINA_TRUE to make @p obj widget's internal
264 * file selector a "saving dialog", @c EINA_FALSE otherwise
266 * This has the same effect as elm_fileselector_is_save_set(),
267 * but now applied to a file selector entry's internal file
270 * @see elm_fileselector_is_save_get()
272 * @ingroup File_Selector_Entry
274 EAPI void elm_fileselector_entry_is_save_set(Evas_Object *obj, Eina_Bool value);
277 * Get whether the given file selector entry widget's internal
278 * file selector is in "saving dialog" mode
280 * @param obj The file selector entry widget
281 * @return @c EINA_TRUE, if @p obj widget's internal file selector
282 * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
285 * @see elm_fileselector_entry_is_save_set() for more details
287 * @ingroup File_Selector_Entry
289 EAPI Eina_Bool elm_fileselector_entry_is_save_get(const Evas_Object *obj);
292 * Set whether a given file selector entry widget's internal file
293 * selector will raise an Elementary "inner window", instead of a
294 * dedicated Elementary window. By default, it won't.
296 * @param obj The file selector entry widget
297 * @param value @c EINA_TRUE to make it use an inner window, @c
298 * EINA_TRUE to make it use a dedicated window
300 * @see elm_win_inwin_add() for more information on inner windows
301 * @see elm_fileselector_entry_inwin_mode_get()
303 * @ingroup File_Selector_Entry
305 EAPI void elm_fileselector_entry_inwin_mode_set(Evas_Object *obj, Eina_Bool value);
308 * Get whether a given file selector entry widget's internal file
309 * selector will raise an Elementary "inner window", instead of a
310 * dedicated Elementary window.
312 * @param obj The file selector entry widget
313 * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
314 * if it will use a dedicated window
316 * @see elm_fileselector_entry_inwin_mode_set() for more details
318 * @ingroup File_Selector_Entry
320 EAPI Eina_Bool elm_fileselector_entry_inwin_mode_get(const Evas_Object *obj);
323 * Set the initial file system path for a given file selector entry
326 * @param obj The file selector entry widget
327 * @param path The path string
329 * It must be a <b>directory</b> path, which will have the contents
330 * displayed initially in the file selector's view, when invoked
331 * from @p obj. The default initial path is the @c "HOME"
332 * environment variable's value.
334 * @see elm_fileselector_entry_path_get()
336 * @ingroup File_Selector_Entry
338 EAPI void elm_fileselector_entry_selected_set(Evas_Object *obj, const char *path);
341 * Get the parent directory's path to the latest file selection on
342 * a given filer selector entry widget
344 * @param obj The file selector object
345 * @return The (full) path of the directory of the last selection
346 * on @p obj widget, a @b stringshared string
348 * @see elm_fileselector_entry_path_set()
350 * @ingroup File_Selector_Entry
352 EAPI const char *elm_fileselector_entry_selected_get(const Evas_Object *obj);