Tizen Native API  4.0

Context popup widget.

ctxpopup_inheritance_tree.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 Elm_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 4. the parent object is resized due to the window rotation. Then ctxpopup is dismissed.
  • "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) Default content parts of the ctxpopup widget that you can use for are:
    • "default" - A content of the ctxpopup
    Default content parts of the ctxpopup items that you can use for are:
    • "icon" - An icon in the title area
    Default text parts of the ctxpopup items that you can use for are:
    • "default" - A title label in the title area
    Supported elm_object common APIs. Supported elm_object_item common APIs.
    • elm_object_item_del
    • elm_object_item_disabled_set
    • elm_object_item_disabled_get
    • elm_object_item_part_text_set
    • elm_object_item_part_text_get
    • elm_object_item_part_content_set
    • elm_object_item_part_content_get
    • elm_object_item_signal_emit
    • elm_object_item_focus_set
    • elm_object_item_focus_get
    Ctxpopup example shows the usage of a good deal of the API.

Functions

Evas_Objectelm_ctxpopup_add (Evas_Object *parent)
 Add a new Ctxpopup object to the parent.
void elm_ctxpopup_horizontal_set (Elm_Ctxpopup *obj, Eina_Bool horizontal)
 Change the ctxpopup's orientation to horizontal or vertical.
Eina_Bool elm_ctxpopup_horizontal_get (const Elm_Ctxpopup *obj)
 Get the value of current ctxpopup object's orientation.
void elm_ctxpopup_auto_hide_disabled_set (Elm_Ctxpopup *obj, Eina_Bool disabled)
 Set ctxpopup auto hide mode triggered by ctxpopup policy.
void elm_ctxpopup_hover_parent_set (Elm_Ctxpopup *obj, Evas_Object *parent)
 Set the Ctxpopup's parent.
Evas_Objectelm_ctxpopup_hover_parent_get (const Elm_Ctxpopup *obj)
 Get the Ctxpopup's parent.
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.
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.
Elm_Ctxpopup_Direction elm_ctxpopup_direction_get (const Elm_Ctxpopup *obj)
 Get the current direction of a ctxpopup.
void elm_ctxpopup_dismiss (Elm_Ctxpopup *obj)
 Dismiss a ctxpopup object.
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, Evas_Object *icon, Evas_Smart_Cb func, const void *data)
 Add a new item to a ctxpopup object.
EINA_DEPRECATED Eina_Bool elm_ctxpopup_direction_available_get (Evas_Object *obj, Elm_Ctxpopup_Direction direction)
EINA_DEPRECATED Eina_Bool elm_ctxpopup_item_disabled_get (const Elm_Object_Item *it)
 Get the ctxpopup item's disabled/enabled state.
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.
EINA_DEPRECATED Evas_Objectelm_ctxpopup_item_icon_get (const Elm_Object_Item *it)
 Get the icon object for the given ctxpopup item.
EINA_DEPRECATED void elm_ctxpopup_item_icon_set (Elm_Object_Item *it, Evas_Object *icon)
 Sets the side icon associated with the ctxpopup item.
EINA_DEPRECATED const char * elm_ctxpopup_item_label_get (const Elm_Object_Item *it)
 Get the label for the given ctxpopup item.
EINA_DEPRECATED void elm_ctxpopup_item_label_set (Elm_Object_Item *it, const char *label)
 (Re)set the label on the given ctxpopup item.
EINA_DEPRECATED void elm_ctxpopup_content_set (Evas_Object *obj, Evas_Object *content)
 Set an elm widget as the content of the ctxpopup.
EINA_DEPRECATED Evas_Objectelm_ctxpopup_content_unset (Evas_Object *obj)
 Unset the ctxpopup content.
EINA_DEPRECATED void elm_ctxpopup_item_del (Elm_Object_Item *it)
 Delete the given item in a ctxpopup object.

Function Documentation

Add a new Ctxpopup object to the parent.

Parameters:
parentParent object
Returns:
New object or NULL, if it cannot be created
Since :
2.3.1
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.

Since :
2.3.1
Parameters:
[in]objThe object.
[in]disabledauto hide enable/disable.
Since (EFL) :
1.9
void elm_ctxpopup_clear ( Elm_Ctxpopup *  obj)

Clear all items in the given ctxpopup object.

Since :
2.3.1
Parameters:
[in]objThe object.

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

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
EINA_DEPRECATED Eina_Bool elm_ctxpopup_direction_available_get ( Evas_Object obj,
Elm_Ctxpopup_Direction  direction 
)
Deprecated:
Deprecated since 2.4.
Since :
2.3.1
Elm_Ctxpopup_Direction elm_ctxpopup_direction_get ( const Elm_Ctxpopup *  obj)

Get the current direction of a ctxpopup.

Warning:
Once the ctxpopup showed up, the direction would be determined
Since :
2.3.1
Parameters:
[in]objThe object.
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.

Since :
2.3.1
Parameters:
[in]objThe object.
[out]first1st priority of direction
[out]second2nd priority of direction
[out]third3th priority of direction
[out]fourth4th priority of direction
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.

Since :
2.3.1
Parameters:
[in]objThe object.
[in]first1st priority of direction
[in]second2nd priority of direction
[in]third3th priority of direction
[in]fourth4th priority of direction
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.

Since :
2.3.1
Parameters:
[in]objThe object.
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.

Since :
2.3.1
Parameters:
[in]objThe object.
Returns:
true for horizontal mode, false for vertical.
void elm_ctxpopup_horizontal_set ( Elm_Ctxpopup *  obj,
Eina_Bool  horizontal 
)

Change the ctxpopup's orientation to horizontal or vertical.

Since :
2.3.1
Parameters:
[in]objThe object.
[in]horizontaltrue for horizontal mode, false for vertical.
Evas_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

Since :
2.3.1
Parameters:
[in]objThe object.
Returns:
The parent to use.
void elm_ctxpopup_hover_parent_set ( Elm_Ctxpopup *  obj,
Evas_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.

Since :
2.3.1
Parameters:
[in]objThe object.
[in]parentThe parent to use.
Elm_Widget_Item* elm_ctxpopup_item_append ( Elm_Ctxpopup *  obj,
const char *  label,
Evas_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.

Since :
2.3.1
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.

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()

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

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

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

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

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
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