2016-08-05 10:31:49 -07:00
class Elm.Naviframe (Elm.Layout, Elm.Interface.Atspi_Widget_Action)
2014-03-30 01:51:39 -07:00
{
2016-05-12 09:06:04 -07:00
legacy_prefix: elm_naviframe;
2014-03-30 01:51:39 -07:00
eo_prefix: elm_obj_naviframe;
2016-05-17 09:14:47 -07:00
event_prefix: elm_naviframe;
2015-05-07 09:32:53 -07:00
methods {
@property event_enabled {
2015-08-07 05:30:05 -07:00
[[Control the event enabled when pushing/popping items
2014-03-30 01:51:39 -07:00
2015-08-07 05:30:05 -07:00
If $enabled is $true, the contents of the naviframe item will
receives events from mouse and keyboard during view changing such as
item push/pop.
2014-03-30 01:51:39 -07:00
2015-08-07 05:30:05 -07:00
Warning: Events will be blocked by calling evas_object_freeze_events_set()
internally. So don't call the API whiling pushing/popping items.]]
set {
2014-03-30 01:51:39 -07:00
}
get {
}
values {
2015-08-07 05:30:05 -07:00
enabled: bool; [[Events are received when enabled is $true, and ignored otherwise.]]
2014-03-30 01:51:39 -07:00
}
}
2015-05-07 09:32:53 -07:00
@property content_preserve_on_pop {
2015-08-07 05:30:05 -07:00
[[Preserve the content objects when items are popped.]]
2014-03-30 01:51:39 -07:00
set {
}
get {
}
values {
2015-08-07 05:30:05 -07:00
preserve: bool; [[Enable the preserve mode if $true, disable otherwise]]
2014-03-30 01:51:39 -07:00
}
}
2015-05-07 09:32:53 -07:00
@property prev_btn_auto_pushed {
2015-08-07 05:30:05 -07:00
[[Control if creating prev button automatically or not]]
2014-03-30 01:51:39 -07:00
set {
}
get {
}
values {
2015-08-07 05:30:05 -07:00
auto_pushed: bool; [[If $true, the previous button(back button) will be created internally when you pass the $NULL to the prev_btn parameter in elm_naviframe_item_push]]
2014-03-30 01:51:39 -07:00
}
}
2015-05-07 09:32:53 -07:00
@property items {
2014-03-30 01:51:39 -07:00
get {
2015-08-07 05:30:05 -07:00
[[Get a list of all the naviframe items.]]
2014-03-30 01:51:39 -07:00
2016-05-23 07:41:28 -07:00
return: free(own(list<Elm.Widget.Item>), eina_list_free) @warn_unused; [[A list of naviframe items, @Elm.Widget.Item, or $NULL on failure. Note: The returned list MUST be freed.]]
2014-03-30 01:51:39 -07:00
}
}
2015-05-07 09:32:53 -07:00
@property top_item {
2014-03-30 01:51:39 -07:00
get {
2015-08-07 05:30:05 -07:00
[[Get a top item on the naviframe stack]]
2014-03-30 01:51:39 -07:00
2016-05-23 07:41:28 -07:00
return: Elm.Widget.Item; [[The top item on the naviframe stack or $NULL, if the stack is empty]]
2014-03-30 01:51:39 -07:00
}
}
2015-05-07 09:32:53 -07:00
@property bottom_item {
2014-03-30 01:51:39 -07:00
get {
2015-08-07 05:30:05 -07:00
[[Get a bottom item on the naviframe stack]]
2014-03-30 01:51:39 -07:00
2016-05-23 07:41:28 -07:00
return: Elm.Widget.Item; [[The bottom item on the naviframe stack or $NULL, if the stack is empty]]
2014-03-30 01:51:39 -07:00
}
}
item_pop {
2015-08-07 05:30:05 -07:00
[[Pop an item that is on top of the stack
2014-03-30 01:51:39 -07:00
2015-08-07 05:30:05 -07:00
This pops an item that is on the top(visible) of the naviframe, makes it
disappear, then deletes the item. The item that was underneath it on the
2015-08-28 02:28:19 -07:00
stack will become visible.
When pop transition animation is in progress, new pop operation is blocked until current pop operation
is complete.
]]
2014-03-30 01:51:39 -07:00
2016-06-20 21:26:15 -07:00
return: Efl.Canvas.Object; [[$NULL or the content object(if the elm_naviframe_content_preserve_on_pop_get is true).]]
2014-03-30 01:51:39 -07:00
}
item_insert_before {
2015-08-07 05:30:05 -07:00
[[Insert a new item into the naviframe before item $before.
2014-03-30 01:51:39 -07:00
2015-08-07 05:30:05 -07:00
The item is inserted into the naviframe straight away without any
transition operations. This item will be deleted when it is popped.]]
2014-03-30 01:51:39 -07:00
2016-05-23 07:41:28 -07:00
return: Elm.Widget.Item; [[The created item or $NULL upon failure.]]
2014-03-30 01:51:39 -07:00
params {
2016-05-23 07:41:28 -07:00
@in before: Elm.Widget.Item; [[The naviframe item to insert before.]]
2016-05-31 08:02:26 -07:00
@in title_label: string @optional; [[The label in the title area. The name of the title label part is "elm.text.title"]]
2016-06-20 21:26:15 -07:00
@in prev_btn: Efl.Canvas.Object @nullable; [[The button to go to the previous item. If it is NULL, then naviframe will create a back button automatically. The name of the prev_btn part is "elm.swallow.prev_btn"]]
@in next_btn: Efl.Canvas.Object @nullable; [[The button to go to the next item. Or It could be just an extra function button. The name of the next_btn part is "elm.swallow.next_btn"]]
@in content: Efl.Canvas.Object; [[The main content object. The name of content part is "elm.swallow.content"]]
2016-05-31 08:02:26 -07:00
@in item_style: string @nullable; [[The current item style name. $NULL would be default.]]
2014-03-30 01:51:39 -07:00
}
}
item_push {
2015-08-07 05:30:05 -07:00
[[Push a new item to the top of the naviframe stack (and show it).
2014-03-30 01:51:39 -07:00
2015-08-07 05:30:05 -07:00
The item pushed becomes one page of the naviframe, this item will be
deleted when it is popped.
2015-08-28 02:28:19 -07:00
When push transition animation is in progress, pop operation is blocked until push is complete.
2014-03-30 01:51:39 -07:00
2015-08-07 05:30:05 -07:00
The following styles are available for this item:
"default"]]
2014-03-30 01:51:39 -07:00
2016-05-23 07:41:28 -07:00
return: Elm.Widget.Item; [[The created item or $NULL upon failure.]]
2014-03-30 01:51:39 -07:00
params {
2016-05-31 08:02:26 -07:00
@in title_label: string @optional; [[The label in the title area. The name of the title label part is "elm.text.title"]]
2016-06-20 21:26:15 -07:00
@in prev_btn: Efl.Canvas.Object @nullable; [[The button to go to the previous item. If it is NULL, then naviframe will create a back button automatically. The name of the prev_btn part is "elm.swallow.prev_btn"]]
@in next_btn: Efl.Canvas.Object @nullable; [[The button to go to the next item. Or It could be just an extra function button. The name of the next_btn part is "elm.swallow.next_btn"]]
@in content: Efl.Canvas.Object; [[The main content object. The name of content part is "elm.swallow.content"]]
2016-05-31 08:02:26 -07:00
@in item_style: string @nullable; [[The current item style name. $NULL would be default.]]
2014-03-30 01:51:39 -07:00
}
}
item_simple_promote {
2015-08-07 05:30:05 -07:00
[[Simple version of item_promote.]]
2014-03-30 01:51:39 -07:00
params {
2016-06-20 21:26:15 -07:00
@in content: Efl.Canvas.Object;
2014-03-30 01:51:39 -07:00
}
}
item_insert_after {
2015-08-07 05:30:05 -07:00
[[Insert a new item into the naviframe after item $after.
2014-03-30 01:51:39 -07:00
2015-08-07 05:30:05 -07:00
The item is inserted into the naviframe straight away without any
transition operations. This item will be deleted when it is popped.
2014-03-30 01:51:39 -07:00
2015-08-07 05:30:05 -07:00
The following styles are available for this item:
"default"]]
2014-03-30 01:51:39 -07:00
2016-05-23 07:41:28 -07:00
return: Elm.Widget.Item; [[The created item or $NULL upon failure.]]
2014-03-30 01:51:39 -07:00
params {
2016-05-23 07:41:28 -07:00
@in after: Elm.Widget.Item; [[The naviframe item to insert after.]]
2016-05-31 08:02:26 -07:00
@in title_label: string @optional; [[The label in the title area. The name of the title label part is "elm.text.title"]]
2016-06-20 21:26:15 -07:00
@in prev_btn: Efl.Canvas.Object @nullable; [[The button to go to the previous item. If it is NULL, then naviframe will create a back button automatically. The name of the prev_btn part is "elm.swallow.prev_btn"]]
@in next_btn: Efl.Canvas.Object @nullable; [[The button to go to the next item. Or It could be just an extra function button. The name of the next_btn part is "elm.swallow.next_btn"]]
@in content: Efl.Canvas.Object; [[The main content object. The name of content part is "elm.swallow.content"]]
2016-05-31 08:02:26 -07:00
@in item_style: string @nullable; [[The current item style name. $NULL would be default.]]
2014-03-30 01:51:39 -07:00
}
}
}
implements {
2014-06-20 02:47:39 -07:00
class.constructor;
2014-06-27 15:36:05 -07:00
Eo.Base.constructor;
2016-06-17 01:26:08 -07:00
Efl.Canvas.Group.group_del;
Efl.Canvas.Group.group_show;
Efl.Canvas.Group.group_add;
2015-04-22 04:33:10 -07:00
Elm.Widget.focus_direction;
Elm.Widget.focus_next_manager_is;
Elm.Widget.focus_direction_manager_is;
Elm.Widget.access;
Elm.Widget.focus_next;
Elm.Widget.translate;
Elm.Widget.theme_apply;
Elm.Widget.event;
2014-12-09 10:41:16 -08:00
Elm.Layout.text.set;
Elm.Layout.text.get;
2016-08-05 10:31:49 -07:00
Elm.Layout.signal_emit;
2015-04-22 04:37:40 -07:00
Elm.Layout.sizing_eval;
2016-05-12 03:37:43 -07:00
Elm.Interface.Atspi_Widget_Action.elm_actions.get;
2016-05-24 04:40:18 -07:00
Efl.Part.part;
2014-03-30 01:51:39 -07:00
}
events {
transition,finished;
title,transition,finished;
title,clicked;
}
}