Context popup widget. More...
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 } |
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... | |
Elm_Widget_Item * | elm_ctxpopup_selected_item_get (const Elm_Ctxpopup *obj) |
Get the selected item in the widget. More... | |
Elm_Widget_Item * | elm_ctxpopup_first_item_get (const Elm_Ctxpopup *obj) |
Get the first item in the widget. More... | |
Elm_Widget_Item * | elm_ctxpopup_last_item_get (const Elm_Ctxpopup *obj) |
Get the last item in the widget. More... | |
const Eina_List * | elm_ctxpopup_items_get (const Elm_Ctxpopup *obj) |
Returns a list of the widget item. More... | |
void | elm_ctxpopup_horizontal_set (Elm_Ctxpopup *obj, Eina_Bool horizontal) |
Change the ctxpopup's orientation to horizontal or vertical. More... | |
Eina_Bool | elm_ctxpopup_horizontal_get (const Elm_Ctxpopup *obj) |
Get the value of current ctxpopup object's orientation. 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_insert_before (Elm_Ctxpopup *obj, Elm_Widget_Item *before, const char *label, Efl_Canvas_Object *icon, Evas_Smart_Cb func, const void *data) |
Insert a new item to a ctxpopup object before item before . More... | |
Elm_Widget_Item * | elm_ctxpopup_item_insert_after (Elm_Ctxpopup *obj, Elm_Widget_Item *after, const char *label, Efl_Canvas_Object *icon, Evas_Smart_Cb func, const void *data) |
Insert a new item to a ctxpopup object after item after . More... | |
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.
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 Elm_Widget_Item* elm_ctxpopup_selected_item_get | ( | const Elm_Ctxpopup * | obj | ) |
Get the selected item in the widget.
[in] | obj | The object. |
null
. Elm_Widget_Item* elm_ctxpopup_first_item_get | ( | const Elm_Ctxpopup * | obj | ) |
Get the first item in the widget.
[in] | obj | The object. |
null
. Elm_Widget_Item* elm_ctxpopup_last_item_get | ( | const Elm_Ctxpopup * | obj | ) |
Get the last item in the widget.
[in] | obj | The object. |
null
. const Eina_List* elm_ctxpopup_items_get | ( | const Elm_Ctxpopup * | obj | ) |
Returns a list of the widget item.
[in] | obj | The object. |
void elm_ctxpopup_horizontal_set | ( | Elm_Ctxpopup * | obj, |
Eina_Bool | horizontal | ||
) |
Change the ctxpopup's orientation to horizontal or vertical.
[in] | obj | The object. |
[in] | horizontal | true for horizontal mode, false for vertical. |
Eina_Bool elm_ctxpopup_horizontal_get | ( | const Elm_Ctxpopup * | obj | ) |
Get the value of current ctxpopup object's orientation.
See also elm_ctxpopup_horizontal_set.
[in] | obj | The object. |
true
for horizontal mode, false
for vertical. 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] | obj | The object. |
[in] | disabled | Auto hide enable/disable. |
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.
[in] | obj | The object. |
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] | obj | The object. |
[in] | parent | The parent to use. |
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
[in] | obj | The object. |
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] | obj | The object. |
[in] | first | 1st priority of direction |
[in] | second | 2nd priority of direction |
[in] | third | 3th priority of direction |
[in] | fourth | 4th priority of direction |
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.
[in] | obj | The object. |
[out] | first | 1st priority of direction |
[out] | second | 2nd priority of direction |
[out] | third | 3th priority of direction |
[out] | fourth | 4th priority of direction |
Elm_Ctxpopup_Direction elm_ctxpopup_direction_get | ( | const Elm_Ctxpopup * | obj | ) |
Get the current direction of a ctxpopup.
[in] | obj | The object. |
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.
[in] | obj | The object. |
Elm_Widget_Item* elm_ctxpopup_item_insert_before | ( | Elm_Ctxpopup * | obj, |
Elm_Widget_Item * | before, | ||
const char * | label, | ||
Efl_Canvas_Object * | icon, | ||
Evas_Smart_Cb | func, | ||
const void * | data | ||
) |
Insert a new item to a ctxpopup object before item before
.
See also elm_object_content_set.
[in] | obj | The object. |
[in] | before | The ctxpopup item to insert before. |
[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.Elm_Widget_Item* elm_ctxpopup_item_insert_after | ( | Elm_Ctxpopup * | obj, |
Elm_Widget_Item * | after, | ||
const char * | label, | ||
Efl_Canvas_Object * | icon, | ||
Evas_Smart_Cb | func, | ||
const void * | data | ||
) |
Insert a new item to a ctxpopup object after item after
.
See also elm_object_content_set.
[in] | obj | The object. |
[in] | after | The ctxpopup item to insert after. |
[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.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] | obj | The object. |
[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. 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] | obj | The object. |
[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.