Naviframe stands for navigation frame. It's a views manager for applications. More...
Functions | |
Evas_Object * | elm_naviframe_add (Evas_Object *parent) |
Add a new Naviframe object to the parent. More... | |
EINA_DEPRECATED void | elm_naviframe_item_title_visible_set (Elm_Object_Item *it, Eina_Bool visible) |
Show/Hide the title area. More... | |
EINA_DEPRECATED Eina_Bool | elm_naviframe_item_title_visible_get (const Elm_Object_Item *it) |
Get a value whether title area is visible or not. More... | |
EOAPI void | elm_obj_naviframe_event_enabled_set (Eina_Bool enabled) |
Control the event enabled when pushing/popping items. More... | |
EOAPI Eina_Bool | elm_obj_naviframe_event_enabled_get (void) |
Control the event enabled when pushing/popping items. More... | |
EOAPI void | elm_obj_naviframe_content_preserve_on_pop_set (Eina_Bool preserve) |
Preserve the content objects when items are popped. More... | |
EOAPI Eina_Bool | elm_obj_naviframe_content_preserve_on_pop_get (void) |
Preserve the content objects when items are popped. More... | |
EOAPI void | elm_obj_naviframe_prev_btn_auto_pushed_set (Eina_Bool auto_pushed) |
Control if creating prev button automatically or not. More... | |
EOAPI Eina_Bool | elm_obj_naviframe_prev_btn_auto_pushed_get (void) |
Control if creating prev button automatically or not. More... | |
EOAPI Eina_List * | elm_obj_naviframe_items_get (void) |
Get a list of all the naviframe items. More... | |
EOAPI Elm_Widget_Item * | elm_obj_naviframe_top_item_get (void) |
Get a top item on the naviframe stack. More... | |
EOAPI Elm_Widget_Item * | elm_obj_naviframe_bottom_item_get (void) |
Get a bottom item on the naviframe stack. More... | |
EOAPI Evas_Object * | elm_obj_naviframe_item_pop (void) |
Pop an item that is on top of the stack. More... | |
EOAPI Elm_Widget_Item * | elm_obj_naviframe_item_insert_before (Elm_Widget_Item *before, const char *title_label, Evas_Object *prev_btn, Evas_Object *next_btn, Evas_Object *content, const char *item_style) |
Insert a new item into the naviframe before item before . More... | |
EOAPI Elm_Widget_Item * | elm_obj_naviframe_item_push (const char *title_label, Evas_Object *prev_btn, Evas_Object *next_btn, Evas_Object *content, const char *item_style) |
Push a new item to the top of the naviframe stack (and show it). More... | |
EOAPI void | elm_obj_naviframe_item_simple_promote (Evas_Object *content) |
Simple version of item_promote. More... | |
EOAPI Elm_Widget_Item * | elm_obj_naviframe_item_insert_after (Elm_Widget_Item *after, const char *title_label, Evas_Object *prev_btn, Evas_Object *next_btn, Evas_Object *content, const char *item_style) |
Insert a new item into the naviframe after item after . More... | |
void | elm_naviframe_event_enabled_set (Elm_Naviframe *obj, Eina_Bool enabled) |
Control the event enabled when pushing/popping items. More... | |
Eina_Bool | elm_naviframe_event_enabled_get (const Elm_Naviframe *obj) |
Control the event enabled when pushing/popping items. More... | |
void | elm_naviframe_content_preserve_on_pop_set (Elm_Naviframe *obj, Eina_Bool preserve) |
Preserve the content objects when items are popped. More... | |
Eina_Bool | elm_naviframe_content_preserve_on_pop_get (const Elm_Naviframe *obj) |
Preserve the content objects when items are popped. More... | |
void | elm_naviframe_prev_btn_auto_pushed_set (Elm_Naviframe *obj, Eina_Bool auto_pushed) |
Control if creating prev button automatically or not. More... | |
Eina_Bool | elm_naviframe_prev_btn_auto_pushed_get (const Elm_Naviframe *obj) |
Control if creating prev button automatically or not. More... | |
Eina_List * | elm_naviframe_items_get (const Elm_Naviframe *obj) |
Get a list of all the naviframe items. More... | |
Elm_Widget_Item * | elm_naviframe_top_item_get (const Elm_Naviframe *obj) |
Get a top item on the naviframe stack. More... | |
Elm_Widget_Item * | elm_naviframe_bottom_item_get (const Elm_Naviframe *obj) |
Get a bottom item on the naviframe stack. More... | |
Evas_Object * | elm_naviframe_item_pop (Elm_Naviframe *obj) |
Pop an item that is on top of the stack. More... | |
Elm_Widget_Item * | elm_naviframe_item_insert_before (Elm_Naviframe *obj, Elm_Widget_Item *before, const char *title_label, Evas_Object *prev_btn, Evas_Object *next_btn, Evas_Object *content, const char *item_style) |
Insert a new item into the naviframe before item before . More... | |
Elm_Widget_Item * | elm_naviframe_item_push (Elm_Naviframe *obj, const char *title_label, Evas_Object *prev_btn, Evas_Object *next_btn, Evas_Object *content, const char *item_style) |
Push a new item to the top of the naviframe stack (and show it). More... | |
void | elm_naviframe_item_simple_promote (Elm_Naviframe *obj, Evas_Object *content) |
Simple version of item_promote. More... | |
Elm_Widget_Item * | elm_naviframe_item_insert_after (Elm_Naviframe *obj, Elm_Widget_Item *after, const char *title_label, Evas_Object *prev_btn, Evas_Object *next_btn, Evas_Object *content, const char *item_style) |
Insert a new item into the naviframe after item after . More... | |
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. Due to the characteristics of a stack, even though you push a new item, previous item is not deleted. Previous item will be shown when you pop new item. The transition between views is animated, depending on the theme applied to the widget.
Naviframe views hold spaces to various elements, which are:
One can use elm_object_item_part_content_set, elm_object_item_part_content_get, elm_object_item_part_content_unset functions to handle the contents. The swallow part name should be one of these:
"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 pageOne can use elm_object_item_part_text_set, elm_object_item_part_text_get to handle the text parts. The swallow part name should be one of these:
"default"
- A title label in the title area of the current page "subtitle"
- A 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 elm_naviframe_item_push()).
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 newThis widget emits the following signals, besides the ones sent from Layout:
"transition,finished"
- When the transition is finished in changing the item "title,transition,finished"
- When the title area's transition is finished in changing the state of the title "title,clicked"
- User clicked title area "focused"
- When the naviframe has received focus. (since 1.8) "unfocused"
- When the naviframe has lost focus. (since 1.8) "language,changed"
- the program's language changed (since 1.9)All the parts, for content and text, described here will also be reachable by naviframe items direct calls:
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.
Here is an example on its usage:
Evas_Object* elm_naviframe_add | ( | Evas_Object * | parent | ) |
Add a new Naviframe object to the parent.
parent | Parent object |
NULL
, if it cannot be created Elm_Widget_Item* elm_naviframe_bottom_item_get | ( | const Elm_Naviframe * | obj | ) |
Get a bottom item on the naviframe stack.
NULL
, if the stack is empty References elm_obj_naviframe_bottom_item_get().
Eina_Bool elm_naviframe_content_preserve_on_pop_get | ( | const Elm_Naviframe * | obj | ) |
Preserve the content objects when items are popped.
true
, disable otherwisePreserve the content objects when items are popped.
EINA_TRUE
, preserve mode is enabledReferences elm_obj_naviframe_content_preserve_on_pop_get().
void elm_naviframe_content_preserve_on_pop_set | ( | Elm_Naviframe * | obj, |
Eina_Bool | preserve | ||
) |
Preserve the content objects when items are popped.
[in] | preserve | Enable the preserve mode if true , disable otherwise |
Preserve the content objects when items are popped.
[in] | preserve | Enable the preserve mode if EINA_TRUE , disable otherwise |
References elm_obj_naviframe_content_preserve_on_pop_set().
Eina_Bool elm_naviframe_event_enabled_get | ( | const Elm_Naviframe * | obj | ) |
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.
true
, and ignored otherwise.Control the event enabled when pushing/popping items.
EINA_TRUE
, when event is enabledReferences elm_obj_naviframe_event_enabled_get().
void elm_naviframe_event_enabled_set | ( | Elm_Naviframe * | obj, |
Eina_Bool | 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.
[in] | enabled | Events are received when enabled is true , and ignored otherwise. |
Control the event enabled when pushing/popping items.
If enabled
is EINA_TRUE
, the contents of the naviframe item will receives events from mouse and keyboard during view changing such as item push/pop.
[in] | enabled | Events are received when enabled is EINA_TRUE , and ignored otherwise. |
References elm_obj_naviframe_event_enabled_set().
Elm_Widget_Item* elm_naviframe_item_insert_after | ( | Elm_Naviframe * | obj, |
Elm_Widget_Item * | after, | ||
const char * | title_label, | ||
Evas_Object * | prev_btn, | ||
Evas_Object * | next_btn, | ||
Evas_Object * | content, | ||
const char * | item_style | ||
) |
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"
[in] | title_label | The label in the title area. The name of the title label part is "elm.text.title" |
[in] | prev_btn | 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 | 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 | The main content object. The name of content part is "elm.swallow.content" |
[in] | item_style | The current item style name. NULL would be default. |
NULL
upon failure.Insert a new item into the naviframe after item after
.
NULL
upon failure.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"
[in] | after | The naviframe item to insert after. |
[in] | title_label | The label in the title area. The name of the title label part is "elm.text.title" |
[in] | prev_btn | 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 | 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 | The main content object. The name of content part is "elm.swallow.content" |
[in] | item_style | The current item style name. NULL would be default. |
References elm_obj_naviframe_item_insert_after().
Elm_Widget_Item* elm_naviframe_item_insert_before | ( | Elm_Naviframe * | obj, |
Elm_Widget_Item * | before, | ||
const char * | title_label, | ||
Evas_Object * | prev_btn, | ||
Evas_Object * | next_btn, | ||
Evas_Object * | content, | ||
const char * | item_style | ||
) |
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.
[in] | title_label | The label in the title area. The name of the title label part is "elm.text.title" |
[in] | prev_btn | 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 | 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 | The main content object. The name of content part is "elm.swallow.content" |
[in] | item_style | The current item style name. NULL would be default. |
NULL
upon failure.Insert a new item into the naviframe before item before
.
NULL
upon failure.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"
[in] | before | The naviframe item to insert before. |
[in] | title_label | The label in the title area. The name of the title label part is "elm.text.title" |
[in] | prev_btn | 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 | 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 | The main content object. The name of content part is "elm.swallow.content" |
[in] | item_style | The current item style name. NULL would be default. |
References elm_obj_naviframe_item_insert_before().
Evas_Object* elm_naviframe_item_pop | ( | Elm_Naviframe * | obj | ) |
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.
NULL
or the content object(if the elm_naviframe_content_preserve_on_pop_get is true).NULL
or the content object(if the elm_naviframe_content_preserve_on_pop_get is true).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.
References elm_obj_naviframe_item_pop().
Elm_Widget_Item* elm_naviframe_item_push | ( | Elm_Naviframe * | obj, |
const char * | title_label, | ||
Evas_Object * | prev_btn, | ||
Evas_Object * | next_btn, | ||
Evas_Object * | content, | ||
const char * | item_style | ||
) |
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"
[in] | prev_btn | 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 | 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 | The main content object. The name of content part is "elm.swallow.content" |
[in] | item_style | The current item style name. NULL would be default. |
NULL
upon failure.NULL
upon failure.The item pushed becomes one page of the naviframe, this item will be deleted when it is popped.
The following styles are available for this item:
"default"
[in] | title_label | The label in the title area. The name of the title label part is "elm.text.title" |
[in] | prev_btn | 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 | 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 | The main content object. The name of content part is "elm.swallow.content" |
[in] | item_style | The current item style name. NULL would be default. |
References elm_obj_naviframe_item_push().
void elm_naviframe_item_simple_promote | ( | Elm_Naviframe * | obj, |
Evas_Object * | content | ||
) |
Simple version of item_promote.
[in] | content |
[in] | content | No description supplied. |
References elm_obj_naviframe_item_simple_promote().
EINA_DEPRECATED Eina_Bool elm_naviframe_item_title_visible_get | ( | const Elm_Object_Item * | it | ) |
Get a value whether title area is visible or not.
it | The naviframe item |
EINA_TRUE
, title area is visibleEINA_DEPRECATED void elm_naviframe_item_title_visible_set | ( | Elm_Object_Item * | it, |
Eina_Bool | visible | ||
) |
Show/Hide the title area.
it | The naviframe item |
visible | If EINA_TRUE , title area will be visible, hidden otherwise |
When the title area is invisible, then the controls would be hidden so as to expand the content area to full-size.
Eina_List* elm_naviframe_items_get | ( | const Elm_Naviframe * | obj | ) |
Get a list of all the naviframe items.
NULL
on failure. Note: The returned list MUST be freed.NULL
on failure. References elm_obj_naviframe_items_get().
Eina_Bool elm_naviframe_prev_btn_auto_pushed_get | ( | const Elm_Naviframe * | obj | ) |
Control if creating prev button automatically or not.
true
, the previous button(back button) will be created internally when you pass the NULL
to the prev_btn parameter in elm_naviframe_item_pushControl if creating prev button automatically or not.
EINA_TRUE
, prev button will be auto pushed.References elm_obj_naviframe_prev_btn_auto_pushed_get().
void elm_naviframe_prev_btn_auto_pushed_set | ( | Elm_Naviframe * | obj, |
Eina_Bool | auto_pushed | ||
) |
Control if creating prev button automatically or not.
[in] | auto_pushed | 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 |
Control if creating prev button automatically or not.
[in] | auto_pushed | If EINA_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 |
References elm_obj_naviframe_prev_btn_auto_pushed_set().
Elm_Widget_Item* elm_naviframe_top_item_get | ( | const Elm_Naviframe * | obj | ) |
Get a top item on the naviframe stack.
NULL
, if the stack is empty References elm_obj_naviframe_top_item_get().
EOAPI Elm_Widget_Item* elm_obj_naviframe_bottom_item_get | ( | void | ) |
Get a bottom item on the naviframe stack.
NULL
, if the stack is empty Referenced by elm_naviframe_bottom_item_get().
EOAPI Eina_Bool elm_obj_naviframe_content_preserve_on_pop_get | ( | void | ) |
Preserve the content objects when items are popped.
true
, disable otherwise Referenced by elm_naviframe_content_preserve_on_pop_get().
EOAPI void elm_obj_naviframe_content_preserve_on_pop_set | ( | Eina_Bool | preserve | ) |
Preserve the content objects when items are popped.
[in] | preserve | Enable the preserve mode if true , disable otherwise |
Referenced by elm_naviframe_content_preserve_on_pop_set().
EOAPI Eina_Bool elm_obj_naviframe_event_enabled_get | ( | void | ) |
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.
true
, and ignored otherwise. Referenced by elm_naviframe_event_enabled_get().
EOAPI void elm_obj_naviframe_event_enabled_set | ( | Eina_Bool | 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.
[in] | enabled | Events are received when enabled is true , and ignored otherwise. |
Referenced by elm_naviframe_event_enabled_set().
EOAPI Elm_Widget_Item* elm_obj_naviframe_item_insert_after | ( | Elm_Widget_Item * | after, |
const char * | title_label, | ||
Evas_Object * | prev_btn, | ||
Evas_Object * | next_btn, | ||
Evas_Object * | content, | ||
const char * | item_style | ||
) |
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"
[in] | title_label | The label in the title area. The name of the title label part is "elm.text.title" |
[in] | prev_btn | 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 | 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 | The main content object. The name of content part is "elm.swallow.content" |
[in] | item_style | The current item style name. NULL would be default. |
NULL
upon failure. Referenced by elm_naviframe_item_insert_after().
EOAPI Elm_Widget_Item* elm_obj_naviframe_item_insert_before | ( | Elm_Widget_Item * | before, |
const char * | title_label, | ||
Evas_Object * | prev_btn, | ||
Evas_Object * | next_btn, | ||
Evas_Object * | content, | ||
const char * | item_style | ||
) |
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.
[in] | title_label | The label in the title area. The name of the title label part is "elm.text.title" |
[in] | prev_btn | 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 | 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 | The main content object. The name of content part is "elm.swallow.content" |
[in] | item_style | The current item style name. NULL would be default. |
NULL
upon failure. Referenced by elm_naviframe_item_insert_before().
EOAPI Evas_Object* elm_obj_naviframe_item_pop | ( | void | ) |
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.
NULL
or the content object(if the elm_naviframe_content_preserve_on_pop_get is true). Referenced by elm_naviframe_item_pop().
EOAPI Elm_Widget_Item* elm_obj_naviframe_item_push | ( | const char * | title_label, |
Evas_Object * | prev_btn, | ||
Evas_Object * | next_btn, | ||
Evas_Object * | content, | ||
const char * | item_style | ||
) |
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"
[in] | prev_btn | 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 | 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 | The main content object. The name of content part is "elm.swallow.content" |
[in] | item_style | The current item style name. NULL would be default. |
NULL
upon failure. Referenced by elm_naviframe_item_push().
EOAPI void elm_obj_naviframe_item_simple_promote | ( | Evas_Object * | content | ) |
Simple version of item_promote.
[in] | content |
Referenced by elm_naviframe_item_simple_promote().
EOAPI Eina_List* elm_obj_naviframe_items_get | ( | void | ) |
Get a list of all the naviframe items.
NULL
on failure. Note: The returned list MUST be freed. Referenced by elm_naviframe_items_get().
EOAPI Eina_Bool elm_obj_naviframe_prev_btn_auto_pushed_get | ( | void | ) |
Control if creating prev button automatically or not.
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 Referenced by elm_naviframe_prev_btn_auto_pushed_get().
EOAPI void elm_obj_naviframe_prev_btn_auto_pushed_set | ( | Eina_Bool | auto_pushed | ) |
Control if creating prev button automatically or not.
[in] | auto_pushed | 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 |
Referenced by elm_naviframe_prev_btn_auto_pushed_set().
EOAPI Elm_Widget_Item* elm_obj_naviframe_top_item_get | ( | void | ) |
Get a top item on the naviframe stack.
NULL
, if the stack is empty Referenced by elm_naviframe_top_item_get().