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

naviframe_item: convert docs

This commit is contained in:
Daniel Kolesa 2015-08-05 11:38:55 +01:00
parent 34f3771a79
commit c79fdab884
1 changed files with 35 additions and 68 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

95
legacy/elementary/src/lib/elm_naviframe_item.eo
View File

@ -4,95 +4,62 @@ class Elm.Naviframe_Item(Elm.Widget_Item)
methods { methods {
@property style { @property style {
get { get {
/*@ [[Get an item style.]]
Get an item style
@see also elm_naviframe_item_style_set()
@ingroup Naviframe
*/
} }
set { set {
/*@ [[Set an item style.]]
Set an item style
The following styles are available for this item:
@li @c "default"
@see also elm_naviframe_item_style_get()
@ingroup Naviframe
*/
} }
values { values {
style: const (char) * @nullable; /*@ The current item style name. @c NULL would be default */ style: const (char) * @nullable; [[The current item style name. $null would be default]]
} }
} }
pop_to { pop_to {
/*@ [[Pop the top item and delete the items between the top and the
Pop the top item and delete the items between the top and the above above one on the given item.
one on the given item.
The items between the top and the given item will be deleted first, The items between the top and the given item will be deleted
and then the top item will be popped at last. first, and then the top item will be popped at last.
]]
@ingroup Naviframe
*/
} }
title_enabled_get @const { title_enabled_get @const {
/*@ [[Get a value whether title area is enabled or not.]]
Get a value whether title area is enabled or not. return: bool; [[If $true, title area will be enabled, disabled otherwise]]
@see also elm_naviframe_item_title_enabled_set()
@ingroup Naviframe
*/
return: bool; /*@ If @c EINA_TRUE, title area will be enabled, disabled otherwise */
} }
title_enabled_set { title_enabled_set {
/*@ [[Enable/Disable the title area with transition effect
Enable/Disable the title area with transition effect
When the title area is disabled, then the controls would be hidden so as When the title area is disabled, then the controls would be
to expand the content area to full-size. hidden so as to expand the content area to full-size.
]]
@see also elm_naviframe_item_title_enabled_get()
@see also elm_naviframe_item_title_visible_set()
@ingroup Naviframe
*/
params { params {
@in enable: bool; /*@ If @c EINA_TRUE, title area will be enabled, disabled otherwise */ @in enable: bool; [[If $true, title area will be enabled, disabled otherwise]]
@in transition: bool; /*@ If @c EINA_TRUE, transition effect of the title will be visible, invisible otherwise */ @in transition: bool; [[If $true, transition effect of the title will be visible, invisible otherwise]]
} }
} }
promote { promote {
/*@ [[Promote an item already in the naviframe stack to the top of
Promote an item already in the naviframe stack to the top of the stack the stack.
This will take the indicated item and promote it to the top of the stack This will take the indicated item and promote it to the top of
as if it had been pushed there. The item must already be inside the the stack as if it had been pushed there. The item must already
naviframe stack to work. be inside the naviframe stack to work.
*/ ]]
} }
pop_cb_set { pop_cb_set {
/*@ [[Set a function to be called when an item of the naviframe is
Set a function to be called when @c it of the naviframe is going to be going to be popped.
popped.
@param func the callback function. Warning: Don't set "clicked" callback to the prev button
additionally if the function does an exact same logic with
@warning Don't set "clicked" callback to the prev button additionally if the this $func. When hardware back key is pressed then both
function does an exact same logic with this @c func. When hardware back key callbacks will be called.
is pressed then both callbacks will be called.
@since 1.8 @since 1.8
@ingroup Naviframe ]]
*/
params { params {
@in func: Elm_Naviframe_Item_Pop_Cb @nullable; /*@ The callback function */ @in func: Elm_Naviframe_Item_Pop_Cb @nullable; [[The callback function.]]
@in data: void * @optional; /*@ Data to be passed to func call */ @in data: void * @optional; [[Data to be passed to func call.]]
} }
} }
} }