File Selector Button

Functions

Evas_Object * elm_fileselector_button_add (Evas_Object *parent)
 Add a new file selector button widget to the given parent Elementary (container) object.
void elm_fileselector_button_window_title_set (Evas_Object *obj, const char *title)
 Set the title for a given file selector button widget's window.
const char * elm_fileselector_button_window_title_get (const Evas_Object *obj)
 Get the title for a given file selector button widget's window.
void elm_fileselector_button_window_size_set (Evas_Object *obj, Evas_Coord width, Evas_Coord height)
 Set the size of a given file selector button widget's window, holding the file selector itself.
void elm_fileselector_button_window_size_get (const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height)
 Get the size of a given file selector button widget's window, holding the file selector itself.
void elm_fileselector_button_path_set (Evas_Object *obj, const char *path)
 Set the initial file system path for a given file selector button widget.
const char * elm_fileselector_button_path_get (const Evas_Object *obj)
 Get the initial file system path set for a given file selector button widget.
void elm_fileselector_button_expandable_set (Evas_Object *obj, Eina_Bool value)
 Enable/disable a tree view in the given file selector button widget's internal file selector.
Eina_Bool elm_fileselector_button_expandable_get (const Evas_Object *obj)
 Get whether tree view is enabled for the given file selector button widget's internal file selector.
void elm_fileselector_button_folder_only_set (Evas_Object *obj, Eina_Bool value)
 Set whether a given file selector button widget's internal file selector is to display folders only or the directory contents, as well.
Eina_Bool elm_fileselector_button_folder_only_get (const Evas_Object *obj)
 Get whether a given file selector button widget's internal file selector is displaying folders only or the directory contents, as well.
void elm_fileselector_button_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 button widget's internal file selector.
Eina_Bool elm_fileselector_button_is_save_get (const Evas_Object *obj)
 Get whether the given file selector button widget's internal file selector is in "saving dialog" mode.
void elm_fileselector_button_inwin_mode_set (Evas_Object *obj, Eina_Bool value)
 Set whether a given file selector button widget's internal file selector will raise an Elementary "inner window", instead of a dedicated Elementary window.
Eina_Bool elm_fileselector_button_inwin_mode_get (const Evas_Object *obj)
 Get whether a given file selector button widget's internal file selector will raise an Elementary "inner window", instead of a dedicated Elementary window.

Detailed Description

fileselector_button_inheritance_tree.png
preview-00.png
preview-01.png
preview-02.png

This is a button that, when clicked, creates an Elementary window (or inner window) with a file selector widget" within. When a file is chosen, the (inner) window is closed and the button emits a signal having the selected file as it's event_info.

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.

The following styles are available for this button:

  • "default"
  • "anchor"
  • "hoversel_vertical"
  • "hoversel_vertical_entry"

This widget inherits from the Button one, so that all the functions acting on it also work for file selector button objects.

This widget emits the following signals, besides the ones sent from Button:

  • "file,chosen" - the user has selected a path, 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_button widget that you can use for are:

  • "icon" - Icon of the fileselector_button

Supported elm_object common APIs.

Here is an example on its usage:

See also:
File Selector Entry for a similar widget.

Function Documentation

Evas_Object* elm_fileselector_button_add ( Evas_Object *  parent)

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

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

Referenced by elm_fileselector_entry_add().

Eina_Bool elm_fileselector_button_expandable_get ( const Evas_Object *  obj)

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

Parameters:
objThe file selector button 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

Referenced by elm_fileselector_entry_expandable_get().

void elm_fileselector_button_expandable_set ( Evas_Object *  obj,
Eina_Bool  value 
)

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

Parameters:
objThe file selector button 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 button's internal file selector.

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

References elm_fileselector_expandable_set().

Referenced by elm_fileselector_entry_add(), and elm_fileselector_entry_expandable_set().

Eina_Bool elm_fileselector_button_folder_only_get ( const Evas_Object *  obj)

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

Parameters:
objThe file selector button 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_button_folder_only_set() for more details

Referenced by elm_fileselector_entry_folder_only_get().

void elm_fileselector_button_folder_only_set ( Evas_Object *  obj,
Eina_Bool  value 
)

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

Parameters:
objThe file selector button 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 button's internal file selector.

See also:
elm_fileselector_folder_only_get()

References elm_fileselector_folder_only_set().

Referenced by elm_fileselector_entry_folder_only_set().

Eina_Bool elm_fileselector_button_inwin_mode_get ( const Evas_Object *  obj)

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

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

Referenced by elm_fileselector_entry_inwin_mode_get().

void elm_fileselector_button_inwin_mode_set ( Evas_Object *  obj,
Eina_Bool  value 
)

Set whether a given file selector button 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 button 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_button_inwin_mode_get()

Referenced by elm_fileselector_entry_inwin_mode_set().

Eina_Bool elm_fileselector_button_is_save_get ( const Evas_Object *  obj)

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

Parameters:
objThe file selector button 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_button_is_save_set() for more details

Referenced by elm_fileselector_entry_is_save_get().

void elm_fileselector_button_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 button widget's internal file selector.

Parameters:
objThe file selector button 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 button's internal file selector.

See also:
elm_fileselector_is_save_get()

References elm_fileselector_is_save_set().

Referenced by elm_fileselector_entry_is_save_set().

const char* elm_fileselector_button_path_get ( const Evas_Object *  obj)

Get the initial file system path set for a given file selector button widget.

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

Referenced by elm_fileselector_entry_selected_get().

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

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

Parameters:
objThe file selector button 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_button_path_get()

References elm_fileselector_selected_set().

Referenced by elm_fileselector_entry_path_set(), and elm_fileselector_entry_selected_set().

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

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

Parameters:
objThe file selector button 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_button_window_size_set(), for more details

Referenced by elm_fileselector_entry_window_size_get().

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

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

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

Referenced by elm_fileselector_entry_window_size_set().

const char* elm_fileselector_button_window_title_get ( const Evas_Object *  obj)

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

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

Referenced by elm_fileselector_entry_window_title_get().

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

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

Parameters:
objThe file selector button widget
titleThe title string

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

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

References elm_win_title_set().

Referenced by elm_fileselector_entry_window_title_set().