2011-12-29 23:20:48 -08:00
|
|
|
/**
|
2016-03-16 08:05:31 -07:00
|
|
|
* @defgroup Elm_Fileselector File Selector
|
2012-04-16 18:35:46 -07:00
|
|
|
* @ingroup Elementary
|
2011-12-29 23:20:48 -08:00
|
|
|
*
|
2012-06-05 15:41:21 -07:00
|
|
|
* @image html fileselector_inheritance_tree.png
|
|
|
|
* @image latex fileselector_inheritance_tree.eps
|
|
|
|
*
|
2011-12-29 23:20:48 -08:00
|
|
|
* @image html img/widget/fileselector/preview-00.png
|
|
|
|
* @image latex img/widget/fileselector/preview-00.eps
|
|
|
|
*
|
|
|
|
* A file selector is a widget that allows a user to navigate
|
|
|
|
* through a file system, reporting file selections back via its
|
|
|
|
* API.
|
|
|
|
*
|
|
|
|
* It contains shortcut buttons for home directory (@c ~) and to
|
|
|
|
* jump one directory upwards (..), as well as cancel/ok buttons to
|
|
|
|
* confirm/cancel a given selection. After either one of those two
|
|
|
|
* former actions, the file selector will issue its @c "done" smart
|
|
|
|
* callback.
|
|
|
|
*
|
|
|
|
* There's a text entry on it, too, showing the name of the current
|
|
|
|
* selection. There's the possibility of making it editable, so it
|
|
|
|
* is useful on file saving dialogs on applications, where one
|
|
|
|
* gives a file name to save contents to, in a given directory in
|
|
|
|
* the system. This custom file name will be reported on the @c
|
|
|
|
* "done" smart callback (explained in sequence).
|
|
|
|
*
|
|
|
|
* Finally, it has a view to display file system items into in two
|
|
|
|
* possible forms:
|
|
|
|
* - list
|
|
|
|
* - grid
|
|
|
|
*
|
|
|
|
* If Elementary is built with support of the Ethumb thumbnailing
|
|
|
|
* library, the second form of view will display preview thumbnails
|
|
|
|
* of files which it supports.
|
|
|
|
*
|
2012-11-25 22:32:53 -08:00
|
|
|
* This widget inherits from the Layout one, so that all the
|
2012-05-03 15:44:26 -07:00
|
|
|
* functions acting on it also work for file selector objects.
|
2011-12-29 23:20:48 -08:00
|
|
|
*
|
2012-05-03 15:44:26 -07:00
|
|
|
* This widget emits the following signals, besides the ones sent from
|
|
|
|
* @ref Layout:
|
2013-10-01 20:35:23 -07:00
|
|
|
* - @c "activated" - the user activated a file. This can happen by
|
2014-07-19 09:50:03 -07:00
|
|
|
* double-clicking or pressing Enter key. (@p event_info is a
|
2013-10-01 20:35:23 -07:00
|
|
|
* pointer to the activated file path)
|
2011-12-29 23:20:48 -08:00
|
|
|
* - @c "selected" - the user has clicked on a file (when not in
|
|
|
|
* folders-only mode) or directory (when in folders-only mode)
|
2013-09-12 06:17:07 -07:00
|
|
|
* - @c "selected,invalid" - the user has tried to access wrong path
|
|
|
|
* which does not exist.
|
2011-12-29 23:20:48 -08:00
|
|
|
* - @c "directory,open" - the list has been populated with new
|
2014-07-19 09:50:03 -07:00
|
|
|
* content (@p event_info is a pointer to the directory's
|
2011-12-29 23:20:48 -08:00
|
|
|
* path, a @b stringshared string)
|
|
|
|
* - @c "done" - the user has clicked on the "ok" or "cancel"
|
2014-07-19 09:50:03 -07:00
|
|
|
* buttons (@p event_info is a pointer to the selection's
|
2011-12-29 23:20:48 -08:00
|
|
|
* path, a @b stringshared string)
|
2014-01-21 22:53:49 -08:00
|
|
|
* - @c "focused" - When the fileselector has received focus. (since 1.9)
|
|
|
|
* - @c "unfocused" - When the fileselector has lost focus. (since 1.9)
|
2011-12-29 23:20:48 -08:00
|
|
|
*
|
2013-07-22 09:51:27 -07:00
|
|
|
* For text, elm_layout_text_set() will work here on:
|
2013-12-15 07:44:55 -08:00
|
|
|
* @li @c "ok" - OK button label if the ok button is set. @since 1.8
|
2013-07-22 09:51:27 -07:00
|
|
|
* @li @c "cancel" - Cancel button label if the cancel button is set. @since 1.8
|
|
|
|
*
|
2011-12-29 23:20:48 -08:00
|
|
|
* Here is an example on its usage:
|
|
|
|
* @li @ref fileselector_example
|
|
|
|
*/
|
2011-12-29 22:49:28 -08:00
|
|
|
|
2011-12-29 23:20:48 -08:00
|
|
|
/**
|
2016-03-16 08:05:31 -07:00
|
|
|
* @addtogroup Elm_Fileselector
|
2011-12-29 23:20:48 -08:00
|
|
|
* @{
|
|
|
|
*/
|
2011-12-29 22:49:28 -08:00
|
|
|
|
2013-04-27 23:02:06 -07:00
|
|
|
#include "elc_fileselector_common.h"
|
|
|
|
#ifdef EFL_EO_API_SUPPORT
|
|
|
|
#include "elc_fileselector_eo.h"
|
|
|
|
#endif
|
|
|
|
#ifndef EFL_NOLEGACY_API_SUPPORT
|
|
|
|
#include "elc_fileselector_legacy.h"
|
|
|
|
#endif
|
2011-12-29 23:20:48 -08:00
|
|
|
/**
|
|
|
|
* @}
|
|
|
|
*/
|