#include #include "elm_priv.h" /** * @defgroup Layout Layout * * This takes a standard Edje design file and wraps it very thinly * in a widget and handles swallowing widgets into swallow regions * in the Edje object, allowing Edje to be used as a design and * layout tool */ typedef struct _Widget_Data Widget_Data; typedef struct _Subinfo Subinfo; typedef struct _Part_Cursor Part_Cursor; struct _Widget_Data { Evas_Object *obj; Evas_Object *lay; Eina_List *subs; Eina_List *parts_cursors; Eina_Bool needs_size_calc:1; }; struct _Subinfo { const char *swallow; Evas_Object *obj; }; struct _Part_Cursor { Evas_Object *obj; const char *part; const char *cursor; const char *style; Eina_Bool engine_only:1; }; static const char *widtype = NULL; static void _del_hook(Evas_Object *obj); static void _theme_hook(Evas_Object *obj); static void _sizing_eval(Widget_Data *wd); static void _changed_size_hints(void *data, Evas *e, Evas_Object *obj, void *event_info); static void _sub_del(void *data, Evas_Object *obj, void *event_info); static void _part_cursor_free(Part_Cursor *pc); static void _del_hook(Evas_Object *obj) { Widget_Data *wd = elm_widget_data_get(obj); Subinfo *si; Part_Cursor *pc; if (!wd) return; EINA_LIST_FREE(wd->subs, si) { eina_stringshare_del(si->swallow); free(si); } EINA_LIST_FREE(wd->parts_cursors, pc) _part_cursor_free(pc); free(wd); } static void _theme_hook(Evas_Object *obj) { Widget_Data *wd = elm_widget_data_get(obj); if (!wd) return; edje_object_scale_set(wd->lay, elm_widget_scale_get(obj) * _elm_config->scale); _sizing_eval(wd); } static void _changed_hook(Evas_Object *obj) { Widget_Data *wd = elm_widget_data_get(obj); if (!wd) return; if (wd->needs_size_calc) { _sizing_eval(wd); wd->needs_size_calc = 0; } } static void * _elm_layout_list_data_get(const Eina_List *list) { Subinfo *si = eina_list_data_get(list); return si->obj; } static Eina_Bool _elm_layout_focus_next_hook(const Evas_Object *obj, Elm_Focus_Direction dir, Evas_Object **next) { Widget_Data *wd = elm_widget_data_get(obj); const Eina_List *items; void *(*list_data_get) (const Eina_List *list); if ((!wd) || (!wd->subs)) return EINA_FALSE; /* Focus chain (This block is diferent of elm_win cycle)*/ if ((items = elm_widget_focus_custom_chain_get(obj))) list_data_get = eina_list_data_get; else { items = wd->subs; list_data_get = _elm_layout_list_data_get; if (!items) return EINA_FALSE; } return elm_widget_focus_list_next_get(obj, items, list_data_get, dir, next); } static void _sizing_eval(Widget_Data *wd) { Evas_Coord minw = -1, minh = -1; edje_object_size_min_calc(wd->lay, &minw, &minh); evas_object_size_hint_min_set(wd->obj, minw, minh); evas_object_size_hint_max_set(wd->obj, -1, -1); } static void _request_sizing_eval(Widget_Data *wd) { if (wd->needs_size_calc) return; wd->needs_size_calc = 1; evas_object_smart_changed(wd->obj); } static void _part_cursor_free(Part_Cursor *pc) { eina_stringshare_del(pc->part); eina_stringshare_del(pc->style); eina_stringshare_del(pc->cursor); free(pc); } static void _part_cursor_part_apply(const Part_Cursor *pc) { elm_object_cursor_set(pc->obj, pc->cursor); elm_object_cursor_style_set(pc->obj, pc->style); elm_object_cursor_engine_only_set(pc->obj, pc->engine_only); } static Part_Cursor * _parts_cursors_find(Widget_Data *wd, const char *part) { const Eina_List *l; Part_Cursor *pc; EINA_LIST_FOREACH(wd->parts_cursors, l, pc) { if (strcmp(pc->part, part) == 0) return pc; } return NULL; } static void _parts_cursors_apply(Widget_Data *wd) { const char *file, *group; const Eina_List *l; Part_Cursor *pc; edje_object_file_get(wd->lay, &file, &group); EINA_LIST_FOREACH(wd->parts_cursors, l, pc) { Evas_Object *obj = (Evas_Object *)edje_object_part_object_get (wd->lay, pc->part); if (!obj) { pc->obj = NULL; WRN("no part '%s' in group '%s' of file '%s'. " "Cannot set cursor '%s'", pc->part, group, file, pc->cursor); continue; } else if (evas_object_pass_events_get(obj)) { pc->obj = NULL; WRN("part '%s' in group '%s' of file '%s' has mouse_events: 0. " "Cannot set cursor '%s'", pc->part, group, file, pc->cursor); continue; } pc->obj = obj; _part_cursor_part_apply(pc); } } static void _changed_size_hints(void *data, Evas *e __UNUSED__, Evas_Object *obj __UNUSED__, void *event_info __UNUSED__) { _request_sizing_eval(data); } static void _sub_del(void *data __UNUSED__, Evas_Object *obj, void *event_info) { Widget_Data *wd = elm_widget_data_get(obj); Evas_Object *sub = event_info; Eina_List *l; Subinfo *si; if (!wd) return; EINA_LIST_FOREACH(wd->subs, l, si) { if (si->obj == sub) { evas_object_event_callback_del_full(sub, EVAS_CALLBACK_CHANGED_SIZE_HINTS, _changed_size_hints, wd); wd->subs = eina_list_remove_list(wd->subs, l); eina_stringshare_del(si->swallow); free(si); break; } } } static void _signal_size_eval(void *data, Evas_Object *obj __UNUSED__, const char *emission __UNUSED__, const char *source __UNUSED__) { _request_sizing_eval(data); } /** * Add a new layout to the parent * * @param parent The parent object * @return The new object or NULL if it cannot be created * * @ingroup Layout */ EAPI Evas_Object * elm_layout_add(Evas_Object *parent) { Evas_Object *obj; Evas *e; Widget_Data *wd; wd = ELM_NEW(Widget_Data); e = evas_object_evas_get(parent); wd->obj = obj = elm_widget_add(e); ELM_SET_WIDTYPE(widtype, "layout"); elm_widget_type_set(obj, "layout"); elm_widget_sub_object_add(parent, obj); elm_widget_data_set(obj, wd); elm_widget_del_hook_set(obj, _del_hook); elm_widget_theme_hook_set(obj, _theme_hook); elm_widget_changed_hook_set(obj, _changed_hook); elm_widget_can_focus_set(obj, EINA_FALSE); elm_widget_focus_next_hook_set(obj, _elm_layout_focus_next_hook); wd->lay = edje_object_add(e); elm_widget_resize_object_set(obj, wd->lay); edje_object_signal_callback_add(wd->lay, "size,eval", "elm", _signal_size_eval, wd); evas_object_smart_callback_add(obj, "sub-object-del", _sub_del, obj); _request_sizing_eval(wd); return obj; } /** * Set the file that will be used as layout * * @param obj The layout object * @param file The path to file (edj) that will be used as layout * @param group The group that the layout belongs in edje file * * @return (1 = success, 0 = error) * * @ingroup Layout */ EAPI Eina_Bool elm_layout_file_set(Evas_Object *obj, const char *file, const char *group) { ELM_CHECK_WIDTYPE(obj, widtype) EINA_FALSE; Widget_Data *wd = elm_widget_data_get(obj); if (!wd) return EINA_FALSE; Eina_Bool ret = edje_object_file_set(wd->lay, file, group); if (ret) { _request_sizing_eval(wd); _parts_cursors_apply(wd); } else DBG("failed to set edje file '%s', group '%s': %s", file, group, edje_load_error_str(edje_object_load_error_get(wd->lay))); return ret; } /** * Set the edje group from the elementary theme that will be used as layout * * @param obj The layout object * @param clas the clas of the group * @param group the group * @param style the style to used * * @return (1 = success, 0 = error) * * @ingroup Layout */ EAPI Eina_Bool elm_layout_theme_set(Evas_Object *obj, const char *clas, const char *group, const char *style) { ELM_CHECK_WIDTYPE(obj, widtype) EINA_FALSE; Widget_Data *wd = elm_widget_data_get(obj); if (!wd) return EINA_FALSE; Eina_Bool ret = _elm_theme_object_set(obj, wd->lay, clas, group, style); if (ret) { _request_sizing_eval(wd); _parts_cursors_apply(wd); } return ret; } /** * Set the layout content * * Once the content object is set, a previously set one will be deleted. * If you want to keep that old content object, use the * elm_layout_content_unset() function. * * @param obj The layout object * @param swallow The swallow group name in the edje file * @param content The content will be filled in this layout object * * @ingroup Layout */ EAPI void elm_layout_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) { ELM_CHECK_WIDTYPE(obj, widtype); Widget_Data *wd = elm_widget_data_get(obj); Subinfo *si; const Eina_List *l; if (!wd) return; EINA_LIST_FOREACH(wd->subs, l, si) { if (!strcmp(swallow, si->swallow)) { if (content == si->obj) return; evas_object_del(si->obj); break; } } if (content) { elm_widget_sub_object_add(obj, content); evas_object_event_callback_add(content, EVAS_CALLBACK_CHANGED_SIZE_HINTS, _changed_size_hints, wd); edje_object_part_swallow(wd->lay, swallow, content); si = ELM_NEW(Subinfo); si->swallow = eina_stringshare_add(swallow); si->obj = content; wd->subs = eina_list_append(wd->subs, si); } _request_sizing_eval(wd); } /** * Unset the layout content * * Unparent and return the content object which was set for this widget * * @param obj The layout object * @param swallow The swallow group name in the edje file * @return The content that was being used * * @ingroup Layout */ EAPI Evas_Object * elm_layout_content_unset(Evas_Object *obj, const char *swallow) { ELM_CHECK_WIDTYPE(obj, widtype) NULL; Widget_Data *wd = elm_widget_data_get(obj); Subinfo *si; const Eina_List *l; if (!wd) return NULL; EINA_LIST_FOREACH(wd->subs, l, si) { if (!strcmp(swallow, si->swallow)) { Evas_Object *content; if (!si->obj) return NULL; content = si->obj; /* si will die in _sub_del due elm_widget_sub_object_del() */ elm_widget_sub_object_del(obj, content); edje_object_part_unswallow(wd->lay, content); return content; } } return NULL; } /** * Get the edje layout * * @param obj The layout object * * This returns the edje object. It is not expected to be used to then swallow * objects via edje_object_part_swallow() for example. Use * elm_layout_content_set() instead so child object handling and sizing is * done properly. This is more intended for setting text, emitting signals, * hooking to signal callbacks etc. * * @return A Evas_Object with the edje layout settings loaded * with function elm_layout_file_set * * @ingroup Layout */ EAPI Evas_Object * elm_layout_edje_get(const Evas_Object *obj) { ELM_CHECK_WIDTYPE(obj, widtype) NULL; Widget_Data *wd = elm_widget_data_get(obj); if (!wd) return NULL; return wd->lay; } /** * Get the edje layout * * Manually forms a sizing re-evaluation when contents changed state so that * minimum size might have changed and needs re-evaluation. Also note that * a standard signal of "size,eval" "elm" emitted by the edje object will * cause this to happen too * * @param obj The layout object * * @ingroup Layout */ EAPI void elm_layout_sizing_eval(Evas_Object *obj) { ELM_CHECK_WIDTYPE(obj, widtype); Widget_Data *wd = elm_widget_data_get(obj); EINA_SAFETY_ON_NULL_RETURN(wd); _request_sizing_eval(wd); } /** * Sets a specific cursor for an edje part. * * @param obj The layout object. * @param part_name a part from loaded edje group. * @param cursor cursor name to use, see Elementary_Cursor.h * * @return EINA_TRUE on success or EINA_FALSE on failure, that may be * part not exists or it has "mouse_events: 0". */ EAPI Eina_Bool elm_layout_part_cursor_set(Evas_Object *obj, const char *part_name, const char *cursor) { ELM_CHECK_WIDTYPE(obj, widtype) EINA_FALSE; EINA_SAFETY_ON_NULL_RETURN_VAL(part_name, EINA_FALSE); Widget_Data *wd = elm_widget_data_get(obj); EINA_SAFETY_ON_NULL_RETURN_VAL(wd, EINA_FALSE); Evas_Object *part_obj; Part_Cursor *pc; part_obj = (Evas_Object *)edje_object_part_object_get(wd->lay, part_name); if (!part_obj) { const char *group, *file; edje_object_file_get(wd->lay, &file, &group); WRN("no part '%s' in group '%s' of file '%s'. Cannot set cursor '%s'", part_name, group, file, cursor); return EINA_FALSE; } if (evas_object_pass_events_get(part_obj)) { const char *group, *file; edje_object_file_get(wd->lay, &file, &group); WRN("part '%s' in group '%s' of file '%s' has mouse_events: 0. " "Cannot set cursor '%s'", part_name, group, file, cursor); return EINA_FALSE; } pc = _parts_cursors_find(wd, part_name); if (pc) eina_stringshare_replace(&pc->cursor, cursor); else { pc = calloc(1, sizeof(*pc)); pc->part = eina_stringshare_add(part_name); pc->cursor = eina_stringshare_add(cursor); } pc->obj = part_obj; elm_object_sub_cursor_set(part_obj, obj, pc->cursor); return EINA_TRUE; } /** * Unsets a cursor previously set with elm_layout_part_cursor_set(). * * @param obj The layout object. * @param part_name a part from loaded edje group, that had a cursor set * with elm_layout_part_cursor_set(). */ EAPI void elm_layout_part_cursor_unset(Evas_Object *obj, const char *part_name) { ELM_CHECK_WIDTYPE(obj, widtype); EINA_SAFETY_ON_NULL_RETURN(part_name); Widget_Data *wd = elm_widget_data_get(obj); EINA_SAFETY_ON_NULL_RETURN(wd); Eina_List *l; Part_Cursor *pc; EINA_LIST_FOREACH(wd->parts_cursors, l, pc) { if (strcmp(part_name, pc->part) == 0) { if (pc->obj) elm_object_cursor_unset(pc->obj); _part_cursor_free(pc); wd->parts_cursors = eina_list_remove_list(wd->parts_cursors, l); return; } } } /** * Sets a specific cursor style for an edje part. * * @param obj The layout object. * @param part_name a part from loaded edje group. * @param style the theme style to use (default, transparent, ...) * * @return EINA_TRUE on success or EINA_FALSE on failure, that may be * part not exists or it did not had a cursor set. */ EAPI Eina_Bool elm_layout_part_cursor_style_set(Evas_Object *obj, const char *part_name, const char *style) { ELM_CHECK_WIDTYPE(obj, widtype) EINA_FALSE; EINA_SAFETY_ON_NULL_RETURN_VAL(part_name, EINA_FALSE); Widget_Data *wd = elm_widget_data_get(obj); EINA_SAFETY_ON_NULL_RETURN_VAL(wd, EINA_FALSE); Part_Cursor *pc = _parts_cursors_find(wd, part_name); EINA_SAFETY_ON_NULL_RETURN_VAL(pc, EINA_FALSE); EINA_SAFETY_ON_NULL_RETURN_VAL(pc->obj, EINA_FALSE); eina_stringshare_replace(&pc->style, style); elm_object_cursor_style_set(pc->obj, pc->style); return EINA_TRUE; } /** * Gets a specific cursor style for an edje part. * * @param obj The layout object. * @param part_name a part from loaded edje group. * * @return the theme style in use, defaults to "default". If the * object does not have a cursor set, then NULL is returned. */ EAPI const char * elm_layout_part_cursor_style_get(Evas_Object *obj, const char *part_name) { ELM_CHECK_WIDTYPE(obj, widtype) NULL; EINA_SAFETY_ON_NULL_RETURN_VAL(part_name, NULL); Widget_Data *wd = elm_widget_data_get(obj); EINA_SAFETY_ON_NULL_RETURN_VAL(wd, NULL); Part_Cursor *pc = _parts_cursors_find(wd, part_name); EINA_SAFETY_ON_NULL_RETURN_VAL(pc, NULL); EINA_SAFETY_ON_NULL_RETURN_VAL(pc->obj, NULL); return elm_object_cursor_style_get(pc->obj); } /** * Sets if the cursor set should be searched on the theme or should use * the provided by the engine, only. * * @note before you set if should look on theme you should define a * cursor with elm_layout_part_cursor_set(). By default it will only * look for cursors provided by the engine. * * @param obj The layout object. * @param part_name a part from loaded edje group. * @param engine_only if cursors should be just provided by the engine * or should also search on widget's theme as well * * @return EINA_TRUE on success or EINA_FALSE on failure, that may be * part not exists or it did not had a cursor set. */ EAPI Eina_Bool elm_layout_part_cursor_engine_only_set(Evas_Object *obj, const char *part_name, Eina_Bool engine_only) { ELM_CHECK_WIDTYPE(obj, widtype) EINA_FALSE; EINA_SAFETY_ON_NULL_RETURN_VAL(part_name, EINA_FALSE); Widget_Data *wd = elm_widget_data_get(obj); EINA_SAFETY_ON_NULL_RETURN_VAL(wd, EINA_FALSE); Part_Cursor *pc = _parts_cursors_find(wd, part_name); EINA_SAFETY_ON_NULL_RETURN_VAL(pc, EINA_FALSE); EINA_SAFETY_ON_NULL_RETURN_VAL(pc->obj, EINA_FALSE); pc->engine_only = !!engine_only; elm_object_cursor_engine_only_set(pc->obj, pc->engine_only); return EINA_TRUE; } /** * Gets a specific cursor engine_only for an edje part. * * @param obj The layout object. * @param part_name a part from loaded edje group. * * @return whenever the cursor is just provided by engine or also from theme. */ EAPI Eina_Bool elm_layout_part_cursor_engine_only_get(Evas_Object *obj, const char *part_name) { ELM_CHECK_WIDTYPE(obj, widtype) EINA_FALSE; EINA_SAFETY_ON_NULL_RETURN_VAL(part_name, EINA_FALSE); Widget_Data *wd = elm_widget_data_get(obj); EINA_SAFETY_ON_NULL_RETURN_VAL(wd, EINA_FALSE); Part_Cursor *pc = _parts_cursors_find(wd, part_name); EINA_SAFETY_ON_NULL_RETURN_VAL(pc, EINA_FALSE); EINA_SAFETY_ON_NULL_RETURN_VAL(pc->obj, EINA_FALSE); return elm_object_cursor_engine_only_get(pc->obj); }