2019-03-05 14:00:37 -08:00
|
|
|
#ifndef _ELM_CTXPOPUP_EO_H_
|
|
|
|
#define _ELM_CTXPOPUP_EO_H_
|
|
|
|
|
|
|
|
#ifndef _ELM_CTXPOPUP_EO_CLASS_TYPE
|
|
|
|
#define _ELM_CTXPOPUP_EO_CLASS_TYPE
|
|
|
|
|
|
|
|
typedef Eo Elm_Ctxpopup;
|
|
|
|
|
|
|
|
#endif
|
|
|
|
|
|
|
|
#ifndef _ELM_CTXPOPUP_EO_TYPES
|
|
|
|
#define _ELM_CTXPOPUP_EO_TYPES
|
|
|
|
|
|
|
|
/** Direction in which to show the popup.
|
|
|
|
*
|
2020-06-30 18:14:53 -07:00
|
|
|
* @ingroup Elm_Ctxpopup_Group
|
2019-03-05 14:00:37 -08:00
|
|
|
*/
|
|
|
|
typedef enum
|
|
|
|
{
|
|
|
|
ELM_CTXPOPUP_DIRECTION_DOWN = 0, /**< 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;
|
|
|
|
|
|
|
|
|
|
|
|
#endif
|
|
|
|
/** Elementary context popup class
|
|
|
|
*
|
2020-06-30 18:14:53 -07:00
|
|
|
* @ingroup Elm_Ctxpopup_Group
|
2019-03-05 14:00:37 -08:00
|
|
|
*/
|
|
|
|
#define ELM_CTXPOPUP_CLASS elm_ctxpopup_class_get()
|
|
|
|
|
efl: make all _class_get() functions const
please note, not the return type, but the function.
When appending __attribute__((const)) to a function, the compiler is
told that its enough to call this function once in a function.
This is quite often happening when we are efl_data_scope_get and
efl_super in a function that is different from a implemented function.
The compiler now starts to remove the calls that aggressivly that we
need to ensure that these calls are not removed, which means, the static
function calls, and the eo init are now checking the return value of
these functions, to ensure that they are called.
Please note that you now have to be carefull when your app calls
eo_shutdown, if it does so, you *must* call it at the end of a function,
or never call class_get after that anymore.
Overall this improves elm test runs 0.1s which is fair i guess, the main
thing that is faster is textrendering, where is also the point where
this is the most beneficial.
Please note, this replaces 42 occurences of double _class_get() ... THAT
is a sign!
Reviewed-by: Stefan Schmidt <stefan@datenfreihafen.org>
Reviewed-by: Daniel Kolesa <daniel@octaforge.org>
Differential Revision: https://phab.enlightenment.org/D12057
2020-07-16 03:39:23 -07:00
|
|
|
EWAPI const Efl_Class *elm_ctxpopup_class_get(void) EINA_CONST;
|
2019-03-05 14:00:37 -08:00
|
|
|
|
|
|
|
/**
|
|
|
|
* @brief Get the selected item in the widget.
|
|
|
|
*
|
|
|
|
* @param[in] obj The object.
|
|
|
|
*
|
|
|
|
* @return The selected item or @c null.
|
|
|
|
*
|
2020-06-30 18:14:53 -07:00
|
|
|
* @ingroup Elm_Ctxpopup_Group
|
2019-03-05 14:00:37 -08:00
|
|
|
*/
|
|
|
|
EOAPI Elm_Widget_Item *elm_obj_ctxpopup_selected_item_get(const Eo *obj);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @brief Get the first item in the widget.
|
|
|
|
*
|
|
|
|
* @param[in] obj The object.
|
|
|
|
*
|
|
|
|
* @return The first item or @c null.
|
|
|
|
*
|
2020-06-30 18:14:53 -07:00
|
|
|
* @ingroup Elm_Ctxpopup_Group
|
2019-03-05 14:00:37 -08:00
|
|
|
*/
|
|
|
|
EOAPI Elm_Widget_Item *elm_obj_ctxpopup_first_item_get(const Eo *obj);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @brief Get the last item in the widget.
|
|
|
|
*
|
|
|
|
* @param[in] obj The object.
|
|
|
|
*
|
|
|
|
* @return The last item or @c null.
|
|
|
|
*
|
2020-06-30 18:14:53 -07:00
|
|
|
* @ingroup Elm_Ctxpopup_Group
|
2019-03-05 14:00:37 -08:00
|
|
|
*/
|
|
|
|
EOAPI Elm_Widget_Item *elm_obj_ctxpopup_last_item_get(const Eo *obj);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @brief Returns a list of the widget item.
|
|
|
|
*
|
|
|
|
* @param[in] obj The object.
|
|
|
|
*
|
|
|
|
* @return const list to widget items
|
|
|
|
*
|
2020-06-30 18:14:53 -07:00
|
|
|
* @ingroup Elm_Ctxpopup_Group
|
2019-03-05 14:00:37 -08:00
|
|
|
*/
|
|
|
|
EOAPI const Eina_List *elm_obj_ctxpopup_items_get(const Eo *obj);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @brief Change the ctxpopup's orientation to horizontal or vertical.
|
|
|
|
*
|
|
|
|
* @param[in] obj The object.
|
|
|
|
* @param[in] horizontal @c true for horizontal mode, @c false for vertical.
|
|
|
|
*
|
2020-06-30 18:14:53 -07:00
|
|
|
* @ingroup Elm_Ctxpopup_Group
|
2019-03-05 14:00:37 -08:00
|
|
|
*/
|
|
|
|
EOAPI void elm_obj_ctxpopup_horizontal_set(Eo *obj, Eina_Bool horizontal);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @brief Get the value of current ctxpopup object's orientation.
|
|
|
|
*
|
|
|
|
* See also @ref elm_obj_ctxpopup_horizontal_set.
|
|
|
|
*
|
|
|
|
* @param[in] obj The object.
|
|
|
|
*
|
|
|
|
* @return @c true for horizontal mode, @c false for vertical.
|
|
|
|
*
|
2020-06-30 18:14:53 -07:00
|
|
|
* @ingroup Elm_Ctxpopup_Group
|
2019-03-05 14:00:37 -08:00
|
|
|
*/
|
|
|
|
EOAPI Eina_Bool elm_obj_ctxpopup_horizontal_get(const Eo *obj);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @brief 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 @c false.
|
|
|
|
*
|
|
|
|
* See also @ref elm_obj_ctxpopup_auto_hide_disabled_get.
|
|
|
|
*
|
|
|
|
* @param[in] obj The object.
|
|
|
|
* @param[in] disabled Auto hide enable/disable.
|
|
|
|
*
|
|
|
|
* @since 1.9
|
|
|
|
*
|
2020-06-30 18:14:53 -07:00
|
|
|
* @ingroup Elm_Ctxpopup_Group
|
2019-03-05 14:00:37 -08:00
|
|
|
*/
|
|
|
|
EOAPI void elm_obj_ctxpopup_auto_hide_disabled_set(Eo *obj, Eina_Bool disabled);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @brief Get ctxpopup auto hide mode triggered by ctxpopup policy.
|
|
|
|
*
|
|
|
|
* See also @ref elm_obj_ctxpopup_auto_hide_disabled_set for more information.
|
|
|
|
*
|
|
|
|
* @param[in] obj The object.
|
|
|
|
*
|
|
|
|
* @return Auto hide enable/disable.
|
|
|
|
*
|
|
|
|
* @since 1.9
|
|
|
|
*
|
2020-06-30 18:14:53 -07:00
|
|
|
* @ingroup Elm_Ctxpopup_Group
|
2019-03-05 14:00:37 -08:00
|
|
|
*/
|
|
|
|
EOAPI Eina_Bool elm_obj_ctxpopup_auto_hide_disabled_get(const Eo *obj);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @brief Set the Ctxpopup's parent
|
|
|
|
*
|
|
|
|
* Set the parent object.
|
|
|
|
*
|
|
|
|
* @note @ref elm_ctxpopup_add will automatically call this function with its
|
|
|
|
* @c parent argument.
|
|
|
|
*
|
|
|
|
* See also @ref elm_ctxpopup_add, @ref elm_hover_parent_set.
|
|
|
|
*
|
|
|
|
* @param[in] obj The object.
|
|
|
|
* @param[in] parent The parent to use.
|
|
|
|
*
|
2020-06-30 18:14:53 -07:00
|
|
|
* @ingroup Elm_Ctxpopup_Group
|
2019-03-05 14:00:37 -08:00
|
|
|
*/
|
|
|
|
EOAPI void elm_obj_ctxpopup_hover_parent_set(Eo *obj, Efl_Canvas_Object *parent);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @brief Get the Ctxpopup's parent
|
|
|
|
*
|
|
|
|
* See also @ref elm_obj_ctxpopup_hover_parent_set for more information
|
|
|
|
*
|
|
|
|
* @param[in] obj The object.
|
|
|
|
*
|
|
|
|
* @return The parent to use.
|
|
|
|
*
|
2020-06-30 18:14:53 -07:00
|
|
|
* @ingroup Elm_Ctxpopup_Group
|
2019-03-05 14:00:37 -08:00
|
|
|
*/
|
|
|
|
EOAPI Efl_Canvas_Object *elm_obj_ctxpopup_hover_parent_get(const Eo *obj);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @brief 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 @ref Elm_Ctxpopup_Direction.
|
|
|
|
*
|
|
|
|
* @param[in] obj The object.
|
|
|
|
* @param[in] first 1st priority of direction
|
|
|
|
* @param[in] second 2nd priority of direction
|
|
|
|
* @param[in] third 3th priority of direction
|
|
|
|
* @param[in] fourth 4th priority of direction
|
|
|
|
*
|
2020-06-30 18:14:53 -07:00
|
|
|
* @ingroup Elm_Ctxpopup_Group
|
2019-03-05 14:00:37 -08:00
|
|
|
*/
|
|
|
|
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);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @brief Get the direction priority of a ctxpopup.
|
|
|
|
*
|
|
|
|
* See also @ref elm_obj_ctxpopup_direction_priority_set for more information.
|
|
|
|
*
|
|
|
|
* @param[in] obj The object.
|
|
|
|
* @param[out] first 1st priority of direction
|
|
|
|
* @param[out] second 2nd priority of direction
|
|
|
|
* @param[out] third 3th priority of direction
|
|
|
|
* @param[out] fourth 4th priority of direction
|
|
|
|
*
|
2020-06-30 18:14:53 -07:00
|
|
|
* @ingroup Elm_Ctxpopup_Group
|
2019-03-05 14:00:37 -08:00
|
|
|
*/
|
|
|
|
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);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @brief Get the current direction of a ctxpopup.
|
|
|
|
*
|
|
|
|
* @warning Once the ctxpopup showed up, the direction would be determined
|
|
|
|
*
|
|
|
|
* @param[in] obj The object.
|
|
|
|
*
|
|
|
|
* @return Direction
|
|
|
|
*
|
2020-06-30 18:14:53 -07:00
|
|
|
* @ingroup Elm_Ctxpopup_Group
|
2019-03-05 14:00:37 -08:00
|
|
|
*/
|
|
|
|
EOAPI Elm_Ctxpopup_Direction elm_obj_ctxpopup_direction_get(const Eo *obj);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @brief 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.
|
|
|
|
* @param[in] obj The object.
|
|
|
|
*
|
2020-06-30 18:14:53 -07:00
|
|
|
* @ingroup Elm_Ctxpopup_Group
|
2019-03-05 14:00:37 -08:00
|
|
|
*/
|
|
|
|
EOAPI void elm_obj_ctxpopup_dismiss(Eo *obj);
|
|
|
|
|
|
|
|
/** Clear all items in the given ctxpopup object.
|
|
|
|
*
|
2020-06-30 18:14:53 -07:00
|
|
|
* @ingroup Elm_Ctxpopup_Group
|
2019-03-05 14:00:37 -08:00
|
|
|
*/
|
|
|
|
EOAPI void elm_obj_ctxpopup_clear(Eo *obj);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @brief Insert a new item to a ctxpopup object before item @c before.
|
|
|
|
*
|
|
|
|
* See also elm_object_content_set.
|
|
|
|
*
|
|
|
|
* @param[in] obj The object.
|
|
|
|
* @param[in] before The ctxpopup item to insert before.
|
|
|
|
* @param[in] label The Label of the new item
|
|
|
|
* @param[in] icon Icon to be set on new item
|
|
|
|
* @param[in] func Convenience function called when item selected
|
|
|
|
* @param[in] data Data passed to @c func
|
|
|
|
*
|
|
|
|
* @return A handle to the item added or @c null, on errors.
|
|
|
|
*
|
|
|
|
* @since 1.21
|
|
|
|
*
|
2020-06-30 18:14:53 -07:00
|
|
|
* @ingroup Elm_Ctxpopup_Group
|
2019-03-05 14:00:37 -08:00
|
|
|
*/
|
|
|
|
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);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @brief Insert a new item to a ctxpopup object after item @c after.
|
|
|
|
*
|
|
|
|
* See also elm_object_content_set.
|
|
|
|
*
|
|
|
|
* @param[in] obj The object.
|
|
|
|
* @param[in] after The ctxpopup item to insert after.
|
|
|
|
* @param[in] label The Label of the new item
|
|
|
|
* @param[in] icon Icon to be set on new item
|
|
|
|
* @param[in] func Convenience function called when item selected
|
|
|
|
* @param[in] data Data passed to @c func
|
|
|
|
*
|
|
|
|
* @return A handle to the item added or @c null, on errors.
|
|
|
|
*
|
|
|
|
* @since 1.21
|
|
|
|
*
|
2020-06-30 18:14:53 -07:00
|
|
|
* @ingroup Elm_Ctxpopup_Group
|
2019-03-05 14:00:37 -08:00
|
|
|
*/
|
|
|
|
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);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @brief 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 @ref elm_object_content_set.
|
|
|
|
*
|
|
|
|
* @param[in] obj The object.
|
|
|
|
* @param[in] label The Label of the new item
|
|
|
|
* @param[in] icon Icon to be set on new item
|
|
|
|
* @param[in] func Convenience function called when item selected
|
|
|
|
* @param[in] data Data passed to @c func
|
|
|
|
*
|
|
|
|
* @return A handle to the item added or @c null, on errors.
|
|
|
|
*
|
2020-06-30 18:14:53 -07:00
|
|
|
* @ingroup Elm_Ctxpopup_Group
|
2019-03-05 14:00:37 -08:00
|
|
|
*/
|
|
|
|
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);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @brief 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 @ref elm_object_content_set.
|
|
|
|
*
|
|
|
|
* @param[in] obj The object.
|
|
|
|
* @param[in] label The Label of the new item
|
|
|
|
* @param[in] icon Icon to be set on new item
|
|
|
|
* @param[in] func Convenience function called when item selected
|
|
|
|
* @param[in] data Data passed to @c func
|
|
|
|
*
|
|
|
|
* @return A handle to the item added or @c null, on errors.
|
|
|
|
*
|
|
|
|
* @since 1.11
|
|
|
|
*
|
2020-06-30 18:14:53 -07:00
|
|
|
* @ingroup Elm_Ctxpopup_Group
|
2019-03-05 14:00:37 -08:00
|
|
|
*/
|
|
|
|
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);
|
|
|
|
|
|
|
|
EWAPI extern const Efl_Event_Description _ELM_CTXPOPUP_EVENT_DISMISSED;
|
|
|
|
|
|
|
|
/** Called when context popup was dismissed
|
|
|
|
*
|
2020-06-30 18:14:53 -07:00
|
|
|
* @ingroup Elm_Ctxpopup_Group
|
2019-03-05 14:00:37 -08:00
|
|
|
*/
|
|
|
|
#define ELM_CTXPOPUP_EVENT_DISMISSED (&(_ELM_CTXPOPUP_EVENT_DISMISSED))
|
|
|
|
|
|
|
|
EWAPI extern const Efl_Event_Description _ELM_CTXPOPUP_EVENT_GEOMETRY_UPDATE;
|
|
|
|
|
|
|
|
/** Called when context popup geometry was updated
|
|
|
|
* @return const Eina_Rect *
|
|
|
|
*
|
2020-06-30 18:14:53 -07:00
|
|
|
* @ingroup Elm_Ctxpopup_Group
|
2019-03-05 14:00:37 -08:00
|
|
|
*/
|
|
|
|
#define ELM_CTXPOPUP_EVENT_GEOMETRY_UPDATE (&(_ELM_CTXPOPUP_EVENT_GEOMETRY_UPDATE))
|
|
|
|
|
|
|
|
#endif
|