Macros | Enumerations | Functions
Ctxpopup

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_Objectelm_ctxpopup_add (Evas_Object *parent)
 Add a new Ctxpopup object to the parent. More...
 
EOAPI Elm_Widget_Itemelm_obj_ctxpopup_selected_item_get (const Eo *obj)
 Get the selected item in the widget. More...
 
EOAPI Elm_Widget_Itemelm_obj_ctxpopup_first_item_get (const Eo *obj)
 Get the first item in the widget. More...
 
EOAPI Elm_Widget_Itemelm_obj_ctxpopup_last_item_get (const Eo *obj)
 Get the last item in the widget. More...
 
EOAPI const Eina_Listelm_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_Objectelm_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_Itemelm_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_Itemelm_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_Itemelm_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_Itemelm_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_Objectelm_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_Objectelm_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...
 

Detailed Description

Context popup widget.

ctxpopup_inheritance_tree.png
preview-00.png

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 :

  1. the parent object is resized due to the window rotation. Then ctxpopup is dismissed.

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.

Ctxpopup example shows the usage of a good deal of the API.

Macro Definition Documentation

◆ ELM_CTXPOPUP_EVENT_GEOMETRY_UPDATE

#define ELM_CTXPOPUP_EVENT_GEOMETRY_UPDATE   (&(_ELM_CTXPOPUP_EVENT_GEOMETRY_UPDATE))

Called when context popup geometry was updated.

Returns
const Eina_Rect *

Enumeration Type Documentation

◆ Elm_Ctxpopup_Direction [1/2]

Direction in which to show the popup.

Enumerator
ELM_CTXPOPUP_DIRECTION_DOWN 

Ctxpopup show appear below clicked area.

ELM_CTXPOPUP_DIRECTION_RIGHT 

Ctxpopup show appear to the right of the clicked area.

ELM_CTXPOPUP_DIRECTION_LEFT 

Ctxpopup show appear to the left of the clicked area.

ELM_CTXPOPUP_DIRECTION_UP 

Ctxpopup show appear above the clicked area.

ELM_CTXPOPUP_DIRECTION_UNKNOWN 

Ctxpopup does not determine it's direction yet.

ELM_CTXPOPUP_DIRECTION_DOWN 

Ctxpopup show appear below clicked area.

ELM_CTXPOPUP_DIRECTION_RIGHT 

Ctxpopup show appear to the right of the clicked area.

ELM_CTXPOPUP_DIRECTION_LEFT 

Ctxpopup show appear to the left of the clicked area.

ELM_CTXPOPUP_DIRECTION_UP 

Ctxpopup show appear above the clicked area.

ELM_CTXPOPUP_DIRECTION_UNKNOWN 

Ctxpopup does not determine it's direction yet.

◆ Elm_Ctxpopup_Direction [2/2]

Direction in which to show the popup.

Enumerator
ELM_CTXPOPUP_DIRECTION_DOWN 

Ctxpopup show appear below clicked area.

ELM_CTXPOPUP_DIRECTION_RIGHT 

Ctxpopup show appear to the right of the clicked area.

ELM_CTXPOPUP_DIRECTION_LEFT 

Ctxpopup show appear to the left of the clicked area.

ELM_CTXPOPUP_DIRECTION_UP 

Ctxpopup show appear above the clicked area.

ELM_CTXPOPUP_DIRECTION_UNKNOWN 

Ctxpopup does not determine it's direction yet.

ELM_CTXPOPUP_DIRECTION_DOWN 

Ctxpopup show appear below clicked area.

ELM_CTXPOPUP_DIRECTION_RIGHT 

Ctxpopup show appear to the right of the clicked area.

ELM_CTXPOPUP_DIRECTION_LEFT 

Ctxpopup show appear to the left of the clicked area.

ELM_CTXPOPUP_DIRECTION_UP 

Ctxpopup show appear above the clicked area.

ELM_CTXPOPUP_DIRECTION_UNKNOWN 

Ctxpopup does not determine it's direction yet.

Function Documentation

◆ elm_ctxpopup_add()

Evas_Object* elm_ctxpopup_add ( Evas_Object parent)

◆ elm_obj_ctxpopup_selected_item_get()

EOAPI Elm_Widget_Item* elm_obj_ctxpopup_selected_item_get ( const Eo *  obj)

Get the selected item in the widget.

Parameters
[in]objThe object.
Returns
The selected item or null.

◆ elm_obj_ctxpopup_first_item_get()

EOAPI Elm_Widget_Item* elm_obj_ctxpopup_first_item_get ( const Eo *  obj)

Get the first item in the widget.

Parameters
[in]objThe object.
Returns
The first item or null.

◆ elm_obj_ctxpopup_last_item_get()

EOAPI Elm_Widget_Item* elm_obj_ctxpopup_last_item_get ( const Eo *  obj)

Get the last item in the widget.

Parameters
[in]objThe object.
Returns
The last item or null.

◆ elm_obj_ctxpopup_items_get()

EOAPI const Eina_List* elm_obj_ctxpopup_items_get ( const Eo *  obj)

Returns a list of the widget item.

Parameters
[in]objThe object.
Returns
const list to widget items

◆ elm_obj_ctxpopup_horizontal_set()

EOAPI void elm_obj_ctxpopup_horizontal_set ( Eo *  obj,
Eina_Bool  horizontal 
)

Change the ctxpopup's orientation to horizontal or vertical.

Parameters
[in]objThe object.
[in]horizontaltrue for horizontal mode, false for vertical.

◆ elm_obj_ctxpopup_horizontal_get()

EOAPI Eina_Bool elm_obj_ctxpopup_horizontal_get ( const Eo *  obj)

Get the value of current ctxpopup object's orientation.

See also elm_obj_ctxpopup_horizontal_set.

Parameters
[in]objThe object.
Returns
true for horizontal mode, false for vertical.

◆ elm_obj_ctxpopup_auto_hide_disabled_set()

EOAPI void elm_obj_ctxpopup_auto_hide_disabled_set ( Eo *  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_obj_ctxpopup_auto_hide_disabled_get.

Parameters
[in]objThe object.
[in]disabledAuto hide enable/disable.
Since
1.9

◆ elm_obj_ctxpopup_auto_hide_disabled_get()

EOAPI Eina_Bool elm_obj_ctxpopup_auto_hide_disabled_get ( const Eo *  obj)

Get ctxpopup auto hide mode triggered by ctxpopup policy.

See also elm_obj_ctxpopup_auto_hide_disabled_set for more information.

Parameters
[in]objThe object.
Returns
Auto hide enable/disable.
Since
1.9

◆ elm_obj_ctxpopup_hover_parent_set()

EOAPI void elm_obj_ctxpopup_hover_parent_set ( Eo *  obj,
Efl_Canvas_Object parent 
)

Set the Ctxpopup's parent.

Set the parent object.

Note
elm_ctxpopup_add will automatically call this function with its parent argument.

See also elm_ctxpopup_add, elm_hover_parent_set.

Parameters
[in]objThe object.
[in]parentThe parent to use.

◆ elm_obj_ctxpopup_hover_parent_get()

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

Parameters
[in]objThe object.
Returns
The parent to use.

◆ elm_obj_ctxpopup_direction_priority_set()

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.

Parameters
[in]objThe object.
[in]first1st priority of direction
[in]second2nd priority of direction
[in]third3th priority of direction
[in]fourth4th priority of direction

◆ elm_obj_ctxpopup_direction_priority_get()

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.

Parameters
[in]objThe object.
[out]first1st priority of direction
[out]second2nd priority of direction
[out]third3th priority of direction
[out]fourth4th priority of direction

◆ elm_obj_ctxpopup_direction_get()

EOAPI Elm_Ctxpopup_Direction elm_obj_ctxpopup_direction_get ( const Eo *  obj)

Get the current direction of a ctxpopup.

Warning
Once the ctxpopup showed up, the direction would be determined
Parameters
[in]objThe object.
Returns
Direction

◆ elm_obj_ctxpopup_dismiss()

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.

Parameters
[in]objThe object.

◆ elm_obj_ctxpopup_item_insert_before()

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.

Parameters
[in]objThe object.
[in]beforeThe ctxpopup item to insert before.
[in]labelThe Label of the new item
[in]iconIcon to be set on new item
[in]funcConvenience function called when item selected
[in]dataData passed to func
Returns
A handle to the item added or null, on errors.
Since
1.21

◆ elm_obj_ctxpopup_item_insert_after()

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.

Parameters
[in]objThe object.
[in]afterThe ctxpopup item to insert after.
[in]labelThe Label of the new item
[in]iconIcon to be set on new item
[in]funcConvenience function called when item selected
[in]dataData passed to func
Returns
A handle to the item added or null, on errors.
Since
1.21

◆ elm_obj_ctxpopup_item_append()

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.

Parameters
[in]objThe object.
[in]labelThe Label of the new item
[in]iconIcon to be set on new item
[in]funcConvenience function called when item selected
[in]dataData passed to func
Returns
A handle to the item added or null, on errors.

◆ elm_obj_ctxpopup_item_prepend()

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.

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.

Parameters
[in]objThe object.
[in]labelThe Label of the new item
[in]iconIcon to be set on new item
[in]funcConvenience function called when item selected
[in]dataData passed to func
Returns
A handle to the item added or null, on errors.
Since
1.11

◆ elm_ctxpopup_item_disabled_get()

EINA_DEPRECATED Eina_Bool elm_ctxpopup_item_disabled_get ( const Elm_Object_Item it)

Get the ctxpopup item's disabled/enabled state.

Parameters
itCtxpopup item to be enabled/disabled
Returns
disabled EINA_TRUE, if disabled, EINA_FALSE otherwise
See also
elm_ctxpopup_item_disabled_set()
Deprecated:
use elm_object_item_disabled_get() instead

◆ elm_ctxpopup_item_disabled_set()

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.

Parameters
itCtxpopup item to be enabled/disabled
disabledEINA_TRUE to disable it, EINA_FALSE to enable it

When disabled the item is greyed out to indicate it's state.

Deprecated:
use elm_object_item_disabled_set() instead

◆ elm_ctxpopup_item_icon_get()

EINA_DEPRECATED Evas_Object* elm_ctxpopup_item_icon_get ( const Elm_Object_Item it)

Get the icon object for the given ctxpopup item.

Parameters
itCtxpopup item
Returns
icon object or NULL, if the item does not have icon or an error occurred
See also
elm_ctxpopup_item_append()
elm_ctxpopup_item_icon_set()
Deprecated:
use elm_object_item_part_content_get() instead

◆ elm_ctxpopup_item_icon_set()

EINA_DEPRECATED void elm_ctxpopup_item_icon_set ( Elm_Object_Item it,
Evas_Object icon 
)

Sets the side icon associated with the ctxpopup item.

Parameters
itCtxpopup item
iconIcon object to be set

Once the icon object is set, a previously set one will be deleted.

Warning
Setting the same icon for two items will cause the icon to disappear from the first item.
See also
elm_ctxpopup_item_append()
Deprecated:
use elm_object_item_part_content_set() instead

◆ elm_ctxpopup_item_label_get()

EINA_DEPRECATED const char* elm_ctxpopup_item_label_get ( const Elm_Object_Item it)

Get the label for the given ctxpopup item.

Parameters
itCtxpopup item
Returns
label string or NULL, if the item does not have label or an error occurred
See also
elm_ctxpopup_item_append()
elm_ctxpopup_item_label_set()
Deprecated:
use elm_object_item_text_get() instead

◆ elm_ctxpopup_item_label_set()

EINA_DEPRECATED void elm_ctxpopup_item_label_set ( Elm_Object_Item it,
const char *  label 
)

(Re)set the label on the given ctxpopup item.

Parameters
itCtxpopup item
labelString to set as label
Deprecated:
use elm_object_item_text_set() instead

◆ elm_ctxpopup_content_set()

EINA_DEPRECATED void elm_ctxpopup_content_set ( Evas_Object obj,
Evas_Object content 
)

Set an elm widget as the content of the ctxpopup.

Parameters
objCtxpopup object
contentContent 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.

Warning
Ctxpopup can't hold both a item list and a content at the same time. When a content is set, any previous items will be removed.
Deprecated:
use elm_object_content_set() instead

◆ elm_ctxpopup_content_unset()

EINA_DEPRECATED Evas_Object* elm_ctxpopup_content_unset ( Evas_Object obj)

Unset the ctxpopup content.

Parameters
objCtxpopup object
Returns
The content that was being used

Unparent and return the content object which was set for this widget.

Deprecated:
use elm_object_content_unset()
See also
elm_ctxpopup_content_set()
Deprecated:
use elm_object_content_unset() instead

◆ elm_ctxpopup_item_del()

EINA_DEPRECATED void elm_ctxpopup_item_del ( Elm_Object_Item it)

Delete the given item in a ctxpopup object.

Parameters
itCtxpopup item to be deleted
Deprecated:
Use elm_object_item_del() instead
See also
elm_ctxpopup_item_append()