Context popup widget. More...
Macros | |
#define | ELM_CTXPOPUP_CLASS elm_ctxpopup_class_get() |
Elementary context popup class. | |
#define | ELM_CTXPOPUP_EVENT_DISMISSED (&(_ELM_CTXPOPUP_EVENT_DISMISSED)) |
Called when context popup was dismissed. | |
#define | ELM_CTXPOPUP_EVENT_GEOMETRY_UPDATE (&(_ELM_CTXPOPUP_EVENT_GEOMETRY_UPDATE)) |
Called when context popup geometry was updated. | |
Enumerations | |
enum | Elm_Ctxpopup_Direction { ELM_CTXPOPUP_DIRECTION_DOWN = 0, ELM_CTXPOPUP_DIRECTION_RIGHT, ELM_CTXPOPUP_DIRECTION_LEFT, ELM_CTXPOPUP_DIRECTION_UP, ELM_CTXPOPUP_DIRECTION_UNKNOWN, ELM_CTXPOPUP_DIRECTION_DOWN = 0, ELM_CTXPOPUP_DIRECTION_RIGHT, ELM_CTXPOPUP_DIRECTION_LEFT, ELM_CTXPOPUP_DIRECTION_UP, ELM_CTXPOPUP_DIRECTION_UNKNOWN } |
Direction in which to show the popup. More... | |
enum | Elm_Ctxpopup_Direction { ELM_CTXPOPUP_DIRECTION_DOWN = 0, ELM_CTXPOPUP_DIRECTION_RIGHT, ELM_CTXPOPUP_DIRECTION_LEFT, ELM_CTXPOPUP_DIRECTION_UP, ELM_CTXPOPUP_DIRECTION_UNKNOWN, ELM_CTXPOPUP_DIRECTION_DOWN = 0, ELM_CTXPOPUP_DIRECTION_RIGHT, ELM_CTXPOPUP_DIRECTION_LEFT, ELM_CTXPOPUP_DIRECTION_UP, ELM_CTXPOPUP_DIRECTION_UNKNOWN } |
Direction in which to show the popup. More... | |
Functions | |
Evas_Object * | elm_ctxpopup_add (Evas_Object *parent) |
Add a new Ctxpopup object to the parent. More... | |
void | elm_ctxpopup_horizontal_set (Evas_Object *obj, Eina_Bool horizontal) |
Change the ctxpopup's orientation to horizontal or vertical. More... | |
Eina_Bool | elm_ctxpopup_horizontal_get (const Evas_Object *obj) |
Get the value of current ctxpopup object's orientation. More... | |
const Eina_List * | elm_ctxpopup_items_get (const Evas_Object *obj) |
Get the internal list of items in a given ctxpopup widget. More... | |
Elm_Widget_Item * | elm_ctxpopup_first_item_get (const Evas_Object *obj) |
Get the first item in the given ctxpopup widget's list of items. More... | |
Elm_Widget_Item * | elm_ctxpopup_last_item_get (const Evas_Object *obj) |
Get the last item in the given ctxpopup widget's list of items. More... | |
EOAPI void | elm_obj_ctxpopup_auto_hide_disabled_set (Eo *obj, Eina_Bool disabled) |
Set ctxpopup auto hide mode triggered by ctxpopup policy. More... | |
EOAPI Eina_Bool | elm_obj_ctxpopup_auto_hide_disabled_get (const Eo *obj) |
Get ctxpopup auto hide mode triggered by ctxpopup policy. More... | |
EOAPI void | elm_obj_ctxpopup_hover_parent_set (Eo *obj, Efl_Canvas_Object *parent) |
Set the Ctxpopup's parent. More... | |
EOAPI Efl_Canvas_Object * | elm_obj_ctxpopup_hover_parent_get (const Eo *obj) |
Get the Ctxpopup's parent. More... | |
EOAPI void | elm_obj_ctxpopup_direction_priority_set (Eo *obj, Elm_Ctxpopup_Direction first, Elm_Ctxpopup_Direction second, Elm_Ctxpopup_Direction third, Elm_Ctxpopup_Direction fourth) |
Set the direction priority of a ctxpopup. More... | |
EOAPI void | elm_obj_ctxpopup_direction_priority_get (const Eo *obj, Elm_Ctxpopup_Direction *first, Elm_Ctxpopup_Direction *second, Elm_Ctxpopup_Direction *third, Elm_Ctxpopup_Direction *fourth) |
Get the direction priority of a ctxpopup. More... | |
EOAPI Elm_Ctxpopup_Direction | elm_obj_ctxpopup_direction_get (const Eo *obj) |
Get the current direction of a ctxpopup. More... | |
EOAPI void | elm_obj_ctxpopup_dismiss (Eo *obj) |
Dismiss a ctxpopup object. More... | |
EOAPI void | elm_obj_ctxpopup_clear (Eo *obj) |
Clear all items in the given ctxpopup object. | |
EOAPI Elm_Widget_Item * | elm_obj_ctxpopup_item_append (Eo *obj, const char *label, Efl_Canvas_Object *icon, Evas_Smart_Cb func, const void *data) |
Add a new item to a ctxpopup object. More... | |
EOAPI Elm_Widget_Item * | elm_obj_ctxpopup_item_prepend (Eo *obj, const char *label, Efl_Canvas_Object *icon, Evas_Smart_Cb func, const void *data) |
Prepend a new item to a ctxpopup object. More... | |
void | elm_ctxpopup_auto_hide_disabled_set (Elm_Ctxpopup *obj, Eina_Bool disabled) |
Set ctxpopup auto hide mode triggered by ctxpopup policy. More... | |
Eina_Bool | elm_ctxpopup_auto_hide_disabled_get (const Elm_Ctxpopup *obj) |
Get ctxpopup auto hide mode triggered by ctxpopup policy. More... | |
void | elm_ctxpopup_hover_parent_set (Elm_Ctxpopup *obj, Efl_Canvas_Object *parent) |
Set the Ctxpopup's parent. More... | |
Efl_Canvas_Object * | elm_ctxpopup_hover_parent_get (const Elm_Ctxpopup *obj) |
Get the Ctxpopup's parent. More... | |
void | elm_ctxpopup_direction_priority_set (Elm_Ctxpopup *obj, Elm_Ctxpopup_Direction first, Elm_Ctxpopup_Direction second, Elm_Ctxpopup_Direction third, Elm_Ctxpopup_Direction fourth) |
Set the direction priority of a ctxpopup. More... | |
void | elm_ctxpopup_direction_priority_get (const Elm_Ctxpopup *obj, Elm_Ctxpopup_Direction *first, Elm_Ctxpopup_Direction *second, Elm_Ctxpopup_Direction *third, Elm_Ctxpopup_Direction *fourth) |
Get the direction priority of a ctxpopup. More... | |
Elm_Ctxpopup_Direction | elm_ctxpopup_direction_get (const Elm_Ctxpopup *obj) |
Get the current direction of a ctxpopup. More... | |
void | elm_ctxpopup_dismiss (Elm_Ctxpopup *obj) |
Dismiss a ctxpopup object. More... | |
void | elm_ctxpopup_clear (Elm_Ctxpopup *obj) |
Clear all items in the given ctxpopup object. | |
Elm_Widget_Item * | elm_ctxpopup_item_append (Elm_Ctxpopup *obj, const char *label, Efl_Canvas_Object *icon, Evas_Smart_Cb func, const void *data) |
Add a new item to a ctxpopup object. More... | |
Elm_Widget_Item * | elm_ctxpopup_item_prepend (Elm_Ctxpopup *obj, const char *label, Efl_Canvas_Object *icon, Evas_Smart_Cb func, const void *data) |
Prepend a new item to a ctxpopup object. More... | |
Context popup widget.
A ctxpopup is a widget that, when shown, pops up a list of items. It automatically chooses an area inside its parent object's view (set via elm_ctxpopup_add() and elm_ctxpopup_hover_parent_set()) to optimally fit into it. In the default theme, it will also point an arrow to it's top left position at the time one shows it. Ctxpopup items have a label and/or an icon. It is intended for a small number of items (hence the use of list, not genlist).
This widget inherits from the Layout one, so that all the functions acting on it also work for context popup objects (since 1.8).
This widget emits the following signals, besides the ones sent from Layout:
"dismissed"
- This is called when 1. the outside of ctxpopup was clicked or 2. its parent area is changed or 3. the language is changed and also when"language,changed"
- This is called when the program's language is changed."focused"
- When the ctxpopup has received focus. (since 1.8)"unfocused"
- When the ctxpopup has lost focus. (since 1.8)"geometry,update"
- When the ctxpopup geometry is updated. This smart event passes the ctxpopup geometry information with the given event_info argument which type is Evas_Coord_Rectangle. (since 1.18)Default content parts of the ctxpopup widget that you can use for are:
Default content parts of the ctxpopup items that you can use for are:
Default text parts of the ctxpopup items that you can use for are:
Supported elm_object common APIs.
Supported elm_object_item common APIs.
tutorial_ctxpopup shows the usage of a good deal of the API.
Direction in which to show the popup.
Direction in which to show the popup.
Evas_Object* elm_ctxpopup_add | ( | Evas_Object * | parent | ) |
Add a new Ctxpopup object to the parent.
parent | Parent object |
NULL
, if it cannot be created void elm_ctxpopup_horizontal_set | ( | Evas_Object * | obj, |
Eina_Bool | horizontal | ||
) |
Change the ctxpopup's orientation to horizontal or vertical.
obj | Elm Ctxpopup object |
horizontal | EINA_TRUE for horizontal mode, EINA_FALSE for vertical. |
Eina_Bool elm_ctxpopup_horizontal_get | ( | const Evas_Object * | obj | ) |
Get the value of current ctxpopup object's orientation.
obj | Elm Ctxpopup object return EINA_TRUE for horizontal mode, EINA_FALSE for vertical. See also elm_ctxpopup_horizontal_set |
References EINA_FALSE, and EINA_TRUE.
const Eina_List* elm_ctxpopup_items_get | ( | const Evas_Object * | obj | ) |
Get the internal list of items in a given ctxpopup widget.
This list is not to be modified in any way and must not be freed. Use the list members with functions like elm_object_item_text_set, elm_object_item_text_get, elm_object_item_del.
obj
object's internal items list is changed. It should be fetched again with another call to this function when changes happen.null
on errors.References EINA_ITERATOR_FOREACH, eina_iterator_free(), and eina_list_append().
Elm_Widget_Item* elm_ctxpopup_first_item_get | ( | const Evas_Object * | obj | ) |
Get the first item in the given ctxpopup widget's list of items.
See also elm_obj_ctxpopup_item_append, elm_obj_ctxpopup_last_item_get.
null
, if it has no items (and on errors).Elm_Widget_Item* elm_ctxpopup_last_item_get | ( | const Evas_Object * | obj | ) |
Get the last item in the given ctxpopup widget's list of items.
See also elm_obj_ctxpopup_item_prepend, elm_obj_ctxpopup_first_item_get.
null
, if it has no items (and on errors).Set ctxpopup auto hide mode triggered by ctxpopup policy.
Use this function when user wants ctxpopup not to hide automatically. By default, ctxpopup is dismissed whenever mouse clicked its background area, language is changed, and its parent geometry is updated(changed). Not to hide ctxpopup automatically, disable auto hide function by calling this API, then ctxpopup won't be dismissed in those scenarios.
Default value of disabled is false
.
See also elm_obj_ctxpopup_auto_hide_disabled_get.
[in] | disabled | Auto hide enable/disable. |
Referenced by elm_ctxpopup_auto_hide_disabled_set().
Get ctxpopup auto hide mode triggered by ctxpopup policy.
See also elm_obj_ctxpopup_auto_hide_disabled_set for more information.
Referenced by elm_ctxpopup_auto_hide_disabled_get().
EOAPI void elm_obj_ctxpopup_hover_parent_set | ( | Eo * | obj, |
Efl_Canvas_Object * | parent | ||
) |
Set the Ctxpopup's parent.
Set the parent object.
parent
argument.See also elm_ctxpopup_add, elm_hover_parent_set.
[in] | parent | The parent to use. |
Referenced by elm_ctxpopup_hover_parent_set().
EOAPI Efl_Canvas_Object* elm_obj_ctxpopup_hover_parent_get | ( | const Eo * | obj | ) |
Get the Ctxpopup's parent.
See also elm_obj_ctxpopup_hover_parent_set for more information
Referenced by elm_ctxpopup_hover_parent_get().
EOAPI void elm_obj_ctxpopup_direction_priority_set | ( | Eo * | obj, |
Elm_Ctxpopup_Direction | first, | ||
Elm_Ctxpopup_Direction | second, | ||
Elm_Ctxpopup_Direction | third, | ||
Elm_Ctxpopup_Direction | fourth | ||
) |
Set the direction priority of a ctxpopup.
This functions gives a chance to user to set the priority of ctxpopup showing direction. This doesn't guarantee the ctxpopup will appear in the requested direction.
See also Elm_Ctxpopup_Direction.
[in] | first | 1st priority of direction |
[in] | second | 2nd priority of direction |
[in] | third | 3th priority of direction |
[in] | fourth | 4th priority of direction |
Referenced by elm_ctxpopup_direction_priority_set().
EOAPI void elm_obj_ctxpopup_direction_priority_get | ( | const Eo * | obj, |
Elm_Ctxpopup_Direction * | first, | ||
Elm_Ctxpopup_Direction * | second, | ||
Elm_Ctxpopup_Direction * | third, | ||
Elm_Ctxpopup_Direction * | fourth | ||
) |
Get the direction priority of a ctxpopup.
See also elm_obj_ctxpopup_direction_priority_set for more information.
[out] | first | 1st priority of direction |
[out] | second | 2nd priority of direction |
[out] | third | 3th priority of direction |
[out] | fourth | 4th priority of direction |
Referenced by elm_ctxpopup_direction_priority_get().
EOAPI Elm_Ctxpopup_Direction elm_obj_ctxpopup_direction_get | ( | const Eo * | obj | ) |
Get the current direction of a ctxpopup.
Referenced by elm_ctxpopup_direction_get().
EOAPI void elm_obj_ctxpopup_dismiss | ( | Eo * | obj | ) |
Dismiss a ctxpopup object.
Use this function to simulate clicking outside of the ctxpopup to dismiss it. In this way, the ctxpopup will be hidden and the "clicked" signal will be emitted.
Referenced by elm_ctxpopup_dismiss().
EOAPI Elm_Widget_Item* elm_obj_ctxpopup_item_append | ( | Eo * | obj, |
const char * | label, | ||
Efl_Canvas_Object * | icon, | ||
Evas_Smart_Cb | func, | ||
const void * | data | ||
) |
Add a new item to a ctxpopup object.
Warning:Ctxpopup can't hold both an item list and a content at the same time. When an item is added, any previous content will be removed.
See also elm_object_content_set.
[in] | label | The Label of the new item |
[in] | icon | Icon to be set on new item |
[in] | func | Convenience function called when item selected |
[in] | data | Data passed to func |
null
, on errors. Referenced by elm_ctxpopup_item_append().
EOAPI Elm_Widget_Item* elm_obj_ctxpopup_item_prepend | ( | Eo * | obj, |
const char * | label, | ||
Efl_Canvas_Object * | icon, | ||
Evas_Smart_Cb | func, | ||
const void * | data | ||
) |
Prepend a new item to a ctxpopup object.
See also elm_object_content_set.
[in] | label | The Label of the new item |
[in] | icon | Icon to be set on new item |
[in] | func | Convenience function called when item selected |
[in] | data | Data passed to func |
null
, on errors.Referenced by elm_ctxpopup_item_prepend().
void elm_ctxpopup_auto_hide_disabled_set | ( | Elm_Ctxpopup * | obj, |
Eina_Bool | disabled | ||
) |
Set ctxpopup auto hide mode triggered by ctxpopup policy.
Use this function when user wants ctxpopup not to hide automatically. By default, ctxpopup is dismissed whenever mouse clicked its background area, language is changed, and its parent geometry is updated(changed). Not to hide ctxpopup automatically, disable auto hide function by calling this API, then ctxpopup won't be dismissed in those scenarios.
Default value of disabled is false
.
See also elm_ctxpopup_auto_hide_disabled_get.
[in] | disabled | Auto hide enable/disable. |
References elm_obj_ctxpopup_auto_hide_disabled_set().
Eina_Bool elm_ctxpopup_auto_hide_disabled_get | ( | const Elm_Ctxpopup * | obj | ) |
Get ctxpopup auto hide mode triggered by ctxpopup policy.
See also elm_ctxpopup_auto_hide_disabled_set for more information.
References elm_obj_ctxpopup_auto_hide_disabled_get().
void elm_ctxpopup_hover_parent_set | ( | Elm_Ctxpopup * | obj, |
Efl_Canvas_Object * | parent | ||
) |
Set the Ctxpopup's parent.
Set the parent object.
parent
argument.See also elm_ctxpopup_add, elm_hover_parent_set.
[in] | parent | The parent to use. |
References elm_obj_ctxpopup_hover_parent_set().
Efl_Canvas_Object* elm_ctxpopup_hover_parent_get | ( | const Elm_Ctxpopup * | obj | ) |
Get the Ctxpopup's parent.
See also elm_ctxpopup_hover_parent_set for more information
References elm_obj_ctxpopup_hover_parent_get().
void elm_ctxpopup_direction_priority_set | ( | Elm_Ctxpopup * | obj, |
Elm_Ctxpopup_Direction | first, | ||
Elm_Ctxpopup_Direction | second, | ||
Elm_Ctxpopup_Direction | third, | ||
Elm_Ctxpopup_Direction | fourth | ||
) |
Set the direction priority of a ctxpopup.
This functions gives a chance to user to set the priority of ctxpopup showing direction. This doesn't guarantee the ctxpopup will appear in the requested direction.
See also Elm_Ctxpopup_Direction.
[in] | first | 1st priority of direction |
[in] | second | 2nd priority of direction |
[in] | third | 3th priority of direction |
[in] | fourth | 4th priority of direction |
References elm_obj_ctxpopup_direction_priority_set().
void elm_ctxpopup_direction_priority_get | ( | const Elm_Ctxpopup * | obj, |
Elm_Ctxpopup_Direction * | first, | ||
Elm_Ctxpopup_Direction * | second, | ||
Elm_Ctxpopup_Direction * | third, | ||
Elm_Ctxpopup_Direction * | fourth | ||
) |
Get the direction priority of a ctxpopup.
See also elm_ctxpopup_direction_priority_set for more information.
[out] | first | 1st priority of direction |
[out] | second | 2nd priority of direction |
[out] | third | 3th priority of direction |
[out] | fourth | 4th priority of direction |
References elm_obj_ctxpopup_direction_priority_get().
Elm_Ctxpopup_Direction elm_ctxpopup_direction_get | ( | const Elm_Ctxpopup * | obj | ) |
Get the current direction of a ctxpopup.
References elm_obj_ctxpopup_direction_get().
void elm_ctxpopup_dismiss | ( | Elm_Ctxpopup * | obj | ) |
Dismiss a ctxpopup object.
Use this function to simulate clicking outside of the ctxpopup to dismiss it. In this way, the ctxpopup will be hidden and the "clicked" signal will be emitted.
References elm_obj_ctxpopup_dismiss().
Elm_Widget_Item* elm_ctxpopup_item_append | ( | Elm_Ctxpopup * | obj, |
const char * | label, | ||
Efl_Canvas_Object * | icon, | ||
Evas_Smart_Cb | func, | ||
const void * | data | ||
) |
Add a new item to a ctxpopup object.
Warning:Ctxpopup can't hold both an item list and a content at the same time. When an item is added, any previous content will be removed.
See also elm_object_content_set.
[in] | label | The Label of the new item |
[in] | icon | Icon to be set on new item |
[in] | func | Convenience function called when item selected |
[in] | data | Data passed to func |
null
, on errors. References elm_obj_ctxpopup_item_append().
Elm_Widget_Item* elm_ctxpopup_item_prepend | ( | Elm_Ctxpopup * | obj, |
const char * | label, | ||
Efl_Canvas_Object * | icon, | ||
Evas_Smart_Cb | func, | ||
const void * | data | ||
) |
Prepend a new item to a ctxpopup object.
See also elm_object_content_set.
[in] | label | The Label of the new item |
[in] | icon | Icon to be set on new item |
[in] | func | Convenience function called when item selected |
[in] | data | Data passed to func |
null
, on errors.References elm_obj_ctxpopup_item_prepend().