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. 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, 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... | |
EOAPI Elm_Widget_Item * | elm_obj_ctxpopup_selected_item_get (const Eo *obj) |
Get the selected item in the widget. More... | |
EOAPI Elm_Widget_Item * | elm_obj_ctxpopup_first_item_get (const Eo *obj) |
Get the first item in the widget. More... | |
EOAPI Elm_Widget_Item * | elm_obj_ctxpopup_last_item_get (const Eo *obj) |
Get the last item in the widget. More... | |
EOAPI const Eina_List * | elm_obj_ctxpopup_items_get (const Eo *obj) |
Returns a list of the widget item. More... | |
EOAPI void | elm_obj_ctxpopup_horizontal_set (Eo *obj, Eina_Bool horizontal) |
Change the ctxpopup's orientation to horizontal or vertical. More... | |
EOAPI Eina_Bool | elm_obj_ctxpopup_horizontal_get (const Eo *obj) |
Get the value of current ctxpopup object's orientation. 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_insert_before (Eo *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... | |
EOAPI Elm_Widget_Item * | elm_obj_ctxpopup_item_insert_after (Eo *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... | |
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... | |
EINA_DEPRECATED Eina_Bool | elm_ctxpopup_item_disabled_get (const Elm_Object_Item *it) |
Get the ctxpopup item's disabled/enabled state. More... | |
EINA_DEPRECATED void | elm_ctxpopup_item_disabled_set (Elm_Object_Item *it, Eina_Bool disabled) |
Set the ctxpopup item's state as disabled or enabled. More... | |
EINA_DEPRECATED Evas_Object * | elm_ctxpopup_item_icon_get (const Elm_Object_Item *it) |
Get the icon object for the given ctxpopup item. More... | |
EINA_DEPRECATED void | elm_ctxpopup_item_icon_set (Elm_Object_Item *it, Evas_Object *icon) |
Sets the side icon associated with the ctxpopup item. More... | |
EINA_DEPRECATED const char * | elm_ctxpopup_item_label_get (const Elm_Object_Item *it) |
Get the label for the given ctxpopup item. More... | |
EINA_DEPRECATED void | elm_ctxpopup_item_label_set (Elm_Object_Item *it, const char *label) |
(Re)set the label on the given ctxpopup item. More... | |
EINA_DEPRECATED void | elm_ctxpopup_content_set (Evas_Object *obj, Evas_Object *content) |
Set an elm widget as the content of the ctxpopup. More... | |
EINA_DEPRECATED Evas_Object * | elm_ctxpopup_content_unset (Evas_Object *obj) |
Unset the ctxpopup content. More... | |
EINA_DEPRECATED void | elm_ctxpopup_item_del (Elm_Object_Item *it) |
Delete the given item in 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.
#define ELM_CTXPOPUP_EVENT_GEOMETRY_UPDATE (&(_ELM_CTXPOPUP_EVENT_GEOMETRY_UPDATE)) |
Called when context popup geometry was updated.
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 EOAPI Elm_Widget_Item* elm_obj_ctxpopup_selected_item_get | ( | const Eo * | obj | ) |
Get the selected item in the widget.
[in] | obj | The object. |
null
. EOAPI Elm_Widget_Item* elm_obj_ctxpopup_first_item_get | ( | const Eo * | obj | ) |
Get the first item in the widget.
[in] | obj | The object. |
null
. EOAPI Elm_Widget_Item* elm_obj_ctxpopup_last_item_get | ( | const Eo * | obj | ) |
Get the last item in the widget.
[in] | obj | The object. |
null
. Returns a list of the widget item.
[in] | obj | The object. |
Change the ctxpopup's orientation to horizontal or vertical.
[in] | obj | The object. |
[in] | horizontal | true for horizontal mode, false for vertical. |
Get the value of current ctxpopup object's orientation.
See also elm_obj_ctxpopup_horizontal_set.
[in] | obj | The object. |
true
for horizontal mode, false
for vertical. 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] | obj | The object. |
[in] | disabled | Auto hide enable/disable. |
Get ctxpopup auto hide mode triggered by ctxpopup policy.
See also elm_obj_ctxpopup_auto_hide_disabled_set for more information.
[in] | obj | The object. |
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] | obj | The object. |
[in] | parent | The parent to use. |
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
[in] | obj | The object. |
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] | 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 |
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.
[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 |
EOAPI Elm_Ctxpopup_Direction elm_obj_ctxpopup_direction_get | ( | const Eo * | obj | ) |
Get the current direction of a ctxpopup.
[in] | obj | The object. |
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.
[in] | obj | The object. |
EOAPI Elm_Widget_Item* elm_obj_ctxpopup_item_insert_before | ( | Eo * | 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.EOAPI Elm_Widget_Item* elm_obj_ctxpopup_item_insert_after | ( | Eo * | 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.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] | 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. 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] | 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.EINA_DEPRECATED Eina_Bool elm_ctxpopup_item_disabled_get | ( | const Elm_Object_Item * | it | ) |
Get the ctxpopup item's disabled/enabled state.
it | Ctxpopup item to be enabled/disabled |
EINA_TRUE
, if disabled, EINA_FALSE
otherwiseEINA_DEPRECATED void elm_ctxpopup_item_disabled_set | ( | Elm_Object_Item * | it, |
Eina_Bool | disabled | ||
) |
Set the ctxpopup item's state as disabled or enabled.
it | Ctxpopup item to be enabled/disabled |
disabled | EINA_TRUE to disable it, EINA_FALSE to enable it |
When disabled the item is greyed out to indicate it's state.
EINA_DEPRECATED Evas_Object* elm_ctxpopup_item_icon_get | ( | const Elm_Object_Item * | it | ) |
Get the icon object for the given ctxpopup item.
it | Ctxpopup item |
NULL
, if the item does not have icon or an error occurredEINA_DEPRECATED void elm_ctxpopup_item_icon_set | ( | Elm_Object_Item * | it, |
Evas_Object * | icon | ||
) |
Sets the side icon associated with the ctxpopup item.
it | Ctxpopup item |
icon | Icon object to be set |
Once the icon object is set, a previously set one will be deleted.
EINA_DEPRECATED const char* elm_ctxpopup_item_label_get | ( | const Elm_Object_Item * | it | ) |
Get the label for the given ctxpopup item.
it | Ctxpopup item |
NULL
, if the item does not have label or an error occurredEINA_DEPRECATED void elm_ctxpopup_item_label_set | ( | Elm_Object_Item * | it, |
const char * | label | ||
) |
(Re)set the label on the given ctxpopup item.
it | Ctxpopup item |
label | String to set as label |
EINA_DEPRECATED void elm_ctxpopup_content_set | ( | Evas_Object * | obj, |
Evas_Object * | content | ||
) |
Set an elm widget as the content of the ctxpopup.
obj | Ctxpopup object |
content | Content to be swallowed |
If the content object is already set, a previous one will be deleted. If you want to keep that old content object, use the elm_ctxpopup_content_unset() function.
EINA_DEPRECATED Evas_Object* elm_ctxpopup_content_unset | ( | Evas_Object * | obj | ) |
Unset the ctxpopup content.
obj | Ctxpopup object |
Unparent and return the content object which was set for this widget.
EINA_DEPRECATED void elm_ctxpopup_item_del | ( | Elm_Object_Item * | it | ) |
Delete the given item in a ctxpopup object.
it | Ctxpopup item to be deleted |