efl/legacy/elementary/src/lib/elc_fileselector_button_leg...

111 lines
3.7 KiB
C

/**
* Add a new file selector button widget to the given parent
* Elementary (container) object
*
* @param parent The parent object
* @return a new file selector button widget handle or @c NULL, on
* errors
*
* @ingroup File_Selector_Button
*/
EAPI Evas_Object *elm_fileselector_button_add(Evas_Object *parent);
/**
* Set the title for a given file selector button widget's window
*
* @param obj The file selector button widget
* @param title The 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 @c "Select a file" as titles.
*
* @note It will only take effect if the file selector
* button widget is @b not under "inwin mode".
*
* @see elm_fileselector_button_window_title_get()
*
* @ingroup File_Selector_Button
*/
EAPI void elm_fileselector_button_window_title_set(Evas_Object *obj, const char *title);
/**
* Get the title for a given file selector button widget's
* window
*
* @param obj The file selector button widget
* @return Title of the file selector button's window
*
* @see elm_fileselector_button_window_title_get() for more details
*
* @ingroup File_Selector_Button
*/
EAPI const char *elm_fileselector_button_window_title_get(const Evas_Object *obj);
/**
* Set the size of a given file selector button widget's window,
* holding the file selector itself.
*
* @param obj The file selector button widget
* @param width The window's width
* @param height The window's height
*
* @note it will only take any effect if the file selector button
* widget is @b not under "inwin mode". The default size for the
* window (when applicable) is 400x400 pixels.
*
* @see elm_fileselector_button_window_size_get()
*
* @ingroup File_Selector_Button
*/
EAPI void elm_fileselector_button_window_size_set(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.
*
* @param obj The file selector button widget
* @param width Pointer into which to store the width value
* @param height Pointer into which to store the height value
*
* @note Use @c NULL pointers on the size values you're not
* interested in: they'll be ignored by the function.
*
* @see elm_fileselector_button_window_size_set(), for more details
*
* @ingroup File_Selector_Button
*/
EAPI void elm_fileselector_button_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height);
/**
* 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.
*
* @param obj The file selector button widget
* @param value @c EINA_TRUE to make it use an inner window, @c
* EINA_FALSE to make it use a dedicated window
*
* @see elm_win_inwin_add() for more information on inner windows
* @see elm_fileselector_button_inwin_mode_get()
*
* @ingroup File_Selector_Button
*/
EAPI void elm_fileselector_button_inwin_mode_set(Evas_Object *obj, Eina_Bool value);
/**
* Get whether a given file selector button widget's internal file
* selector will raise an Elementary "inner window", instead of a
* dedicated Elementary window.
*
* @param obj The file selector button widget
* @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
* if it will use a dedicated window
*
* @see elm_fileselector_button_inwin_mode_set() for more details
*
* @ingroup File_Selector_Button
*/
EAPI Eina_Bool elm_fileselector_button_inwin_mode_get(const Evas_Object *obj);