File Selector Entry

Functions

Evas_Object * elm_fileselector_entry_add (Evas_Object *parent)
 Add a new file selector entry widget to the given parent Elementary (container) object.
void elm_fileselector_entry_window_title_set (Evas_Object *obj, const char *title)
 Set the title for a given file selector entry widget's window.
const char * elm_fileselector_entry_window_title_get (const Evas_Object *obj)
 Get the title set for a given file selector entry widget's window.
void elm_fileselector_entry_window_size_set (Evas_Object *obj, Evas_Coord width, Evas_Coord height)
 Set the size of a given file selector entry widget's window, holding the file selector itself.
void elm_fileselector_entry_window_size_get (const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height)
 Get the size of a given file selector entry widget's window, holding the file selector itself.
void elm_fileselector_entry_path_set (Evas_Object *obj, const char *path)
 Set the initial file system path and the entry's path string for a given file selector entry widget.
const char * elm_fileselector_entry_path_get (const Evas_Object *obj)
 Get the entry's path string for a given file selector entry widget.
void elm_fileselector_entry_expandable_set (Evas_Object *obj, Eina_Bool value)
 Enable/disable a tree view in the given file selector entry widget's internal file selector.
Eina_Bool elm_fileselector_entry_expandable_get (const Evas_Object *obj)
 Get whether tree view is enabled for the given file selector entry widget's internal file selector.
void elm_fileselector_entry_folder_only_set (Evas_Object *obj, Eina_Bool value)
 Set whether a given file selector entry widget's internal file selector is to display folders only or the directory contents, as well.
Eina_Bool elm_fileselector_entry_folder_only_get (const Evas_Object *obj)
 Get whether a given file selector entry widget's internal file selector is displaying folders only or the directory contents, as well.
void elm_fileselector_entry_is_save_set (Evas_Object *obj, Eina_Bool value)
 Enable/disable the file name entry box where the user can type in a name for a file, in a given file selector entry widget's internal file selector.
Eina_Bool elm_fileselector_entry_is_save_get (const Evas_Object *obj)
 Get whether the given file selector entry widget's internal file selector is in "saving dialog" mode.
void elm_fileselector_entry_inwin_mode_set (Evas_Object *obj, Eina_Bool value)
 Set whether a given file selector entry widget's internal file selector will raise an Elementary "inner window", instead of a dedicated Elementary window.
Eina_Bool elm_fileselector_entry_inwin_mode_get (const Evas_Object *obj)
 Get whether a given file selector entry widget's internal file selector will raise an Elementary "inner window", instead of a dedicated Elementary window.
void elm_fileselector_entry_selected_set (Evas_Object *obj, const char *path)
 Set the initial file system path for a given file selector entry widget.
const char * elm_fileselector_entry_selected_get (const Evas_Object *obj)
 Get the parent directory's path to the latest file selection on a given filer selector entry widget.

Detailed Description

preview-00.png

This is an entry made to be filled with or display a file system path string. Besides the entry itself, the widget has a file selector button on its side, which will raise an internal file selector widget, when clicked, for path selection aided by file system navigation.

This file selector may appear in an Elementary window or in an inner window. When a file is chosen from it, the (inner) window is closed and the selected file's path string is exposed both as a smart event and as the new text on the entry.

This widget encapsulates operations on its internal file selector on its own API. There is less control over its file selector than that one would have instantiating one directly.

Smart callbacks one can register to:

  • "changed" - The text within the entry was changed
  • "activated" - The entry has had editing finished and changes are to be "committed"
  • "press" - The entry has been clicked
  • "longpressed" - The entry has been clicked (and held) for a couple seconds
  • "clicked" - The entry has been clicked
  • "clicked,double" - The entry has been double clicked
  • "focused" - The entry has received focus
  • "unfocused" - The entry has lost focus
  • "selection,paste" - A paste action has occurred on the entry
  • "selection,copy" - A copy action has occurred on the entry
  • "selection,cut" - A cut action has occurred on the entry
  • "unpressed" - The file selector entry's button was released after being pressed.
  • "file,chosen" - The user has selected a path via the file selector entry's internal file selector, whose string pointer comes as the event_info data (a stringshared string)

Default text parts of the fileselector_button widget that you can use for are:

  • "default" - Label of the fileselector_button

Default content parts of the fileselector_entry widget that you can use for are:

  • "button icon" - Button icon of the fileselector_entry

Supported elm_object common APIs.

Here is an example on its usage:

See also:
File Selector Button for a similar widget.

Function Documentation

Evas_Object* elm_fileselector_entry_add ( Evas_Object *  parent)

Add a new file selector entry widget to the given parent Elementary (container) object.

Parameters:
parentThe parent object
Returns:
a new file selector entry widget handle or NULL, on errors

References elm_entry_add(), elm_entry_editable_set(), elm_entry_scrollable_set(), elm_entry_single_line_set(), elm_fileselector_button_add(), and elm_fileselector_button_expandable_set().

Eina_Bool elm_fileselector_entry_expandable_get ( const Evas_Object *  obj)

Get whether tree view is enabled for the given file selector entry widget's internal file selector.

Parameters:
objThe file selector entry widget
Returns:
EINA_TRUE if obj widget's internal file selector is in tree view, EINA_FALSE otherwise (and or errors)
See also:
elm_fileselector_expandable_set() for more details

References elm_fileselector_button_expandable_get().

void elm_fileselector_entry_expandable_set ( Evas_Object *  obj,
Eina_Bool  value 
)

Enable/disable a tree view in the given file selector entry widget's internal file selector.

Parameters:
objThe file selector entry widget
valueEINA_TRUE to enable tree view, EINA_FALSE to disable

This has the same effect as elm_fileselector_expandable_set(), but now applied to a file selector entry's internal file selector.

Note:
There's no way to put a file selector entry's internal file selector in "grid mode", as one may do with "pure" file selectors.
See also:
elm_fileselector_expandable_get()

References elm_fileselector_button_expandable_set().

Eina_Bool elm_fileselector_entry_folder_only_get ( const Evas_Object *  obj)

Get whether a given file selector entry widget's internal file selector is displaying folders only or the directory contents, as well.

Parameters:
objThe file selector entry widget
Returns:
EINA_TRUE if obj widget's internal file selector is only displaying directories, EINA_FALSE if files are being displayed in it too (and on errors)
See also:
elm_fileselector_entry_folder_only_set() for more details

References elm_fileselector_button_folder_only_get().

void elm_fileselector_entry_folder_only_set ( Evas_Object *  obj,
Eina_Bool  value 
)

Set whether a given file selector entry widget's internal file selector is to display folders only or the directory contents, as well.

Parameters:
objThe file selector entry widget
valueEINA_TRUE to make obj widget's internal file selector only display directories, EINA_FALSE to make files to be displayed in it too

This has the same effect as elm_fileselector_folder_only_set(), but now applied to a file selector entry's internal file selector.

See also:
elm_fileselector_folder_only_get()

References elm_fileselector_button_folder_only_set().

Eina_Bool elm_fileselector_entry_inwin_mode_get ( const Evas_Object *  obj)

Get whether a given file selector entry widget's internal file selector will raise an Elementary "inner window", instead of a dedicated Elementary window.

Parameters:
objThe file selector entry widget
Returns:
EINA_TRUE if will use an inner window, EINA_TRUE if it will use a dedicated window
See also:
elm_fileselector_entry_inwin_mode_set() for more details

References elm_fileselector_button_inwin_mode_get().

void elm_fileselector_entry_inwin_mode_set ( Evas_Object *  obj,
Eina_Bool  value 
)

Set whether a given file selector entry widget's internal file selector will raise an Elementary "inner window", instead of a dedicated Elementary window.

By default, it won't.

Parameters:
objThe file selector entry widget
valueEINA_TRUE to make it use an inner window, EINA_TRUE to make it use a dedicated window
See also:
elm_win_inwin_add() for more information on inner windows
elm_fileselector_entry_inwin_mode_get()

References elm_fileselector_button_inwin_mode_set().

Eina_Bool elm_fileselector_entry_is_save_get ( const Evas_Object *  obj)

Get whether the given file selector entry widget's internal file selector is in "saving dialog" mode.

Parameters:
objThe file selector entry widget
Returns:
EINA_TRUE, if obj widget's internal file selector is in "saving dialog" mode, EINA_FALSE otherwise (and on errors)
See also:
elm_fileselector_entry_is_save_set() for more details

References elm_fileselector_button_is_save_get().

void elm_fileselector_entry_is_save_set ( Evas_Object *  obj,
Eina_Bool  value 
)

Enable/disable the file name entry box where the user can type in a name for a file, in a given file selector entry widget's internal file selector.

Parameters:
objThe file selector entry widget
valueEINA_TRUE to make obj widget's internal file selector a "saving dialog", EINA_FALSE otherwise

This has the same effect as elm_fileselector_is_save_set(), but now applied to a file selector entry's internal file selector.

See also:
elm_fileselector_is_save_get()

References elm_fileselector_button_is_save_set().

const char* elm_fileselector_entry_path_get ( const Evas_Object *  obj)

Get the entry's path string for a given file selector entry widget.

Parameters:
objThe file selector entry widget
Returns:
path The path string
See also:
elm_fileselector_entry_path_set() for more details

References elm_entry_markup_to_utf8().

void elm_fileselector_entry_path_set ( Evas_Object *  obj,
const char *  path 
)

Set the initial file system path and the entry's path string for a given file selector entry widget.

Parameters:
objThe file selector entry widget
pathThe path string

It must be a directory path, which will have the contents displayed initially in the file selector's view, when invoked from obj. The default initial path is the "HOME" environment variable's value.

See also:
elm_fileselector_entry_path_get()

References elm_entry_utf8_to_markup(), and elm_fileselector_button_path_set().

const char* elm_fileselector_entry_selected_get ( const Evas_Object *  obj)

Get the parent directory's path to the latest file selection on a given filer selector entry widget.

Parameters:
objThe file selector object
Returns:
The (full) path of the directory of the last selection on obj widget, a stringshared string
See also:
elm_fileselector_entry_path_set()

References elm_fileselector_button_path_get().

void elm_fileselector_entry_selected_set ( Evas_Object *  obj,
const char *  path 
)

Set the initial file system path for a given file selector entry widget.

Parameters:
objThe file selector entry widget
pathThe path string

It must be a directory path, which will have the contents displayed initially in the file selector's view, when invoked from obj. The default initial path is the "HOME" environment variable's value.

See also:
elm_fileselector_entry_path_get()

References elm_fileselector_button_path_set().

void elm_fileselector_entry_window_size_get ( const Evas_Object *  obj,
Evas_Coord *  width,
Evas_Coord *  height 
)

Get the size of a given file selector entry widget's window, holding the file selector itself.

Parameters:
objThe file selector entry widget
widthPointer into which to store the width value
heightPointer into which to store the height value
Note:
Use NULL pointers on the size values you're not interested in: they'll be ignored by the function.
See also:
elm_fileselector_entry_window_size_set(), for more details

References elm_fileselector_button_window_size_get().

void elm_fileselector_entry_window_size_set ( Evas_Object *  obj,
Evas_Coord  width,
Evas_Coord  height 
)

Set the size of a given file selector entry widget's window, holding the file selector itself.

Parameters:
objThe file selector entry widget
widthThe window's width
heightThe window's height
Note:
it will only take any effect if the file selector entry widget is not under "inwin mode". The default size for the window (when applicable) is 400x400 pixels.
See also:
elm_fileselector_entry_window_size_get()

References elm_fileselector_button_window_size_set().

const char* elm_fileselector_entry_window_title_get ( const Evas_Object *  obj)

Get the title set for a given file selector entry widget's window.

Parameters:
objThe file selector entry widget
Returns:
Title of the file selector entry's window
See also:
elm_fileselector_entry_window_title_get() for more details

References elm_fileselector_button_window_title_get().

void elm_fileselector_entry_window_title_set ( Evas_Object *  obj,
const char *  title 
)

Set the title for a given file selector entry widget's window.

Parameters:
objThe file selector entry widget
titleThe title string

This will change the window's title, when the file selector pops out after a click on the entry's button. Those windows have the default (unlocalized) value of "Select a file" as titles.

Note:
It will only take any effect if the file selector entry widget is not under "inwin mode".
See also:
elm_fileselector_entry_window_title_get()

References elm_fileselector_button_window_title_set().