Enter search terms or a module, class or function name.
Naviframe stands for navigation frame. It’s a views manager for applications.
A naviframe holds views (or pages) as its items. Those items are organized in a stack, so that new items get pushed on top of the old, and only the topmost view is displayed at one time. The transition between views is animated, depending on the theme applied to the widget.
Naviframe views hold spaces to various elements, which are:
default
- The main content of the current pageicon
- An icon in the title area of the current pageprev_btn
- A button of the current page to go to the previous pagenext_btn
- A button of the current page to go to the next pagedefault
- Title label in the title area of the current pagesubtitle
- Sub-title label in the title area of the current pageMost of those content objects can be passed at the time of an item
creation (see push_to()
).
Naviframe items can have different styles, which affect the transition between views, for example. On the default theme, two of them are supported:
basic
- views are switched sliding horizontally, one after the otheroverlap
- like the previous one, but the previous view stays at its place
and is overlapped by the newtransition,finished
- When the transition is finished in changing the itemtitle,transition,finished
- When the title area’s transition is finishedtitle,clicked
- User clicked title areaAll the parts, for content and text, described here will also be reachable by naviframe items direct calls:
delete()
part_text_set()
part_text_get()
part_content_set()
part_content_get()
part_content_unset()
signal_emit()
What happens is that the topmost item of a naviframe will be the widget’s target layout, when accessed directly. Items lying below the top one can be interacted with this way.
efl.elementary.
Naviframe
(Object parent, *args, **kwargs)¶Bases: efl.elementary.__init__.LayoutClass
Parameters: |
|
---|
bottom_item
¶Get a bottom item on the naviframe stack
Type: | NaviframeItem |
---|
bottom_item_get
()¶callback_title_clicked_add
(func, *args, **kwargs)¶User clicked title area.
callback_title_clicked_del
(func)¶callback_title_transition_finished_add
(func, *args, **kwargs)¶When the title transition is finished.
callback_title_transition_finished_del
(func)¶callback_transition_finished_add
(func, *args, **kwargs)¶When the transition is finished in changing the item.
callback_transition_finished_del
(func)¶content_preserve_on_pop
¶Preserve the content objects when items are popped.
Type: | bool |
---|
content_preserve_on_pop_get
()¶content_preserve_on_pop_set
(preserve)¶event_enabled
¶Whether the event when pushing/popping items is enabled
If 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 setting
freeze_events
internally.
So don’t call the API while pushing/popping items.
Type: | bool |
---|
event_enabled_get
()¶event_enabled_set
(enabled)¶item_insert_after
(after, title_label, prev_btn, next_btn, content, item_style)¶item_insert_before
(before, title_label, prev_btn, next_btn, content, item_style)¶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.
See also
Returns: | None or the content object(if
content_preserve_on_pop is True). |
---|---|
Return type: | Object |
item_push
(title_label, prev_btn, next_btn, content, item_style)¶item_simple_promote
(content)¶Simple version of NaviframeItem.promote()
.
See also
item_simple_push
(content)¶Simple version of NaviframeItem.push_to()
.
See also
items
¶Get a list of all the naviframe items.
Type: | tuple of NaviframeItem |
---|
items_get
()¶prev_btn_auto_pushed
¶Whether prev button(back button) will be created automatically or not.
See also
item_push()
Type: | bool |
---|
prev_btn_auto_pushed_get
()¶prev_btn_auto_pushed_set
(auto_pushed)¶top_item
¶Get a top item on the naviframe stack
Type: | NaviframeItem |
---|
top_item_get
()¶efl.elementary.
NaviframeItem
(title_label=None, Object prev_btn=None, Object next_btn=None, Object content=None, item_style=None, *args, **kwargs)¶Bases: efl.elementary.__init__.ObjectItem
"default"
Parameters: |
|
---|
insert_after
(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.
See also
Parameters: | after (NaviframeItem ) – The naviframe item to insert after. |
---|---|
Returns: | The created item or None upon failure. |
Return type: | NaviframeItem |
insert_before
(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.
See also
Parameters: | before (NaviframeItem ) – The naviframe item to insert before. |
---|---|
Returns: | The created item or None upon failure. |
Return type: | NaviframeItem |
pop_cb_set
(func, *args, **kwargs)¶Set a function to be called when the item is going to be popped.
Parameters: | func – the callback function. |
---|
Warning
Don’t set “clicked” callback to the prev button additionally if the
function does an exact same logic with this func
. When hardware
back key is pressed then both callbacks will be called.
New in version 1.14.
pop_to
()¶Pop the items between the top and the above one on the given item.
promote
()¶Promote an item already in the naviframe stack to the top of the stack
This will take the indicated item and promote it to the top of the stack as if it had been pushed there. The item must already be inside the naviframe stack to work.
push_to
(naviframe)¶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.
See also
Returns: | The created item or None upon failure. |
---|---|
Return type: | NaviframeItem |
style
¶The item style.
The following styles are available for this item:
"default"
Type: | string |
---|
style_get
()¶style_set
(style)¶title_enabled
¶Enable/Disable the title area and the transition effect.
When the title area is disabled, then the controls would be hidden so as to expand the content area to full-size.
Type: | getter: bool - setter: (bool, bool) |
---|
Note
This property is somehow strange, the setter and the getter have different param numbers. The second param in the setter choose if the title transition should be animated or not
See also
New in version 1.9.
title_enabled_get
()¶title_enabled_set
(enabled, transition)¶title_visible
¶Show/Hide the title area
When the title area is invisible, then the controls would be hidden so as to expand the content area to full-size.
Type: | bool |
---|
Deprecated since version 1.9: Use title_enabled
instead.
title_visible_get
()¶Deprecated since version 1.9: Use title_enabled_get()
instead.
title_visible_set
(visible)¶Deprecated since version 1.9: Use title_enabled_set()
instead.