kimcinoo
/
efl
forked from enlightenment/efl
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

fileselector_button: convert docs

This commit is contained in:
Daniel Kolesa 2015-07-02 15:16:36 +01:00
parent a94eca9568
commit 450c63265e
1 changed files with 43 additions and 58 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

101
legacy/elementary/src/lib/elm_fileselector_button.eo
View File

@ -4,95 +4,80 @@ class Elm.Fileselector_Button (Elm.Button, Elm_Interface_Fileselector)
methods {
@property inwin_mode {
set {
/*@
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.
[[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 elm_win_inwin_add() for more information on inner windows
@see elm_fileselector_button_inwin_mode_get()
@ingroup File_Selector_Button */
See @elm_win_inwin_add for more information on inner windows.
See also @elm_fileselector_button_inwin_mode_get.
]]
}
get {
/*@
Get whether a given file selector button widget's internal file
selector will raise an Elementary "inner window", instead of a
dedicated Elementary window.
[[Get whether a given file selector button widget's internal file
selector will raise an Elementary "inner window", instead of a
dedicated Elementary window.
@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 */
See also @elm_fileselector_button_inwin_mode_set for more details.
]]
}
values {
value: bool; /*@ @c EINA_TRUE to make it use an inner window, @c
EINA_FALSE to make it use a dedicated window */
value: bool; [[true to make it use an inner window, false to make
it use a dedicated window]]
}
}
@property window_size {
set {
/*@
Set the size of a given file selector button widget's window,
holding the file selector itself.
[[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 @b not under "inwin mode". The default size for the
window (when applicable) is 400x400 pixels.
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 elm_fileselector_button_window_size_get()
@ingroup File_Selector_Button */
See also @elm_fileselector_button_window_size_get.
]]
}
get {
/*@
Get the size of a given file selector button widget's window,
holding the file selector itself.
[[Get the size of a given file selector button widget's window,
holding the file selector itself.
@note Use @c NULL pointers on the size values you're not
interested in: they'll be ignored by the function.
Note: Use 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 */
See also @elm_fileselector_button_window_size_set for more
details.
]]
}
values {
width: Evas.Coord; /*@ The window's width */
height: Evas.Coord; /*@ The window's height */
width: Evas.Coord; [[The window's width]]
height: Evas.Coord; [[The window's height]]
}
}
@property window_title {
set {
/*@
Set the title for a given file selector button widget's window
[[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 @c "Select a file" as titles.
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 @b not under "inwin mode".
Note: It will only take effect if the file selector
button widget is not under "inwin mode".
@see elm_fileselector_button_window_title_get()
@ingroup File_Selector_Button */
See also @elm_fileselector_button_window_title_get.
]]
}
get {
/*@
Get the title for a given file selector button widget's
[[Get the title for a given file selector button widget's
window
@return Title of the file selector button's window
@see elm_fileselector_button_window_title_get() for more details
@ingroup File_Selector_Button */
See also @elm_fileselector_button_window_title_set for more
details.
]]
}
values {
title: const(char)*; /*@ The title string */
title: const(char)*; [[The title string.]]
}
}
}