1 #include <Elementary.h>
5 * @defgroup Hoversel Hoversel
8 * A hoversel is a button that pops up a list of items (automatically
9 * choosing the direction to display) that have a lable and/or an icon to
10 * select from. It is a convenience widget to avoid the need to do all the
11 * piecing together yourself. It is intended for a small number of items in
12 * the hoversel menu (no more than 8), though is capable of many more.
14 * Signals that you can add callbacks for are:
16 * clicked - the user clicked the hoversel button and popped up the sel
18 * selected - an item in the hoversel list is selected. event_info is the item
19 * selected - Elm_Hoversel_Item
21 * dismissed - the hover is dismissed
23 typedef struct _Widget_Data Widget_Data;
27 Evas_Object *btn, *hover;
28 Evas_Object *hover_parent;
30 Eina_Bool horizontal : 1;
31 Eina_Bool expanded : 1;
34 struct _Elm_Hoversel_Item
38 const char *icon_file;
39 const char *icon_group;
40 Elm_Icon_Type icon_type;
44 static const char *widtype = NULL;
45 static void _del_pre_hook(Evas_Object *obj);
46 static void _del_hook(Evas_Object *obj);
47 static void _activate(Evas_Object *obj);
48 static void _activate_hook(Evas_Object *obj);
49 static void _disable_hook(Evas_Object *obj);
50 static void _sizing_eval(Evas_Object *obj);
51 static void _changed_size_hints(void *data, Evas *e, Evas_Object *obj, void *event_info);
52 static void _parent_del(void *data, Evas *e, Evas_Object *obj, void *event_info);
55 _del_pre_hook(Evas_Object *obj)
57 Elm_Hoversel_Item *item;
58 Widget_Data *wd = elm_widget_data_get(obj);
60 elm_hoversel_hover_end(obj);
61 elm_hoversel_hover_parent_set(obj, NULL);
62 EINA_LIST_FREE(wd->items, item)
64 elm_widget_item_pre_notify_del(item);
65 eina_stringshare_del(item->label);
66 eina_stringshare_del(item->icon_file);
67 eina_stringshare_del(item->icon_group);
68 elm_widget_item_del(item);
73 _del_hook(Evas_Object *obj)
75 Widget_Data *wd = elm_widget_data_get(obj);
81 _theme_hook(Evas_Object *obj)
83 Widget_Data *wd = elm_widget_data_get(obj);
86 elm_hoversel_hover_end(obj);
88 snprintf(buf, sizeof(buf), "hoversel_horizontal/%s", elm_widget_style_get(obj));
90 snprintf(buf, sizeof(buf), "hoversel_vertical/%s", elm_widget_style_get(obj));
91 elm_object_style_set(wd->btn, buf);
92 elm_object_disabled_set(wd->btn, elm_widget_disabled_get(obj));
96 _disable_hook(Evas_Object *obj)
98 Widget_Data *wd = elm_widget_data_get(obj);
100 elm_object_disabled_set(wd->btn, elm_widget_disabled_get(obj));
104 _sizing_eval(Evas_Object *obj)
106 Widget_Data *wd = elm_widget_data_get(obj);
107 Evas_Coord minw = -1, minh = -1, maxw = -1, maxh = -1;
109 evas_object_size_hint_min_get(wd->btn, &minw, &minh);
110 evas_object_size_hint_max_get(wd->btn, &maxw, &maxh);
111 evas_object_size_hint_min_set(obj, minw, minh);
112 evas_object_size_hint_max_set(obj, maxw, maxh);
116 _on_focus_hook(void *data __UNUSED__, Evas_Object *obj)
118 Widget_Data *wd = elm_widget_data_get(obj);
120 if (elm_widget_focus_get(obj))
121 elm_widget_focus_steal(wd->btn);
125 _changed_size_hints(void *data, Evas *e __UNUSED__, Evas_Object *obj __UNUSED__, void *event_info __UNUSED__)
131 _hover_clicked(void *data, Evas_Object *obj __UNUSED__, void *event_info __UNUSED__)
133 elm_hoversel_hover_end(data);
137 _item_clicked(void *data, Evas_Object *obj __UNUSED__, void *event_info __UNUSED__)
139 Elm_Hoversel_Item *item = data;
140 Evas_Object *obj2 = item->base.widget;
142 elm_hoversel_hover_end(obj2);
143 if (item->func) item->func((void *)item->base.data, obj2, item);
144 evas_object_smart_callback_call(obj2, "selected", item);
148 _activate(Evas_Object *obj)
150 Widget_Data *wd = elm_widget_data_get(obj);
151 Evas_Object *bt, *bx, *ic;
153 const Elm_Hoversel_Item *item;
159 elm_hoversel_hover_end(obj);
162 wd->expanded = EINA_TRUE;
164 if (elm_widget_disabled_get(obj)) return;
165 wd->hover = elm_hover_add(obj);
167 snprintf(buf, sizeof(buf), "hoversel_horizontal/%s", elm_widget_style_get(obj));
169 snprintf(buf, sizeof(buf), "hoversel_vertical/%s", elm_widget_style_get(obj));
170 elm_object_style_set(wd->hover, buf);
171 evas_object_smart_callback_add(wd->hover, "clicked", _hover_clicked, obj);
172 elm_hover_parent_set(wd->hover, wd->hover_parent);
173 elm_hover_target_set(wd->hover, wd->btn);
175 bx = elm_box_add(wd->hover);
176 elm_box_homogenous_set(bx, 1);
178 elm_box_horizontal_set(bx, wd->horizontal);
181 snprintf(buf, sizeof(buf), "hoversel_horizontal_entry/%s",
182 elm_widget_style_get(obj));
184 snprintf(buf, sizeof(buf), "hoversel_vertical_entry/%s",
185 elm_widget_style_get(obj));
186 EINA_LIST_FOREACH(wd->items, l, item)
188 bt = elm_button_add(wd->hover);
189 elm_object_style_set(bt, buf);
190 elm_button_label_set(bt, item->label);
193 ic = elm_icon_add(obj);
194 elm_icon_scale_set(ic, 0, 1);
195 if (item->icon_type == ELM_ICON_FILE)
196 elm_icon_file_set(ic, item->icon_file, item->icon_group);
197 else if (item->icon_type == ELM_ICON_STANDARD)
198 elm_icon_standard_set(ic, item->icon_file);
199 elm_button_icon_set(bt, ic);
200 evas_object_show(ic);
202 evas_object_size_hint_weight_set(bt, EVAS_HINT_EXPAND, 0.0);
203 evas_object_size_hint_align_set(bt, EVAS_HINT_FILL, EVAS_HINT_FILL);
204 elm_box_pack_end(bx, bt);
205 evas_object_smart_callback_add(bt, "clicked", _item_clicked, item);
206 evas_object_show(bt);
210 elm_hover_content_set(wd->hover,
211 elm_hover_best_content_location_get(wd->hover,
212 ELM_HOVER_AXIS_HORIZONTAL),
215 elm_hover_content_set(wd->hover,
216 elm_hover_best_content_location_get(wd->hover,
217 ELM_HOVER_AXIS_VERTICAL),
219 evas_object_show(bx);
221 evas_object_show(wd->hover);
222 evas_object_smart_callback_call(obj, "clicked", NULL);
224 // if (wd->horizontal) evas_object_hide(wd->btn);
228 _activate_hook(Evas_Object *obj)
234 _button_clicked(void *data, Evas_Object *obj __UNUSED__, void *event_info __UNUSED__)
240 _parent_del(void *data, Evas *e __UNUSED__, Evas_Object *obj __UNUSED__, void *event_info __UNUSED__)
242 Widget_Data *wd = elm_widget_data_get(data);
244 wd->hover_parent = NULL;
248 * Add a new Hoversel object
250 * @param parent The parent object
251 * @return The new object or NULL if it cannot be created
256 elm_hoversel_add(Evas_Object *parent)
262 EINA_SAFETY_ON_NULL_RETURN_VAL(parent, NULL);
264 wd = ELM_NEW(Widget_Data);
265 e = evas_object_evas_get(parent);
267 obj = elm_widget_add(e);
268 ELM_SET_WIDTYPE(widtype, "hoversel");
269 elm_widget_type_set(obj, "hoversel");
270 elm_widget_sub_object_add(parent, obj);
271 elm_widget_data_set(obj, wd);
272 elm_widget_del_pre_hook_set(obj, _del_pre_hook);
273 elm_widget_del_hook_set(obj, _del_hook);
274 elm_widget_theme_hook_set(obj, _theme_hook);
275 elm_widget_disable_hook_set(obj, _disable_hook);
276 elm_widget_activate_hook_set(obj, _activate_hook);
277 elm_widget_on_focus_hook_set(obj, _on_focus_hook, NULL);
278 elm_widget_can_focus_set(obj, EINA_TRUE);
280 wd->btn = elm_button_add(parent);
281 wd->expanded = EINA_FALSE;
282 elm_widget_resize_object_set(obj, wd->btn);
283 evas_object_event_callback_add(wd->btn, EVAS_CALLBACK_CHANGED_SIZE_HINTS,
284 _changed_size_hints, obj);
285 evas_object_smart_callback_add(wd->btn, "clicked", _button_clicked, obj);
286 elm_widget_sub_object_add(obj, wd->btn);
288 elm_hoversel_hover_parent_set(obj, parent);
294 * Set the Hover parent
296 * Sets the hover parent object. Should probably be the window that the hoversel
297 * is in. See Hover objects for more information.
299 * @param obj The hoversel object
300 * @param parent The parent to use
305 elm_hoversel_hover_parent_set(Evas_Object *obj, Evas_Object *parent)
307 ELM_CHECK_WIDTYPE(obj, widtype);
308 Widget_Data *wd = elm_widget_data_get(obj);
310 if (wd->hover_parent)
311 evas_object_event_callback_del_full(wd->hover_parent, EVAS_CALLBACK_DEL,
313 wd->hover_parent = parent;
314 if (wd->hover_parent)
315 evas_object_event_callback_add(wd->hover_parent, EVAS_CALLBACK_DEL,
320 * Get the Hover parent
322 * Gets the hover parent object. Should probably be the window that the hoversel
323 * is in. See Hover objects for more information.
325 * @param obj The hoversel object
326 * @return The used parent
331 elm_hoversel_hover_parent_get(const Evas_Object *obj)
333 ELM_CHECK_WIDTYPE(obj, widtype) NULL;
334 Widget_Data *wd = elm_widget_data_get(obj);
335 if (!wd) return NULL;
336 return wd->hover_parent;
340 * Set the hoversel button label
342 * This sets the label of the button that is always visible (before it is
343 * clicked and expanded). Also see elm_button_label_set().
345 * @param obj The hoversel object
346 * @param label The label text.
351 elm_hoversel_label_set(Evas_Object *obj, const char *label)
353 ELM_CHECK_WIDTYPE(obj, widtype);
354 Widget_Data *wd = elm_widget_data_get(obj);
356 elm_button_label_set(wd->btn, label);
360 * Get the hoversel button label
362 * @param obj The hoversel object
363 * @return The label text.
368 elm_hoversel_label_get(const Evas_Object *obj)
370 ELM_CHECK_WIDTYPE(obj, widtype) NULL;
371 Widget_Data *wd = elm_widget_data_get(obj);
372 if ((!wd) || (!wd->btn)) return NULL;
373 return elm_button_label_get(wd->btn);
377 * This sets the hoversel to expand horizontally. The initial button
378 * will display horizontally regardless of this setting.
380 * @param obj The hoversel object
381 * @param horizontal If true, the hover will expand horizontally to the right.
386 elm_hoversel_horizontal_set(Evas_Object *obj, Eina_Bool horizontal)
388 ELM_CHECK_WIDTYPE(obj, widtype);
389 Widget_Data *wd = elm_widget_data_get(obj);
391 wd->horizontal = !!horizontal;
396 * This returns whether the hoversel is set to expand horizontally.
398 * @param obj The hoversel object
399 * @return If true, the hover will expand horizontally to the right.
404 elm_hoversel_horizontal_get(const Evas_Object *obj)
406 ELM_CHECK_WIDTYPE(obj, widtype) EINA_FALSE;
407 Widget_Data *wd = elm_widget_data_get(obj);
408 if (!wd) return EINA_FALSE;
409 return wd->horizontal;
413 * Set the icon of the hoversel button
415 * Sets the icon of the button that is always visible (before it is clicked
416 * and expanded). Also see elm_button_icon_set().
417 * Once the icon object is set, a previously set one will be deleted
418 * If you want to keep that old content object, use the
419 * elm_hoversel_icon_unset() function.
421 * @param obj The hoversel object
422 * @param icon The icon object
427 elm_hoversel_icon_set(Evas_Object *obj, Evas_Object *icon)
429 ELM_CHECK_WIDTYPE(obj, widtype);
430 Widget_Data *wd = elm_widget_data_get(obj);
432 elm_button_icon_set(wd->btn, icon);
436 * Get the icon of the hoversel button
438 * Get the icon of the button that is always visible (before it is clicked
439 * and expanded). Also see elm_button_icon_get().
441 * @param obj The hoversel object
442 * @return The icon object
447 elm_hoversel_icon_get(const Evas_Object *obj)
449 ELM_CHECK_WIDTYPE(obj, widtype) NULL;
450 Widget_Data *wd = elm_widget_data_get(obj);
451 if ((!wd) || (!wd->btn)) return NULL;
452 return elm_button_icon_get(wd->btn);
456 * Get the icon of the hoversel button
458 * Unparent and return the icon of the button that is always visible
459 * (before it is clicked and expanded). Also see elm_button_icon_unset().
461 * @param obj The hoversel object
462 * @return The icon object that was being used
467 elm_hoversel_icon_unset(Evas_Object *obj)
469 ELM_CHECK_WIDTYPE(obj, widtype) NULL;
470 Widget_Data *wd = elm_widget_data_get(obj);
471 if ((!wd) || (!wd->btn)) return NULL;
472 return elm_button_icon_unset(wd->btn);
476 * This triggers the hoversel popup from code, the same as though the
477 * user clicked the button.
479 * @param obj The hoversel object
484 elm_hoversel_hover_begin(Evas_Object *obj)
486 ELM_CHECK_WIDTYPE(obj, widtype);
487 Widget_Data *wd = elm_widget_data_get(obj);
489 if (wd->hover) return;
494 * This ends the hoversel popup as though the user clicked outside the hover.
496 * @param obj The hoversel object
501 elm_hoversel_hover_end(Evas_Object *obj)
503 ELM_CHECK_WIDTYPE(obj, widtype);
504 Widget_Data *wd = elm_widget_data_get(obj);
506 if (!wd->hover) return;
507 wd->expanded = EINA_FALSE;
508 evas_object_del(wd->hover);
510 evas_object_smart_callback_call(obj, "dismissed", NULL);
514 * Returns whether the hoversel is expanded.
516 * @param obj The hoversel object
517 * @return This will return EINA_TRUE if the hoversel
518 * is expanded or EINA_FALSE if it is not expanded.
523 elm_hoversel_expanded_get(const Evas_Object *obj)
525 ELM_CHECK_WIDTYPE(obj, widtype) EINA_FALSE;
526 Widget_Data *wd = elm_widget_data_get(obj);
527 if (!wd) return EINA_FALSE;
528 return (wd->hover) ? EINA_TRUE : EINA_FALSE;
532 * This will remove all the children items from the hoversel. (should not be
533 * called while the hoversel is active; use elm_hoversel_expanded_get()
536 * @param obj The hoversel object
541 elm_hoversel_clear(Evas_Object *obj)
543 Elm_Hoversel_Item *item;
545 ELM_CHECK_WIDTYPE(obj, widtype);
546 Widget_Data *wd = elm_widget_data_get(obj);
548 EINA_LIST_FOREACH_SAFE(wd->items, l, ll, item) elm_hoversel_item_del(item);
552 * Get the list of items within the given hoversel.
554 * @param obj The hoversel object
555 * @return Returns a list of Elm_Hoversel_Item*
559 EAPI const Eina_List *
560 elm_hoversel_items_get(const Evas_Object *obj)
562 ELM_CHECK_WIDTYPE(obj, widtype) NULL;
563 Widget_Data *wd = elm_widget_data_get(obj);
564 if (!wd) return NULL;
569 * Add an item to the hoversel button
571 * This adds an item to the hoversel to show when it is clicked. Note: if you
572 * need to use an icon from an edje file then use elm_hoversel_item_icon_set()
573 * right after the this function, and set icon_file to NULL here.
575 * @param obj The hoversel object
576 * @param label The text label to use for the item (NULL if not desired)
577 * @param icon_file An image file path on disk to use for the icon or standard
578 * icon name (NULL if not desired)
579 * @param icon_type The icon type if relevant
580 * @param func Convenience function to call when this item is selected
581 * @param data Data to pass to item-related functions
582 * @return A handle to the item added.
586 EAPI Elm_Hoversel_Item *
587 elm_hoversel_item_add(Evas_Object *obj, const char *label, const char *icon_file, Elm_Icon_Type icon_type, Evas_Smart_Cb func, const void *data)
589 ELM_CHECK_WIDTYPE(obj, widtype) NULL;
590 Widget_Data *wd = elm_widget_data_get(obj);
591 if (!wd) return NULL;
592 Elm_Hoversel_Item *item = elm_widget_item_new(obj, Elm_Hoversel_Item);
593 if (!item) return NULL;
594 wd->items = eina_list_append(wd->items, item);
595 item->label = eina_stringshare_add(label);
596 item->icon_file = eina_stringshare_add(icon_file);
597 item->icon_type = icon_type;
599 item->base.data = data;
604 * Delete an item from the hoversel
606 * This deletes the item from the hoversel (should not be called while the
607 * hoversel is active; use elm_hoversel_expanded_get()
610 * @param item The item to delete
615 elm_hoversel_item_del(Elm_Hoversel_Item *item)
617 ELM_WIDGET_ITEM_WIDTYPE_CHECK_OR_RETURN(item);
618 Widget_Data *wd = elm_widget_data_get(item->base.widget);
620 elm_hoversel_hover_end(item->base.widget);
621 wd->items = eina_list_remove(wd->items, item);
622 elm_widget_item_pre_notify_del(item);
623 eina_stringshare_del(item->label);
624 eina_stringshare_del(item->icon_file);
625 eina_stringshare_del(item->icon_group);
626 elm_widget_item_del(item);
630 * Set the function called when an item within the hoversel
631 * is freed. That function will receive these parameters:
634 * Evas_Object *the_item_object
635 * Elm_Hoversel_Item *the_object_struct
637 * @param item The item to set the callback on
638 * @param func The function called
643 elm_hoversel_item_del_cb_set(Elm_Hoversel_Item *item, Evas_Smart_Cb func)
645 ELM_WIDGET_ITEM_WIDTYPE_CHECK_OR_RETURN(item);
646 elm_widget_item_del_cb_set(item, func);
650 * This returns the data pointer supplied with elm_hoversel_item_add() that
651 * will be passed to associated function callbacks.
653 * @param item The item to get the data from
654 * @return The data pointer set with elm_hoversel_item_add()
659 elm_hoversel_item_data_get(const Elm_Hoversel_Item *item)
661 ELM_WIDGET_ITEM_WIDTYPE_CHECK_OR_RETURN(item, NULL);
662 return elm_widget_item_data_get(item);
666 * This returns the label text of the given hoversel item.
668 * @param item The item to get the label
669 * @return The label text of the hoversel item
674 elm_hoversel_item_label_get(const Elm_Hoversel_Item *item)
676 ELM_WIDGET_ITEM_WIDTYPE_CHECK_OR_RETURN(item, NULL);
681 * This sets the icon for the given hoversel item. The icon can be loaded from
682 * the standard set, from an image file, or from an edje file.
684 * @param item The item to set the icon
685 * @param icon_file An image file path on disk to use for the icon or standard
687 * @param icon_group The edje group to use if @p icon_file is an edje file. Set this
688 * to NULL if the icon is not an edje file
689 * @param icon_type The icon type
694 elm_hoversel_item_icon_set(Elm_Hoversel_Item *item, const char *icon_file, const char *icon_group, Elm_Icon_Type icon_type)
696 ELM_WIDGET_ITEM_WIDTYPE_CHECK_OR_RETURN(item);
697 eina_stringshare_replace(&item->icon_file, icon_file);
698 eina_stringshare_replace(&item->icon_group, icon_group);
699 item->icon_type = icon_type;
703 * Get the icon object of the hoversel item
705 * @param item The item to get the icon from
706 * @param icon_file The image file path on disk used for the icon or standard
708 * @param icon_group The edje group used if @p icon_file is an edje file. NULL
709 * if the icon is not an edje file
710 * @param icon_type The icon type
715 elm_hoversel_item_icon_get(const Elm_Hoversel_Item *item, const char **icon_file, const char **icon_group, Elm_Icon_Type *icon_type)
717 ELM_WIDGET_ITEM_WIDTYPE_CHECK_OR_RETURN(item);
718 if (icon_file) *icon_file = item->icon_file;
719 if (icon_group) *icon_group = item->icon_group;
720 if (icon_type) *icon_type = item->icon_type;