2 * @defgroup File_Selector_Entry File Selector Entry
4 * @image html img/widget/fileselector_entry/preview-00.png
5 * @image latex img/widget/fileselector_entry/preview-00.eps
7 * This is an entry made to be filled with or display a <b>file
8 * system path string</b>. Besides the entry itself, the widget has
9 * a @ref File_Selector_Button "file selector button" on its side,
10 * which will raise an internal @ref Fileselector "file selector widget",
11 * when clicked, for path selection aided by file system
14 * This file selector may appear in an Elementary window or in an
15 * inner window. When a file is chosen from it, the (inner) window
16 * is closed and the selected file's path string is exposed both as
17 * an smart event and as the new text on the entry.
19 * This widget encapsulates operations on its internal file
20 * selector on its own API. There is less control over its file
21 * selector than that one would have instatiating one directly.
23 * Smart callbacks one can register to:
24 * - @c "changed" - The text within the entry was changed
25 * - @c "activated" - The entry has had editing finished and
26 * changes are to be "committed"
27 * - @c "press" - The entry has been clicked
28 * - @c "longpressed" - The entry has been clicked (and held) for a
30 * - @c "clicked" - The entry has been clicked
31 * - @c "clicked,double" - The entry has been double clicked
32 * - @c "focused" - The entry has received focus
33 * - @c "unfocused" - The entry has lost focus
34 * - @c "selection,paste" - A paste action has occurred on the
36 * - @c "selection,copy" - A copy action has occurred on the entry
37 * - @c "selection,cut" - A cut action has occurred on the entry
38 * - @c "unpressed" - The file selector entry's button was released
39 * after being pressed.
40 * - @c "file,chosen" - The user has selected a path via the file
41 * selector entry's internal file selector, whose string pointer
42 * comes as the @c event_info data (a stringshared string)
44 * Here is an example on its usage:
45 * @li @ref fileselector_entry_example
47 * @see @ref File_Selector_Button for a similar widget.
52 * Add a new file selector entry widget to the given parent
53 * Elementary (container) object
55 * @param parent The parent object
56 * @return a new file selector entry widget handle or @c NULL, on
59 EAPI Evas_Object *elm_fileselector_entry_add(Evas_Object *parent);
62 * Set the icon on a given file selector entry widget's button
64 * @param obj The file selector entry widget
65 * @param icon The icon object for the entry's button
67 * Once the icon object is set, a previously set one will be
68 * deleted. If you want to keep the latter, use the
69 * elm_fileselector_entry_button_icon_unset() function.
71 * @see elm_fileselector_entry_button_icon_get()
73 EAPI void elm_fileselector_entry_button_icon_set(Evas_Object *obj, Evas_Object *icon);
76 * Get the icon set for a given file selector entry widget's button
78 * @param obj The file selector entry widget
79 * @return The icon object currently set on @p obj widget's button
80 * or @c NULL, if none is
82 * @see elm_fileselector_entry_button_icon_set()
84 EAPI Evas_Object *elm_fileselector_entry_button_icon_get(const Evas_Object *obj);
87 * Unset the icon used in a given file selector entry widget's
90 * @param obj The file selector entry widget
91 * @return The icon object that was being used on @p obj widget's
92 * button or @c NULL, on errors
94 * Unparent and return the icon object which was set for this
97 * @see elm_fileselector_entry_button_icon_set()
99 EAPI Evas_Object *elm_fileselector_entry_button_icon_unset(Evas_Object *obj);
102 * Set the title for a given file selector entry widget's window
104 * @param obj The file selector entry widget
105 * @param title The title string
107 * This will change the window's title, when the file selector pops
108 * out after a click on the entry's button. Those windows have the
109 * default (unlocalized) value of @c "Select a file" as titles.
111 * @note It will only take any effect if the file selector
112 * entry widget is @b not under "inwin mode".
114 * @see elm_fileselector_entry_window_title_get()
116 EAPI void elm_fileselector_entry_window_title_set(Evas_Object *obj, const char *title);
119 * Get the title set for a given file selector entry widget's
122 * @param obj The file selector entry widget
123 * @return Title of the file selector entry's window
125 * @see elm_fileselector_entry_window_title_get() for more details
127 EAPI const char *elm_fileselector_entry_window_title_get(const Evas_Object *obj);
130 * Set the size of a given file selector entry widget's window,
131 * holding the file selector itself.
133 * @param obj The file selector entry widget
134 * @param width The window's width
135 * @param height The window's height
137 * @note it will only take any effect if the file selector entry
138 * widget is @b not under "inwin mode". The default size for the
139 * window (when applicable) is 400x400 pixels.
141 * @see elm_fileselector_entry_window_size_get()
143 EAPI void elm_fileselector_entry_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height);
146 * Get the size of a given file selector entry widget's window,
147 * holding the file selector itself.
149 * @param obj The file selector entry widget
150 * @param width Pointer into which to store the width value
151 * @param height Pointer into which to store the height value
153 * @note Use @c NULL pointers on the size values you're not
154 * interested in: they'll be ignored by the function.
156 * @see elm_fileselector_entry_window_size_set(), for more details
158 EAPI void elm_fileselector_entry_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height);
161 * Set the initial file system path and the entry's path string for
162 * a given file selector entry widget
164 * @param obj The file selector entry widget
165 * @param path The path string
167 * It must be a <b>directory</b> path, which will have the contents
168 * displayed initially in the file selector's view, when invoked
169 * from @p obj. The default initial path is the @c "HOME"
170 * environment variable's value.
172 * @see elm_fileselector_entry_path_get()
174 EAPI void elm_fileselector_entry_path_set(Evas_Object *obj, const char *path);
177 * Get the entry's path string for a given file selector entry
180 * @param obj The file selector entry widget
181 * @return path The path string
183 * @see elm_fileselector_entry_path_set() for more details
185 EAPI const char *elm_fileselector_entry_path_get(const Evas_Object *obj);
188 * Enable/disable a tree view in the given file selector entry
189 * widget's internal file selector
191 * @param obj The file selector entry widget
192 * @param value @c EINA_TRUE to enable tree view, @c EINA_FALSE to disable
194 * This has the same effect as elm_fileselector_expandable_set(),
195 * but now applied to a file selector entry's internal file
198 * @note There's no way to put a file selector entry's internal
199 * file selector in "grid mode", as one may do with "pure" file
202 * @see elm_fileselector_expandable_get()
204 EAPI void elm_fileselector_entry_expandable_set(Evas_Object *obj, Eina_Bool value);
207 * Get whether tree view is enabled for the given file selector
208 * entry widget's internal file selector
210 * @param obj The file selector entry widget
211 * @return @c EINA_TRUE if @p obj widget's internal file selector
212 * is in tree view, @c EINA_FALSE otherwise (and or errors)
214 * @see elm_fileselector_expandable_set() for more details
216 EAPI Eina_Bool elm_fileselector_entry_expandable_get(const Evas_Object *obj);
219 * Set whether a given file selector entry widget's internal file
220 * selector is to display folders only or the directory contents,
223 * @param obj The file selector entry widget
224 * @param value @c EINA_TRUE to make @p obj widget's internal file
225 * selector only display directories, @c EINA_FALSE to make files
226 * to be displayed in it too
228 * This has the same effect as elm_fileselector_folder_only_set(),
229 * but now applied to a file selector entry's internal file
232 * @see elm_fileselector_folder_only_get()
234 EAPI void elm_fileselector_entry_folder_only_set(Evas_Object *obj, Eina_Bool value);
237 * Get whether a given file selector entry widget's internal file
238 * selector is displaying folders only or the directory contents,
241 * @param obj The file selector entry widget
242 * @return @c EINA_TRUE if @p obj widget's internal file
243 * selector is only displaying directories, @c EINA_FALSE if files
244 * are being displayed in it too (and on errors)
246 * @see elm_fileselector_entry_folder_only_set() for more details
248 EAPI Eina_Bool elm_fileselector_entry_folder_only_get(const Evas_Object *obj);
251 * Enable/disable the file name entry box where the user can type
252 * in a name for a file, in a given file selector entry widget's
253 * internal file selector.
255 * @param obj The file selector entry widget
256 * @param value @c EINA_TRUE to make @p obj widget's internal
257 * file selector a "saving dialog", @c EINA_FALSE otherwise
259 * This has the same effect as elm_fileselector_is_save_set(),
260 * but now applied to a file selector entry's internal file
263 * @see elm_fileselector_is_save_get()
265 EAPI void elm_fileselector_entry_is_save_set(Evas_Object *obj, Eina_Bool value);
268 * Get whether the given file selector entry widget's internal
269 * file selector is in "saving dialog" mode
271 * @param obj The file selector entry widget
272 * @return @c EINA_TRUE, if @p obj widget's internal file selector
273 * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
276 * @see elm_fileselector_entry_is_save_set() for more details
278 EAPI Eina_Bool elm_fileselector_entry_is_save_get(const Evas_Object *obj);
281 * Set whether a given file selector entry widget's internal file
282 * selector will raise an Elementary "inner window", instead of a
283 * dedicated Elementary window. By default, it won't.
285 * @param obj The file selector entry widget
286 * @param value @c EINA_TRUE to make it use an inner window, @c
287 * EINA_TRUE to make it use a dedicated window
289 * @see elm_win_inwin_add() for more information on inner windows
290 * @see elm_fileselector_entry_inwin_mode_get()
292 EAPI void elm_fileselector_entry_inwin_mode_set(Evas_Object *obj, Eina_Bool value);
295 * Get whether a given file selector entry widget's internal file
296 * selector will raise an Elementary "inner window", instead of a
297 * dedicated Elementary window.
299 * @param obj The file selector entry widget
300 * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
301 * if it will use a dedicated window
303 * @see elm_fileselector_entry_inwin_mode_set() for more details
305 EAPI Eina_Bool elm_fileselector_entry_inwin_mode_get(const Evas_Object *obj);
308 * Set the initial file system path for a given file selector entry
311 * @param obj The file selector entry widget
312 * @param path The path string
314 * It must be a <b>directory</b> path, which will have the contents
315 * displayed initially in the file selector's view, when invoked
316 * from @p obj. The default initial path is the @c "HOME"
317 * environment variable's value.
319 * @see elm_fileselector_entry_path_get()
321 EAPI void elm_fileselector_entry_selected_set(Evas_Object *obj, const char *path);
324 * Get the parent directory's path to the latest file selection on
325 * a given filer selector entry widget
327 * @param obj The file selector object
328 * @return The (full) path of the directory of the last selection
329 * on @p obj widget, a @b stringshared string
331 * @see elm_fileselector_entry_path_set()
333 EAPI const char *elm_fileselector_entry_selected_get(const Evas_Object *obj);