Functions
Ctxpopup

Context popup widget. More...

Functions

EOAPI void elm_obj_ctxpopup_horizontal_set (Eina_Bool horizontal)
 Change the ctxpopup's orientation to horizontal or vertical. More...
 
EOAPI Eina_Bool elm_obj_ctxpopup_horizontal_get (void)
 Get the value of current ctxpopup object's orientation. More...
 
EOAPI void elm_obj_ctxpopup_auto_hide_disabled_set (Eina_Bool disabled)
 Set ctxpopup auto hide mode triggered by ctxpopup policy. More...
 
EOAPI Eina_Bool elm_obj_ctxpopup_auto_hide_disabled_get (void)
 Get ctxpopup auto hide mode triggered by ctxpopup policy. More...
 
EOAPI void elm_obj_ctxpopup_hover_parent_set (Evas_Object *parent)
 Set the Ctxpopup's parent. More...
 
EOAPI Evas_Object * elm_obj_ctxpopup_hover_parent_get (void)
 Get the Ctxpopup's parent. More...
 
EOAPI void elm_obj_ctxpopup_direction_priority_set (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 (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 (void)
 Get the current direction of a ctxpopup. More...
 
EOAPI const Eina_List * elm_obj_ctxpopup_items_get (void)
 Get the internal list of items in a given ctxpopup widget. More...
 
EOAPI Elm_Object_Itemelm_obj_ctxpopup_first_item_get (void)
 Get the first item in the given ctxpopup widget's list of items. More...
 
EOAPI Elm_Object_Itemelm_obj_ctxpopup_last_item_get (void)
 Get the last item in the given ctxpopup widget's list of items. More...
 
EOAPI void elm_obj_ctxpopup_clear (void)
 Clear all items in the given ctxpopup object.
 
EOAPI Elm_Object_Itemelm_obj_ctxpopup_item_append (const char *label, Evas_Object *icon, Evas_Smart_Cb func, const void *data)
 Add a new item to a ctxpopup object. More...
 
EOAPI Elm_Object_Itemelm_obj_ctxpopup_item_prepend (const char *label, Evas_Object *icon, Evas_Smart_Cb func, const void *data)
 Prepend a new item to a ctxpopup object. More...
 
void elm_ctxpopup::clear () const
 Clear all items in the given ctxpopup object.
 
Elm_Object_Itemelm_ctxpopup::item_append (std::string label_, evas::object icon_, Evas_Smart_Cb func_, const void *data_) const
 Add a new item to a ctxpopup object. More...
 
Elm_Object_Itemelm_ctxpopup::item_prepend (std::string label_, evas::object icon_, Evas_Smart_Cb func_, const void *data_) const
 Prepend a new item to a ctxpopup object. More...
 
void elm_ctxpopup_horizontal_set (Eo *obj, Eina_Bool horizontal)
 Change the ctxpopup's orientation to horizontal or vertical. More...
 
Eina_Bool elm_ctxpopup_horizontal_get (const Eo *obj)
 Get the value of current ctxpopup object's orientation. More...
 
void elm_ctxpopup_auto_hide_disabled_set (Eo *obj, Eina_Bool disabled)
 Set ctxpopup auto hide mode triggered by ctxpopup policy. More...
 
Eina_Bool elm_ctxpopup_auto_hide_disabled_get (const Eo *obj)
 Get ctxpopup auto hide mode triggered by ctxpopup policy. More...
 
void elm_ctxpopup_hover_parent_set (Eo *obj, Evas_Object *parent)
 Set the Ctxpopup's parent. More...
 
Evas_Object * elm_ctxpopup_hover_parent_get (const Eo *obj)
 Get the Ctxpopup's parent. More...
 
void elm_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...
 
void elm_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...
 
Elm_Ctxpopup_Direction elm_ctxpopup_direction_get (const Eo *obj)
 Get the current direction of a ctxpopup. More...
 
const Eina_List * elm_ctxpopup_items_get (const Eo *obj)
 Get the internal list of items in a given ctxpopup widget. More...
 
Elm_Object_Itemelm_ctxpopup_first_item_get (const Eo *obj)
 Get the first item in the given ctxpopup widget's list of items. More...
 
Elm_Object_Itemelm_ctxpopup_last_item_get (const Eo *obj)
 Get the last item in the given ctxpopup widget's list of items. More...
 
void elm_ctxpopup_clear (Eo *obj)
 Clear all items in the given ctxpopup object.
 
Elm_Object_Itemelm_ctxpopup_item_append (Eo *obj, const char *label, Evas_Object *icon, Evas_Smart_Cb func, const void *data)
 Add a new item to a ctxpopup object. More...
 
Elm_Object_Itemelm_ctxpopup_item_prepend (Eo *obj, const char *label, Evas_Object *icon, Evas_Smart_Cb func, const void *data)
 Prepend a new item to a ctxpopup object. More...
 
Evas_Object * elm_ctxpopup_add (Evas_Object *parent)
 Add a new Ctxpopup object to the parent. More...
 
bool elm_ctxpopup::horizontal_get () const
 Get the value of current ctxpopup object's orientation. More...
 
void elm_ctxpopup::horizontal_set (bool horizontal_) const
 Get the value of current ctxpopup object's orientation. More...
 
bool elm_ctxpopup::auto_hide_disabled_get () const
 Get ctxpopup auto hide mode triggered by ctxpopup policy. More...
 
void elm_ctxpopup::auto_hide_disabled_set (bool disabled_) const
 Get ctxpopup auto hide mode triggered by ctxpopup policy. More...
 
evas::object elm_ctxpopup::hover_parent_get () const
 Get the Ctxpopup's parent. More...
 
void elm_ctxpopup::hover_parent_set (evas::object parent_) const
 Get the Ctxpopup's parent. More...
 
void elm_ctxpopup::direction_priority_get (Elm_Ctxpopup_Direction *first_, Elm_Ctxpopup_Direction *second_, Elm_Ctxpopup_Direction *third_, Elm_Ctxpopup_Direction *fourth_) const
 Get the direction priority of a ctxpopup. More...
 
void elm_ctxpopup::direction_priority_set (Elm_Ctxpopup_Direction first_, Elm_Ctxpopup_Direction second_, Elm_Ctxpopup_Direction third_, Elm_Ctxpopup_Direction fourth_) const
 Get the direction priority of a ctxpopup. More...
 
Elm_Ctxpopup_Direction elm_ctxpopup::direction_get () const
 Get the current direction of a ctxpopup. More...
 
const Eina_List * elm_ctxpopup::items_get () const
 Get the internal list of items in a given ctxpopup widget. More...
 
Elm_Object_Itemelm_ctxpopup::first_item_get () const
 Get the first item in the given ctxpopup widget's list of items. More...
 
Elm_Object_Itemelm_ctxpopup::last_item_get () const
 Get the last item in the given ctxpopup widget's list of items. 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...
 

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.

Function Documentation

bool elm_ctxpopup::auto_hide_disabled_get ( ) const
inline

Get ctxpopup auto hide mode triggered by ctxpopup policy.

Since
1.9
Returns
auto hide mode's state of a ctxpopup
See also
elm_ctxpopup_auto_hide_disabled_set() for more information.
Parameters
disabledauto hide enable/disable.

References elm_obj_ctxpopup_auto_hide_disabled_get().

void elm_ctxpopup::auto_hide_disabled_set ( bool  disabled_) const
inline

Get ctxpopup auto hide mode triggered by ctxpopup policy.

Since
1.9
Returns
auto hide mode's state of a ctxpopup
See also
elm_ctxpopup_auto_hide_disabled_set() for more information.
Parameters
disabledauto hide enable/disable.

References elm_obj_ctxpopup_auto_hide_disabled_set().

Elm_Ctxpopup_Direction elm_ctxpopup::direction_get ( ) const
inline

Get the current direction of a ctxpopup.

Returns
current direction of a ctxpopup
Warning
Once the ctxpopup showed up, the direction would be determined

References elm_obj_ctxpopup_direction_get().

void elm_ctxpopup::direction_priority_get ( Elm_Ctxpopup_Direction *  first_,
Elm_Ctxpopup_Direction *  second_,
Elm_Ctxpopup_Direction *  third_,
Elm_Ctxpopup_Direction *  fourth_ 
) const
inline

Get the direction priority of a ctxpopup.

See also
elm_ctxpopup_direction_priority_set() for more information.
Parameters
first1st priority of direction
second2nd priority of direction
third3th priority of direction
fourth4th priority of direction

References elm_obj_ctxpopup_direction_priority_get().

void elm_ctxpopup::direction_priority_set ( Elm_Ctxpopup_Direction  first_,
Elm_Ctxpopup_Direction  second_,
Elm_Ctxpopup_Direction  third_,
Elm_Ctxpopup_Direction  fourth_ 
) const
inline

Get the direction priority of a ctxpopup.

See also
elm_ctxpopup_direction_priority_set() for more information.
Parameters
first1st priority of direction
second2nd priority of direction
third3th priority of direction
fourth4th priority of direction

References elm_obj_ctxpopup_direction_priority_set().

Evas_Object* elm_ctxpopup_add ( Evas_Object *  parent)

Add a new Ctxpopup object to the parent.

Parameters
parentParent object
Returns
New object or NULL, if it cannot be created
Eina_Bool elm_ctxpopup_auto_hide_disabled_get ( const Eo *  obj)

Get ctxpopup auto hide mode triggered by ctxpopup policy.

Since
1.9
Returns
auto hide mode's state of a ctxpopup
See also
elm_ctxpopup_auto_hide_disabled_set() for more information.
void elm_ctxpopup_auto_hide_disabled_set ( Eo *  obj,
Eina_Bool  disabled 
)

Set ctxpopup auto hide mode triggered by ctxpopup policy.

Since
1.9

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

See also
elm_ctxpopup_auto_hide_disabled_get()
Parameters
[in]disabledauto hide enable/disable.
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
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_Direction elm_ctxpopup_direction_get ( const Eo *  obj)

Get the current direction of a ctxpopup.

Returns
current direction of a ctxpopup
Warning
Once the ctxpopup showed up, the direction would be determined
void elm_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_ctxpopup_direction_priority_set() for more information.
Parameters
[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 ( 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]first1st priority of direction
[in]second2nd priority of direction
[in]third3th priority of direction
[in]fourth4th priority of direction
Elm_Object_Item* elm_ctxpopup_first_item_get ( const Eo *  obj)

Get the first item in the given ctxpopup widget's list of items.

Since
1.11
Returns
The first item or NULL, if it has no items (and on errors)
See also
elm_ctxpopup_item_append()
elm_ctxpopup_last_item_get()
Eina_Bool elm_ctxpopup_horizontal_get ( const Eo *  obj)

Get the value of current ctxpopup object's orientation.

Returns
EINA_TRUE for horizontal mode, EINA_FALSE for vertical mode (or errors)
See also
elm_ctxpopup_horizontal_set()
void elm_ctxpopup_horizontal_set ( Eo *  obj,
Eina_Bool  horizontal 
)

Change the ctxpopup's orientation to horizontal or vertical.

Parameters
[in]horizontalEINA_TRUE for horizontal mode, EINA_FALSE for vertical
Evas_Object* elm_ctxpopup_hover_parent_get ( const Eo *  obj)

Get the Ctxpopup's parent.

See also
elm_ctxpopup_hover_parent_set() for more information
void elm_ctxpopup_hover_parent_set ( Eo *  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()
Parameters
[in]parentThe parent to use
Elm_Object_Item* elm_ctxpopup_item_append ( Eo *  obj,
const char *  label,
Evas_Object *  icon,
Evas_Smart_Cb  func,
const void *  data 
)

Add a new item to a ctxpopup object.

Returns
A handle to the item added or NULL, on errors
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]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
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()
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
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
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
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
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
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_Object_Item* elm_ctxpopup_item_prepend ( Eo *  obj,
const char *  label,
Evas_Object *  icon,
Evas_Smart_Cb  func,
const void *  data 
)

Prepend a new item to a ctxpopup object.

Since
1.11
Returns
A handle to the item added or NULL, on errors
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]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
const Eina_List* elm_ctxpopup_items_get ( const Eo *  obj)

Get the internal list of items in a given ctxpopup widget.

Since
1.11
Returns
The list of items (Elm_Object_Item as data) or NULL on errors.

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

Warning
This list is only valid until obj object's internal items list is changed. It should be fetched again with another call to this function when changes happen.
Elm_Object_Item* elm_ctxpopup_last_item_get ( const Eo *  obj)

Get the last item in the given ctxpopup widget's list of items.

Since
1.11
Returns
The last item or NULL, if it has no items (and on errors)
See also
elm_ctxpopup_item_prepend()
elm_ctxpopup_first_item_get()
EOAPI Eina_Bool elm_obj_ctxpopup_auto_hide_disabled_get ( void  )

Get ctxpopup auto hide mode triggered by ctxpopup policy.

Since
1.9
Returns
auto hide mode's state of a ctxpopup
See also
elm_ctxpopup_auto_hide_disabled_set() for more information.

Referenced by elm_ctxpopup::auto_hide_disabled_get(), and elm_ctxpopup_auto_hide_disabled_get().

EOAPI void elm_obj_ctxpopup_auto_hide_disabled_set ( Eina_Bool  disabled)

Set ctxpopup auto hide mode triggered by ctxpopup policy.

Since
1.9

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

See also
elm_ctxpopup_auto_hide_disabled_get()
Parameters
[in]disabledauto hide enable/disable.

Referenced by elm_ctxpopup::auto_hide_disabled_set(), and elm_ctxpopup_auto_hide_disabled_set().

EOAPI Elm_Ctxpopup_Direction elm_obj_ctxpopup_direction_get ( void  )

Get the current direction of a ctxpopup.

Returns
current direction of a ctxpopup
Warning
Once the ctxpopup showed up, the direction would be determined

Referenced by elm_ctxpopup::direction_get(), and elm_ctxpopup_direction_get().

EOAPI void elm_obj_ctxpopup_direction_priority_get ( 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.
Parameters
[out]first1st priority of direction
[out]second2nd priority of direction
[out]third3th priority of direction
[out]fourth4th priority of direction

Referenced by elm_ctxpopup::direction_priority_get(), and elm_ctxpopup_direction_priority_get().

EOAPI void elm_obj_ctxpopup_direction_priority_set ( 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]first1st priority of direction
[in]second2nd priority of direction
[in]third3th priority of direction
[in]fourth4th priority of direction

Referenced by elm_ctxpopup::direction_priority_set(), and elm_ctxpopup_direction_priority_set().

EOAPI Elm_Object_Item* elm_obj_ctxpopup_first_item_get ( void  )

Get the first item in the given ctxpopup widget's list of items.

Since
1.11
Returns
The first item or NULL, if it has no items (and on errors)
See also
elm_ctxpopup_item_append()
elm_ctxpopup_last_item_get()

Referenced by elm_ctxpopup_first_item_get(), and elm_ctxpopup::first_item_get().

EOAPI Eina_Bool elm_obj_ctxpopup_horizontal_get ( void  )

Get the value of current ctxpopup object's orientation.

Returns
EINA_TRUE for horizontal mode, EINA_FALSE for vertical mode (or errors)
See also
elm_ctxpopup_horizontal_set()

Referenced by elm_ctxpopup_horizontal_get(), and elm_ctxpopup::horizontal_get().

EOAPI void elm_obj_ctxpopup_horizontal_set ( Eina_Bool  horizontal)

Change the ctxpopup's orientation to horizontal or vertical.

Parameters
[in]horizontalEINA_TRUE for horizontal mode, EINA_FALSE for vertical

Referenced by elm_ctxpopup_horizontal_set(), and elm_ctxpopup::horizontal_set().

EOAPI Evas_Object* elm_obj_ctxpopup_hover_parent_get ( void  )

Get the Ctxpopup's parent.

See also
elm_ctxpopup_hover_parent_set() for more information

Referenced by elm_ctxpopup_hover_parent_get(), and elm_ctxpopup::hover_parent_get().

EOAPI void elm_obj_ctxpopup_hover_parent_set ( 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()
Parameters
[in]parentThe parent to use

Referenced by elm_ctxpopup_hover_parent_set(), and elm_ctxpopup::hover_parent_set().

EOAPI Elm_Object_Item* elm_obj_ctxpopup_item_append ( const char *  label,
Evas_Object *  icon,
Evas_Smart_Cb  func,
const void *  data 
)

Add a new item to a ctxpopup object.

Returns
A handle to the item added or NULL, on errors
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]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

Referenced by elm_ctxpopup_item_append(), and elm_ctxpopup::item_append().

EOAPI Elm_Object_Item* elm_obj_ctxpopup_item_prepend ( const char *  label,
Evas_Object *  icon,
Evas_Smart_Cb  func,
const void *  data 
)

Prepend a new item to a ctxpopup object.

Since
1.11
Returns
A handle to the item added or NULL, on errors
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]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

Referenced by elm_ctxpopup_item_prepend(), and elm_ctxpopup::item_prepend().

EOAPI const Eina_List* elm_obj_ctxpopup_items_get ( void  )

Get the internal list of items in a given ctxpopup widget.

Since
1.11
Returns
The list of items (Elm_Object_Item as data) or NULL on errors.

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

Warning
This list is only valid until obj object's internal items list is changed. It should be fetched again with another call to this function when changes happen.

Referenced by elm_ctxpopup_items_get(), and elm_ctxpopup::items_get().

EOAPI Elm_Object_Item* elm_obj_ctxpopup_last_item_get ( void  )

Get the last item in the given ctxpopup widget's list of items.

Since
1.11
Returns
The last item or NULL, if it has no items (and on errors)
See also
elm_ctxpopup_item_prepend()
elm_ctxpopup_first_item_get()

Referenced by elm_ctxpopup_last_item_get(), and elm_ctxpopup::last_item_get().

Elm_Object_Item* elm_ctxpopup::first_item_get ( ) const
inline

Get the first item in the given ctxpopup widget's list of items.

Since
1.11
Returns
The first item or NULL, if it has no items (and on errors)
See also
elm_ctxpopup_item_append()
elm_ctxpopup_last_item_get()

References elm_obj_ctxpopup_first_item_get().

bool elm_ctxpopup::horizontal_get ( ) const
inline

Get the value of current ctxpopup object's orientation.

Returns
EINA_TRUE for horizontal mode, EINA_FALSE for vertical mode (or errors)
See also
elm_ctxpopup_horizontal_set()
Parameters
horizontalEINA_TRUE for horizontal mode, EINA_FALSE for vertical

References elm_obj_ctxpopup_horizontal_get().

void elm_ctxpopup::horizontal_set ( bool  horizontal_) const
inline

Get the value of current ctxpopup object's orientation.

Returns
EINA_TRUE for horizontal mode, EINA_FALSE for vertical mode (or errors)
See also
elm_ctxpopup_horizontal_set()
Parameters
horizontalEINA_TRUE for horizontal mode, EINA_FALSE for vertical

References elm_obj_ctxpopup_horizontal_set().

evas::object elm_ctxpopup::hover_parent_get ( ) const
inline

Get the Ctxpopup's parent.

See also
elm_ctxpopup_hover_parent_set() for more information
Parameters
parentThe parent to use

References elm_obj_ctxpopup_hover_parent_get().

void elm_ctxpopup::hover_parent_set ( evas::object  parent_) const
inline

Get the Ctxpopup's parent.

See also
elm_ctxpopup_hover_parent_set() for more information
Parameters
parentThe parent to use

References elm_obj_ctxpopup_hover_parent_set().

Elm_Object_Item* elm_ctxpopup::item_append ( std::string  label_,
evas::object  icon_,
Evas_Smart_Cb  func_,
const void *  data_ 
) const
inline

Add a new item to a ctxpopup object.

Returns
A handle to the item added or NULL, on errors
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
labelThe Label of the new item
iconIcon to be set on new item
funcConvenience function called when item selected
dataData passed to func

References elm_obj_ctxpopup_item_append().

Elm_Object_Item* elm_ctxpopup::item_prepend ( std::string  label_,
evas::object  icon_,
Evas_Smart_Cb  func_,
const void *  data_ 
) const
inline

Prepend a new item to a ctxpopup object.

Since
1.11
Returns
A handle to the item added or NULL, on errors
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
labelThe Label of the new item
iconIcon to be set on new item
funcConvenience function called when item selected
dataData passed to func

References elm_obj_ctxpopup_item_prepend().

const Eina_List* elm_ctxpopup::items_get ( ) const
inline

Get the internal list of items in a given ctxpopup widget.

Since
1.11
Returns
The list of items (Elm_Object_Item as data) or NULL on errors.

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

Warning
This list is only valid until obj object's internal items list is changed. It should be fetched again with another call to this function when changes happen.

References elm_obj_ctxpopup_items_get().

Elm_Object_Item* elm_ctxpopup::last_item_get ( ) const
inline

Get the last item in the given ctxpopup widget's list of items.

Since
1.11
Returns
The last item or NULL, if it has no items (and on errors)
See also
elm_ctxpopup_item_prepend()
elm_ctxpopup_first_item_get()

References elm_obj_ctxpopup_last_item_get().