forked from enlightenment/efl
170 lines
7.3 KiB
Plaintext
170 lines
7.3 KiB
Plaintext
class Elm.Naviframe (Elm.Layout, Elm.Interface.Atspi_Widget_Action)
|
|
{
|
|
legacy_prefix: elm_naviframe;
|
|
eo_prefix: elm_obj_naviframe;
|
|
event_prefix: elm_naviframe;
|
|
methods {
|
|
@property event_enabled {
|
|
[[Control the event enabled when pushing/popping items
|
|
|
|
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.
|
|
|
|
Warning: Events will be blocked by calling evas_object_freeze_events_set()
|
|
internally. So don't call the API whiling pushing/popping items.]]
|
|
set {
|
|
}
|
|
get {
|
|
}
|
|
values {
|
|
enabled: bool; [[Events are received when enabled is $true, and ignored otherwise.]]
|
|
}
|
|
}
|
|
@property content_preserve_on_pop {
|
|
[[Preserve the content objects when items are popped.]]
|
|
set {
|
|
}
|
|
get {
|
|
}
|
|
values {
|
|
preserve: bool; [[Enable the preserve mode if $true, disable otherwise]]
|
|
}
|
|
}
|
|
@property prev_btn_auto_pushed {
|
|
[[Control if creating prev button automatically or not]]
|
|
set {
|
|
}
|
|
get {
|
|
}
|
|
values {
|
|
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]]
|
|
}
|
|
}
|
|
@property items {
|
|
get {
|
|
[[Get a list of all the naviframe items.]]
|
|
|
|
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.]]
|
|
}
|
|
}
|
|
@property top_item {
|
|
get {
|
|
[[Get a top item on the naviframe stack]]
|
|
|
|
return: Elm.Widget.Item; [[The top item on the naviframe stack or $NULL, if the stack is empty]]
|
|
}
|
|
}
|
|
@property bottom_item {
|
|
get {
|
|
[[Get a bottom item on the naviframe stack]]
|
|
|
|
return: Elm.Widget.Item; [[The bottom item on the naviframe stack or $NULL, if the stack is empty]]
|
|
}
|
|
}
|
|
item_pop {
|
|
[[Pop an item that is on top of the stack
|
|
|
|
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
|
|
stack will become visible.
|
|
|
|
When pop transition animation is in progress, new pop operation is blocked until current pop operation
|
|
is complete.
|
|
]]
|
|
|
|
return: Evas.Object; [[$NULL or the content object(if the elm_naviframe_content_preserve_on_pop_get is true).]]
|
|
}
|
|
item_insert_before {
|
|
[[Insert a new item into the naviframe before item $before.
|
|
|
|
The item is inserted into the naviframe straight away without any
|
|
transition operations. This item will be deleted when it is popped.]]
|
|
|
|
return: Elm.Widget.Item; [[The created item or $NULL upon failure.]]
|
|
params {
|
|
@in before: Elm.Widget.Item; [[The naviframe item to insert before.]]
|
|
@in title_label: string @optional; [[The label in the title area. The name of the title label part is "elm.text.title"]]
|
|
@in prev_btn: Evas.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: Evas.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: Evas.Object; [[The main content object. The name of content part is "elm.swallow.content"]]
|
|
@in item_style: string @nullable; [[The current item style name. $NULL would be default.]]
|
|
}
|
|
}
|
|
item_push {
|
|
[[Push a new item to the top of the naviframe stack (and show it).
|
|
|
|
|
|
The item pushed becomes one page of the naviframe, this item will be
|
|
deleted when it is popped.
|
|
|
|
When push transition animation is in progress, pop operation is blocked until push is complete.
|
|
|
|
The following styles are available for this item:
|
|
"default"]]
|
|
|
|
return: Elm.Widget.Item; [[The created item or $NULL upon failure.]]
|
|
params {
|
|
@in title_label: string @optional; [[The label in the title area. The name of the title label part is "elm.text.title"]]
|
|
@in prev_btn: Evas.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: Evas.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: Evas.Object; [[The main content object. The name of content part is "elm.swallow.content"]]
|
|
@in item_style: string @nullable; [[The current item style name. $NULL would be default.]]
|
|
}
|
|
}
|
|
item_simple_promote {
|
|
[[Simple version of item_promote.]]
|
|
|
|
params {
|
|
@in content: Evas.Object;
|
|
}
|
|
}
|
|
item_insert_after {
|
|
[[Insert a new item into the naviframe after item $after.
|
|
|
|
The item is inserted into the naviframe straight away without any
|
|
transition operations. This item will be deleted when it is popped.
|
|
|
|
The following styles are available for this item:
|
|
"default"]]
|
|
|
|
return: Elm.Widget.Item; [[The created item or $NULL upon failure.]]
|
|
params {
|
|
@in after: Elm.Widget.Item; [[The naviframe item to insert after.]]
|
|
@in title_label: string @optional; [[The label in the title area. The name of the title label part is "elm.text.title"]]
|
|
@in prev_btn: Evas.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: Evas.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: Evas.Object; [[The main content object. The name of content part is "elm.swallow.content"]]
|
|
@in item_style: string @nullable; [[The current item style name. $NULL would be default.]]
|
|
}
|
|
}
|
|
}
|
|
implements {
|
|
class.constructor;
|
|
Eo.Base.constructor;
|
|
Evas.Object.Smart.del;
|
|
Evas.Object.Smart.show;
|
|
Evas.Object.Smart.add;
|
|
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;
|
|
Elm.Layout.text.set;
|
|
Elm.Layout.text.get;
|
|
Elm.Layout.signal_emit;
|
|
Elm.Layout.sizing_eval;
|
|
Elm.Interface.Atspi_Widget_Action.elm_actions.get;
|
|
Efl.Part.part;
|
|
}
|
|
events {
|
|
transition,finished;
|
|
title,transition,finished;
|
|
title,clicked;
|
|
}
|
|
|
|
}
|