Functions
EOAPI void	elm_obj_fileselector_button_inwin_mode_set (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. More...

EOAPI Eina_Bool	elm_obj_fileselector_button_inwin_mode_get (void)
	Get whether a given file selector button widget's internal file selector will raise an Elementary "inner window", instead of a dedicated Elementary window. More...

EOAPI void	elm_obj_fileselector_button_window_size_set (Evas_Coord width, Evas_Coord height)
	Set the size of a given file selector button widget's window, holding the file selector itself. More...

EOAPI void	elm_obj_fileselector_button_window_size_get (Evas_Coord width, Evas_Coord height)
	Get the size of a given file selector button widget's window, holding the file selector itself. More...

EOAPI void	elm_obj_fileselector_button_window_title_set (const char *title)
	Set the title for a given file selector button widget's window. More...

EOAPI const char *	elm_obj_fileselector_button_window_title_get (void)
	Get the title for a given file selector button widget's window. More...

void	elm_fileselector_button_inwin_mode_set (Eo *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. More...

Eina_Bool	elm_fileselector_button_inwin_mode_get (const Eo *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. More...

void	elm_fileselector_button_window_size_set (Eo *obj, Evas_Coord width, Evas_Coord height)
	Set the size of a given file selector button widget's window, holding the file selector itself. More...

void	elm_fileselector_button_window_size_get (const Eo obj, Evas_Coord width, Evas_Coord *height)
	Get the size of a given file selector button widget's window, holding the file selector itself. More...

void	elm_fileselector_button_window_title_set (Eo obj, const char title)
	Set the title for a given file selector button widget's window. More...

const char *	elm_fileselector_button_window_title_get (const Eo *obj)
	Get the title for a given file selector button widget's window. More...

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

EINA_DEPRECATED 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. More...

EINA_DEPRECATED 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. More...

EINA_DEPRECATED 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. More...

EINA_DEPRECATED 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. More...

EINA_DEPRECATED 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. More...

EINA_DEPRECATED 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. More...

EINA_DEPRECATED 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. More...

EINA_DEPRECATED 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. More...

bool	elm_fileselector_button::inwin_mode_get () const
	Get whether a given file selector button widget's internal file selector will raise an Elementary "inner window", instead of a dedicated Elementary window. More...

void	elm_fileselector_button::inwin_mode_set (bool value_) const
	Get whether a given file selector button widget's internal file selector will raise an Elementary "inner window", instead of a dedicated Elementary window. More...

void	elm_fileselector_button::window_size_get (Evas_Coord width_, Evas_Coord height_) const
	Get the size of a given file selector button widget's window, holding the file selector itself. More...

void	elm_fileselector_button::window_size_set (Evas_Coord width_, Evas_Coord height_) const
	Get the size of a given file selector button widget's window, holding the file selector itself. More...

std::string	elm_fileselector_button::window_title_get () const
	Get the title for a given file selector button widget's window. More...

void	elm_fileselector_button::window_title_set (std::string title_) const
	Get the title for a given file selector button widget's window. More...

Detailed Description

This is a button that, when clicked, creates an Elementary window (or inner window) with a fileselector 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)
"language,changed" - the program's language changed
"focused" - When the fileselector button has received focus. (since 1.8)
"unfocused" - When the fileselector button has lost focus. (since 1.8)

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

"default" - A 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:

File selector button widget example

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

parent The parent object

Returns: a new file selector button widget handle or NULL, on errors

EINA_DEPRECATED 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

obj	The 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

Deprecated:: Use elm_fileselector_expandable_get() instead.

EINA_DEPRECATED 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

obj	The file selector button widget
value	`EINA_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()

Deprecated:: Use elm_fileselector_expandable_set() instead.

EINA_DEPRECATED 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

obj	The 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_folder_only_set() for more details

Deprecated:: Use elm_fileselector_folder_only_get() instead.

EINA_DEPRECATED 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

obj	The file selector button widget
value	`EINA_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()

Deprecated:: Use elm_fileselector_folder_only_set() instead.

Eina_Bool elm_fileselector_button_inwin_mode_get ( const Eo * 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.

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

void elm_fileselector_button_inwin_mode_set	(	Eo *	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 depends on the current profile.

See also: elm_win_inwin_add() for more information on inner windows; elm_fileselector_button_inwin_mode_get()

Parameters

[in] value EINA_TRUE to make it use an inner window, EINA_FALSE to make it use a dedicated window

EINA_DEPRECATED 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

obj	The 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_is_save_set() for more details

Deprecated:: Use elm_fileselector_is_save_get() instead.

EINA_DEPRECATED 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

obj	The file selector button widget
value	`EINA_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()

Deprecated:: Use elm_fileselector_is_save_set() instead.

EINA_DEPRECATED 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

obj	The file selector button widget

Returns: path The path string

See also: elm_fileselector_path_set() for more details

Deprecated:: Use elm_fileselector_path_get() instead.

EINA_DEPRECATED 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

obj	The file selector button widget
path	The 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_path_get()

Deprecated:: Use elm_fileselector_path_set() instead.

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

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

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

Parameters

[out]	width	The window's width
[out]	height	The window's height

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

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

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()

Parameters

[in]	width	The window's width
[in]	height	The window's height

const char* elm_fileselector_button_window_title_get ( const Eo * obj )

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

Returns: Title of the file selector button's window

See also: elm_fileselector_button_window_title_get() for more details

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

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

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()

Parameters

[in] title The title string

EOAPI Eina_Bool elm_obj_fileselector_button_inwin_mode_get ( void )

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

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_button_inwin_mode_get(), and elm_fileselector_button::inwin_mode_get().

EOAPI void elm_obj_fileselector_button_inwin_mode_set ( 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 depends on the current profile.

See also: elm_win_inwin_add() for more information on inner windows; elm_fileselector_button_inwin_mode_get()

Parameters

[in] value EINA_TRUE to make it use an inner window, EINA_FALSE to make it use a dedicated window

Referenced by elm_fileselector_button_inwin_mode_set(), and elm_fileselector_button::inwin_mode_set().

EOAPI void elm_obj_fileselector_button_window_size_get	(	Evas_Coord *	width,
		Evas_Coord *	height
	)

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

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

Parameters

[out]	width	The window's width
[out]	height	The window's height

Referenced by elm_fileselector_button_window_size_get(), and elm_fileselector_button::window_size_get().

EOAPI void elm_obj_fileselector_button_window_size_set	(	Evas_Coord	width,
		Evas_Coord	height
	)

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

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()

Parameters

[in]	width	The window's width
[in]	height	The window's height

Referenced by elm_fileselector_button_window_size_set(), and elm_fileselector_button::window_size_set().

EOAPI const char* elm_obj_fileselector_button_window_title_get ( void )

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

Returns: Title of the file selector button's window

See also: elm_fileselector_button_window_title_get() for more details

Referenced by elm_fileselector_button_window_title_get(), and elm_fileselector_button::window_title_get().

EOAPI void elm_obj_fileselector_button_window_title_set ( const char * title )

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

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()

Parameters

[in] title The title string

Referenced by elm_fileselector_button_window_title_set(), and elm_fileselector_button::window_title_set().

bool elm_fileselector_button::inwin_mode_get ( ) const

inline

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

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

Parameters

value EINA_TRUE to make it use an inner window, EINA_FALSE to make it use a dedicated window

References elm_obj_fileselector_button_inwin_mode_get().

void elm_fileselector_button::inwin_mode_set ( bool value_ ) const

inline

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

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

Parameters

value EINA_TRUE to make it use an inner window, EINA_FALSE to make it use a dedicated window

References elm_obj_fileselector_button_inwin_mode_set().

void elm_fileselector_button::window_size_get	(	Evas_Coord *	width_,
		Evas_Coord *	height_
	)		const

inline

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

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

Parameters

width	The window's width
height	The window's height

References elm_obj_fileselector_button_window_size_get().

void elm_fileselector_button::window_size_set	(	Evas_Coord	width_,
		Evas_Coord	height_
	)		const

inline

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

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

Parameters

width	The window's width
height	The window's height

References elm_obj_fileselector_button_window_size_set().

std::string elm_fileselector_button::window_title_get ( ) const

inline

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

Returns: Title of the file selector button's window

See also: elm_fileselector_button_window_title_get() for more details

Parameters

title The title string

References elm_obj_fileselector_button_window_title_get().

void elm_fileselector_button::window_title_set ( std::string title_ ) const

inline

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

Returns: Title of the file selector button's window

See also: elm_fileselector_button_window_title_get() for more details

Parameters

title The title string

References elm_obj_fileselector_button_window_title_set().

Functions

Detailed Description

Function Documentation