2019-03-05 14:00:37 -08:00
|
|
|
#ifndef _ELM_NAVIFRAME_EO_H_
|
|
|
|
#define _ELM_NAVIFRAME_EO_H_
|
|
|
|
|
|
|
|
#ifndef _ELM_NAVIFRAME_EO_CLASS_TYPE
|
|
|
|
#define _ELM_NAVIFRAME_EO_CLASS_TYPE
|
|
|
|
|
|
|
|
typedef Eo Elm_Naviframe;
|
|
|
|
|
|
|
|
#endif
|
|
|
|
|
|
|
|
#ifndef _ELM_NAVIFRAME_EO_TYPES
|
|
|
|
#define _ELM_NAVIFRAME_EO_TYPES
|
|
|
|
|
|
|
|
|
|
|
|
#endif
|
|
|
|
/** Elementary naviframe class
|
|
|
|
*
|
|
|
|
* @ingroup Elm_Naviframe
|
|
|
|
*/
|
|
|
|
#define ELM_NAVIFRAME_CLASS elm_naviframe_class_get()
|
|
|
|
|
efl: make all _class_get() functions const
please note, not the return type, but the function.
When appending __attribute__((const)) to a function, the compiler is
told that its enough to call this function once in a function.
This is quite often happening when we are efl_data_scope_get and
efl_super in a function that is different from a implemented function.
The compiler now starts to remove the calls that aggressivly that we
need to ensure that these calls are not removed, which means, the static
function calls, and the eo init are now checking the return value of
these functions, to ensure that they are called.
Please note that you now have to be carefull when your app calls
eo_shutdown, if it does so, you *must* call it at the end of a function,
or never call class_get after that anymore.
Overall this improves elm test runs 0.1s which is fair i guess, the main
thing that is faster is textrendering, where is also the point where
this is the most beneficial.
Please note, this replaces 42 occurences of double _class_get() ... THAT
is a sign!
Reviewed-by: Stefan Schmidt <stefan@datenfreihafen.org>
Reviewed-by: Daniel Kolesa <daniel@octaforge.org>
Differential Revision: https://phab.enlightenment.org/D12057
2020-07-16 03:39:23 -07:00
|
|
|
EWAPI const Efl_Class *elm_naviframe_class_get(void) EINA_CONST;
|
2019-03-05 14:00:37 -08:00
|
|
|
|
|
|
|
/**
|
|
|
|
* @brief Control the event enabled when pushing/popping items
|
|
|
|
*
|
|
|
|
* If @c enabled is @c 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.
|
|
|
|
*
|
|
|
|
* @param[in] obj The object.
|
|
|
|
* @param[in] enabled Events are received when enabled is @c true, and ignored
|
|
|
|
* otherwise.
|
|
|
|
*
|
|
|
|
* @ingroup Elm_Naviframe
|
|
|
|
*/
|
|
|
|
EOAPI void elm_obj_naviframe_event_enabled_set(Eo *obj, Eina_Bool enabled);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @brief Control the event enabled when pushing/popping items
|
|
|
|
*
|
|
|
|
* If @c enabled is @c 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.
|
|
|
|
*
|
|
|
|
* @param[in] obj The object.
|
|
|
|
*
|
|
|
|
* @return Events are received when enabled is @c true, and ignored otherwise.
|
|
|
|
*
|
|
|
|
* @ingroup Elm_Naviframe
|
|
|
|
*/
|
|
|
|
EOAPI Eina_Bool elm_obj_naviframe_event_enabled_get(const Eo *obj);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @brief Preserve the content objects when items are popped.
|
|
|
|
*
|
|
|
|
* @param[in] obj The object.
|
|
|
|
* @param[in] preserve Enable the preserve mode if @c true, disable otherwise
|
|
|
|
*
|
|
|
|
* @ingroup Elm_Naviframe
|
|
|
|
*/
|
|
|
|
EOAPI void elm_obj_naviframe_content_preserve_on_pop_set(Eo *obj, Eina_Bool preserve);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @brief Preserve the content objects when items are popped.
|
|
|
|
*
|
|
|
|
* @param[in] obj The object.
|
|
|
|
*
|
|
|
|
* @return Enable the preserve mode if @c true, disable otherwise
|
|
|
|
*
|
|
|
|
* @ingroup Elm_Naviframe
|
|
|
|
*/
|
|
|
|
EOAPI Eina_Bool elm_obj_naviframe_content_preserve_on_pop_get(const Eo *obj);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @brief Control if creating prev button automatically or not
|
|
|
|
*
|
|
|
|
* @param[in] obj The object.
|
|
|
|
* @param[in] auto_pushed If @c true, the previous button(back button) will be
|
|
|
|
* created internally when you pass the @c NULL to the prev_btn parameter in
|
|
|
|
* elm_naviframe_item_push
|
|
|
|
*
|
|
|
|
* @ingroup Elm_Naviframe
|
|
|
|
*/
|
|
|
|
EOAPI void elm_obj_naviframe_prev_btn_auto_pushed_set(Eo *obj, Eina_Bool auto_pushed);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @brief Control if creating prev button automatically or not
|
|
|
|
*
|
|
|
|
* @param[in] obj The object.
|
|
|
|
*
|
|
|
|
* @return If @c true, the previous button(back button) will be created
|
|
|
|
* internally when you pass the @c NULL to the prev_btn parameter in
|
|
|
|
* elm_naviframe_item_push
|
|
|
|
*
|
|
|
|
* @ingroup Elm_Naviframe
|
|
|
|
*/
|
|
|
|
EOAPI Eina_Bool elm_obj_naviframe_prev_btn_auto_pushed_get(const Eo *obj);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @brief Get a list of all the naviframe items.
|
|
|
|
*
|
|
|
|
* @param[in] obj The object.
|
|
|
|
*
|
|
|
|
* @return A list of naviframe items, @ref Elm_Widget_Item, or @c NULL on
|
|
|
|
* failure. Note: The returned list MUST be freed.
|
|
|
|
*
|
|
|
|
* @ingroup Elm_Naviframe
|
|
|
|
*/
|
|
|
|
EOAPI Eina_List *elm_obj_naviframe_items_get(const Eo *obj) EINA_WARN_UNUSED_RESULT;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @brief Get a top item on the naviframe stack
|
|
|
|
*
|
|
|
|
* @param[in] obj The object.
|
|
|
|
*
|
|
|
|
* @return The top item on the naviframe stack or @c NULL, if the stack is
|
|
|
|
* empty
|
|
|
|
*
|
|
|
|
* @ingroup Elm_Naviframe
|
|
|
|
*/
|
|
|
|
EOAPI Elm_Widget_Item *elm_obj_naviframe_top_item_get(const Eo *obj);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @brief Get a bottom item on the naviframe stack
|
|
|
|
*
|
|
|
|
* @param[in] obj The object.
|
|
|
|
*
|
|
|
|
* @return The bottom item on the naviframe stack or @c NULL, if the stack is
|
|
|
|
* empty
|
|
|
|
*
|
|
|
|
* @ingroup Elm_Naviframe
|
|
|
|
*/
|
|
|
|
EOAPI Elm_Widget_Item *elm_obj_naviframe_bottom_item_get(const Eo *obj);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @brief 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.
|
|
|
|
*
|
|
|
|
* @param[in] obj The object.
|
|
|
|
*
|
|
|
|
* @return @c NULL or the content object(if the
|
|
|
|
* elm_naviframe_content_preserve_on_pop_get is true).
|
|
|
|
*
|
|
|
|
* @ingroup Elm_Naviframe
|
|
|
|
*/
|
|
|
|
EOAPI Efl_Canvas_Object *elm_obj_naviframe_item_pop(Eo *obj);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @brief Insert a new item into the naviframe before item @c before.
|
|
|
|
*
|
|
|
|
* The item is inserted into the naviframe straight away without any transition
|
|
|
|
* operations. This item will be deleted when it is popped.
|
|
|
|
*
|
|
|
|
* @param[in] obj The object.
|
|
|
|
* @param[in] before The naviframe item to insert before.
|
|
|
|
* @param[in] title_label The label in the title area. The name of the title
|
|
|
|
* label part is "elm.text.title"
|
|
|
|
* @param[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"
|
|
|
|
* @param[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"
|
|
|
|
* @param[in] content The main content object. The name of content part is
|
|
|
|
* "elm.swallow.content"
|
|
|
|
* @param[in] item_style The current item style name. @c NULL would be default.
|
|
|
|
*
|
|
|
|
* @return The created item or @c NULL upon failure.
|
|
|
|
*
|
|
|
|
* @ingroup Elm_Naviframe
|
|
|
|
*/
|
|
|
|
EOAPI Elm_Widget_Item *elm_obj_naviframe_item_insert_before(Eo *obj, Elm_Widget_Item *before, const char *title_label, Efl_Canvas_Object *prev_btn, Efl_Canvas_Object *next_btn, Efl_Canvas_Object *content, const char *item_style);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @brief 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"
|
|
|
|
*
|
|
|
|
* @param[in] obj The object.
|
|
|
|
* @param[in] title_label The label in the title area. The name of the title
|
|
|
|
* label part is "elm.text.title"
|
|
|
|
* @param[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"
|
|
|
|
* @param[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"
|
|
|
|
* @param[in] content The main content object. The name of content part is
|
|
|
|
* "elm.swallow.content"
|
|
|
|
* @param[in] item_style The current item style name. @c NULL would be default.
|
|
|
|
*
|
|
|
|
* @return The created item or @c NULL upon failure.
|
|
|
|
*
|
|
|
|
* @ingroup Elm_Naviframe
|
|
|
|
*/
|
|
|
|
EOAPI Elm_Widget_Item *elm_obj_naviframe_item_push(Eo *obj, const char *title_label, Efl_Canvas_Object *prev_btn, Efl_Canvas_Object *next_btn, Efl_Canvas_Object *content, const char *item_style);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @brief Simple version of item_promote.
|
|
|
|
*
|
|
|
|
* @param[in] obj The object.
|
|
|
|
* @param[in] content Item to promote
|
|
|
|
*
|
|
|
|
* @ingroup Elm_Naviframe
|
|
|
|
*/
|
|
|
|
EOAPI void elm_obj_naviframe_item_simple_promote(Eo *obj, Efl_Canvas_Object *content);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @brief Insert a new item into the naviframe after item @c 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"
|
|
|
|
*
|
|
|
|
* @param[in] obj The object.
|
|
|
|
* @param[in] after The naviframe item to insert after.
|
|
|
|
* @param[in] title_label The label in the title area. The name of the title
|
|
|
|
* label part is "elm.text.title"
|
|
|
|
* @param[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"
|
|
|
|
* @param[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"
|
|
|
|
* @param[in] content The main content object. The name of content part is
|
|
|
|
* "elm.swallow.content"
|
|
|
|
* @param[in] item_style The current item style name. @c NULL would be default.
|
|
|
|
*
|
|
|
|
* @return The created item or @c NULL upon failure.
|
|
|
|
*
|
|
|
|
* @ingroup Elm_Naviframe
|
|
|
|
*/
|
|
|
|
EOAPI Elm_Widget_Item *elm_obj_naviframe_item_insert_after(Eo *obj, Elm_Widget_Item *after, const char *title_label, Efl_Canvas_Object *prev_btn, Efl_Canvas_Object *next_btn, Efl_Canvas_Object *content, const char *item_style);
|
|
|
|
|
|
|
|
EWAPI extern const Efl_Event_Description _ELM_NAVIFRAME_EVENT_TRANSITION_FINISHED;
|
|
|
|
|
|
|
|
/** Called when naviframe transition finished
|
|
|
|
* @return Efl_Object *
|
|
|
|
*
|
|
|
|
* @ingroup Elm_Naviframe
|
|
|
|
*/
|
|
|
|
#define ELM_NAVIFRAME_EVENT_TRANSITION_FINISHED (&(_ELM_NAVIFRAME_EVENT_TRANSITION_FINISHED))
|
|
|
|
|
|
|
|
EWAPI extern const Efl_Event_Description _ELM_NAVIFRAME_EVENT_TITLE_TRANSITION_FINISHED;
|
|
|
|
|
|
|
|
/** Called when naviframe title transaction finished
|
|
|
|
* @return Efl_Object *
|
|
|
|
*
|
|
|
|
* @ingroup Elm_Naviframe
|
|
|
|
*/
|
|
|
|
#define ELM_NAVIFRAME_EVENT_TITLE_TRANSITION_FINISHED (&(_ELM_NAVIFRAME_EVENT_TITLE_TRANSITION_FINISHED))
|
|
|
|
|
|
|
|
EWAPI extern const Efl_Event_Description _ELM_NAVIFRAME_EVENT_TITLE_CLICKED;
|
|
|
|
|
|
|
|
/** Called when naviframe title was clicked
|
|
|
|
* @return Efl_Object *
|
|
|
|
*
|
|
|
|
* @ingroup Elm_Naviframe
|
|
|
|
*/
|
|
|
|
#define ELM_NAVIFRAME_EVENT_TITLE_CLICKED (&(_ELM_NAVIFRAME_EVENT_TITLE_CLICKED))
|
|
|
|
|
|
|
|
EWAPI extern const Efl_Event_Description _ELM_NAVIFRAME_EVENT_ITEM_ACTIVATED;
|
|
|
|
|
|
|
|
/** Called when naviframe item was activated
|
|
|
|
* @return Efl_Object *
|
|
|
|
*
|
|
|
|
* @ingroup Elm_Naviframe
|
|
|
|
*/
|
|
|
|
#define ELM_NAVIFRAME_EVENT_ITEM_ACTIVATED (&(_ELM_NAVIFRAME_EVENT_ITEM_ACTIVATED))
|
|
|
|
|
|
|
|
#endif
|