• Python EFL - 1.25
  • python docs
  • other docs
  • EFL

Navigation

  • index
  • modules |
  • next |
  • previous |
  • Home |
  • What is elementary? »
  • Naviframe

Logo

Table of Contents

  • Naviframe
    • Widget description
    • Layout content parts
    • Layout text parts
    • Available styles
    • Emitted signals
    • Inheritance diagram

Previous topic

MultiButtonEntry

Next topic

Need

Quick search

Naviframe¶

../_images/naviframe-preview.png

Widget description¶

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:

  • back button, used to navigate to previous views,

  • next button, used to navigate to next views in the stack,

  • title label,

  • sub-title label,

  • title icon and

  • content area.

Layout content parts¶

  • default - The main content of the current page

  • icon - An icon in the title area of the current page

  • prev_btn - A button of the current page to go to the previous page

  • next_btn - A button of the current page to go to the next page

Layout text parts¶

  • default - Title label in the title area of the current page

  • subtitle - Sub-title label in the title area of the current page

Most of those content objects can be passed at the time of an item creation (see push_to()).

Available styles¶

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 other

  • overlap - like the previous one, but the previous view stays at its place and is overlapped by the new

Emitted signals¶

  • transition,finished - When the transition is finished in changing the item

  • title,transition,finished - When the title area’s transition is finished

  • title,clicked - User clicked title area

  • item,activated - Naviframe item was activated (since 1.19)

All 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.

Inheritance diagram¶

class efl.elementary.Naviframe(Object parent, *args, **kwargs)¶
Parameters
  • parent (efl.evas.Object) – The parent object

  • **kwargs – All the remaining keyword arguments are interpreted as properties of the instance

class efl.elementary.NaviframeItem(title_label=None, Object prev_btn=None, Object next_btn=None, Object content=None, item_style=None, *args, **kwargs)¶
  • "default"

Parameters
  • title_label (string) – The label in the title area. The name of the title label part is “elm.text.title”

  • prev_btn (Button) – The button to go to the previous item. If it is None, then naviframe will create a back button automatically. The name of the prev_btn part is “elm.swallow.prev_btn”

  • next_btn (Button) – 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”

  • content (Object) – The main content object. The name of content part is “elm.swallow.content”

  • item_style (string) – The current item style name. None would be default.

Navigation

  • index
  • modules |
  • next |
  • previous |
  • Home |
  • What is elementary? »
  • Naviframe
© Copyright 2008-2021, Simon Busch, Gustavo Sverzut Barbieri, Ulisses Furquim, ProFUSION embedded systems, Boris Faure, Fabiano Fidencio, Davide Andreoli, Kai Huuhko.
Created using Sphinx 3.5.4.