src/lib/elm_frame.c

   1 #include <Elementary.h>
   2 #include "elm_priv.h"
   3
   4 /**
   5  * @defgroup Frame Frame
   6  *
   7  * This holds some content and has a title. Looks like a frame, but
   8  * supports styles so multple frames are avaible
   9  */
  10
  11 typedef struct _Widget_Data Widget_Data;
  12
  13 struct _Widget_Data
  14 {
  15    Evas_Object *frm;
  16    Evas_Object *content;
  17    const char *label;
  18 };
  19
  20 static const char *widtype = NULL;
  21 static void _del_hook(Evas_Object *obj);
  22 static void _mirrored_set(Evas_Object *obj, Eina_Bool rtl);
  23 static void _theme_hook(Evas_Object *obj);
  24 static void _sizing_eval(Evas_Object *obj);
  25 static void _changed_size_hints(void *data, Evas *e, Evas_Object *obj, void *event_info);
  26 static void _sub_del(void *data, Evas_Object *obj, void *event_info);
  27
  28 static void
  29 _del_hook(Evas_Object *obj)
  30 {
  31    Widget_Data *wd = elm_widget_data_get(obj);
  32    if (!wd) return;
  33    if (wd->label) eina_stringshare_del(wd->label);
  34    free(wd);
  35 }
  36
  37 static void
  38 _mirrored_set(Evas_Object *obj, Eina_Bool rtl)
  39 {
  40    Widget_Data *wd = elm_widget_data_get(obj);
  41    if (!wd) return;
  42    edje_object_mirrored_set(wd->frm, rtl);
  43 }
  44
  45 static void
  46 _theme_hook(Evas_Object *obj)
  47 {
  48    Widget_Data *wd = elm_widget_data_get(obj);
  49    if (!wd) return;
  50    _elm_widget_mirrored_reload(obj);
  51    _mirrored_set(obj, elm_widget_mirrored_get(obj));
  52    _elm_theme_object_set(obj, wd->frm, "frame", "base", elm_widget_style_get(obj));
  53    edje_object_part_text_set(wd->frm, "elm.text", wd->label);
  54    if (wd->content)
  55      edje_object_part_swallow(wd->frm, "elm.swallow.content", wd->content);
  56    edje_object_scale_set(wd->frm, elm_widget_scale_get(obj) * _elm_config->scale);
  57    _sizing_eval(obj);
  58 }
  59
  60 static Eina_Bool
  61 _elm_frame_focus_next_hook(const Evas_Object *obj, Elm_Focus_Direction dir, Evas_Object **next)
  62 {
  63    Widget_Data *wd = elm_widget_data_get(obj);
  64    Evas_Object *cur;
  65
  66    if ((!wd) || (!wd->content))
  67      return EINA_FALSE;
  68
  69    cur = wd->content;
  70
  71    /* Try Focus cycle in subitem */
  72    return elm_widget_focus_next_get(cur, dir, next);
  73 }
  74
  75 static void
  76 _sizing_eval(Evas_Object *obj)
  77 {
  78    Widget_Data *wd = elm_widget_data_get(obj);
  79    Evas_Coord minw = -1, minh = -1;
  80    if (!wd) return;
  81    edje_object_size_min_calc(wd->frm, &minw, &minh);
  82    evas_object_size_hint_min_set(obj, minw, minh);
  83    evas_object_size_hint_max_set(obj, -1, -1);
  84 }
  85
  86 static void
  87 _changed_size_hints(void *data, Evas *e __UNUSED__, Evas_Object *obj __UNUSED__, void *event_info __UNUSED__)
  88 {
  89    Widget_Data *wd = elm_widget_data_get(data);
  90    // FIXME: why is this needed? how does edje get this unswallowed or
  91    // lose its callbacks to edje
  92    if (!wd) return;
  93    edje_object_part_swallow(wd->frm, "elm.swallow.content", wd->content);
  94    _sizing_eval(data);
  95 }
  96
  97 static void
  98 _sub_del(void *data __UNUSED__, Evas_Object *obj, void *event_info)
  99 {
 100    Widget_Data *wd = elm_widget_data_get(obj);
 101    Evas_Object *sub = event_info;
 102    if (!wd) return;
 103    if (sub == wd->content)
 104      {
 105         evas_object_event_callback_del_full(sub, EVAS_CALLBACK_CHANGED_SIZE_HINTS,
 106                                             _changed_size_hints, obj);
 107         wd->content = NULL;
 108         _sizing_eval(obj);
 109      }
 110 }
 111
 112 static void
 113 _elm_frame_label_set(Evas_Object *obj, const char *item, const char *label)
 114 {
 115    ELM_CHECK_WIDTYPE(obj, widtype);
 116    Widget_Data *wd = elm_widget_data_get(obj);
 117    if (item) return;
 118    if (!wd) return;
 119    eina_stringshare_replace(&(wd->label), label);
 120    edje_object_part_text_set(wd->frm, "elm.text", wd->label);
 121    _sizing_eval(obj);
 122 }
 123
 124 static const char *
 125 _elm_frame_label_get(const Evas_Object *obj, const char *item)
 126 {
 127    ELM_CHECK_WIDTYPE(obj, widtype) NULL;
 128    Widget_Data *wd = elm_widget_data_get(obj);
 129    if (item) return NULL;
 130    if (!wd) return NULL;
 131    return wd->label;
 132 }
 133
 134 /**
 135  * Add a new frame to the parent
 136  *
 137  * @param parent The parent object
 138  * @return The new object or NULL if it cannot be created
 139  *
 140  * @ingroup Frame
 141  */
 142 EAPI Evas_Object *
 143 elm_frame_add(Evas_Object *parent)
 144 {
 145    Evas_Object *obj;
 146    Evas *e;
 147    Widget_Data *wd;
 148
 149    ELM_WIDGET_STANDARD_SETUP(wd, Widget_Data, parent, e, obj, NULL);
 150
 151    ELM_SET_WIDTYPE(widtype, "frame");
 152    elm_widget_type_set(obj, "frame");
 153    elm_widget_sub_object_add(parent, obj);
 154    elm_widget_data_set(obj, wd);
 155    elm_widget_del_hook_set(obj, _del_hook);
 156    elm_widget_theme_hook_set(obj, _theme_hook);
 157    elm_widget_focus_next_hook_set(obj, _elm_frame_focus_next_hook);
 158    elm_widget_can_focus_set(obj, EINA_FALSE);
 159    elm_widget_text_set_hook_set(obj, _elm_frame_label_set);
 160    elm_widget_text_get_hook_set(obj, _elm_frame_label_get);
 161
 162    wd->frm = edje_object_add(e);
 163    _elm_theme_object_set(obj, wd->frm, "frame", "base", "default");
 164    elm_widget_resize_object_set(obj, wd->frm);
 165
 166    evas_object_smart_callback_add(obj, "sub-object-del", _sub_del, obj);
 167
 168    _mirrored_set(obj, elm_widget_mirrored_get(obj));
 169    _sizing_eval(obj);
 170    return obj;
 171 }
 172
 173 /**
 174  * Set the frame label
 175  *
 176  * @param obj The frame object
 177  * @param label The label of this frame object
 178  *
 179  * @ingroup Frame
 180  * @deprecate use elm_object_text_* instead.
 181  */
 182 EAPI void
 183 elm_frame_label_set(Evas_Object *obj, const char *label)
 184 {
 185    _elm_frame_label_set(obj, NULL, label);
 186 }
 187
 188 /**
 189  * Get the frame label
 190  *
 191  * @param obj The frame object
 192  *
 193  * @return The label of this frame objet or NULL if unable to get frame
 194  *
 195  * @ingroup Frame
 196  * @deprecate use elm_object_text_* instead.
 197  */
 198 EAPI const char *
 199 elm_frame_label_get(const Evas_Object *obj)
 200 {
 201    return _elm_frame_label_get(obj, NULL);
 202 }
 203
 204 /**
 205  * Set the content of the frame widget
 206  *
 207  * Once the content object is set, a previously set one will be deleted.
 208  * If you want to keep that old content object, use the
 209  * elm_frame_content_unset() function.
 210  *
 211  * @param obj The frame object
 212  * @param content The content will be filled in this frame object
 213  *
 214  * @ingroup Frame
 215  */
 216 EAPI void
 217 elm_frame_content_set(Evas_Object *obj, Evas_Object *content)
 218 {
 219    ELM_CHECK_WIDTYPE(obj, widtype);
 220    Widget_Data *wd = elm_widget_data_get(obj);
 221    if (!wd) return;
 222    if (wd->content == content) return;
 223    if (wd->content) evas_object_del(wd->content);
 224    wd->content = content;
 225    if (content)
 226      {
 227         elm_widget_sub_object_add(obj, content);
 228         evas_object_event_callback_add(content, EVAS_CALLBACK_CHANGED_SIZE_HINTS,
 229                                        _changed_size_hints, obj);
 230         edje_object_part_swallow(wd->frm, "elm.swallow.content", content);
 231      }
 232    _sizing_eval(obj);
 233 }
 234
 235 /**
 236  * Get the content of the frame widget
 237  *
 238  * Return the content object which is set for this widget
 239  *
 240  * @param obj The frame object
 241  * @return The content that is being used
 242  *
 243  * @ingroup Frame
 244  */
 245 EAPI Evas_Object *
 246 elm_frame_content_get(const Evas_Object *obj)
 247 {
 248    ELM_CHECK_WIDTYPE(obj, widtype) NULL;
 249    Widget_Data *wd = elm_widget_data_get(obj);
 250    if (!wd) return NULL;
 251    return wd->content;
 252 }
 253
 254 /**
 255  * Unset the content of the frame widget
 256  *
 257  * Unparent and return the content object which was set for this widget
 258  *
 259  * @param obj The frame object
 260  * @return The content that was being used
 261  *
 262  * @ingroup Frame
 263  */
 264 EAPI Evas_Object *
 265 elm_frame_content_unset(Evas_Object *obj)
 266 {
 267    ELM_CHECK_WIDTYPE(obj, widtype) NULL;
 268    Widget_Data *wd = elm_widget_data_get(obj);
 269    Evas_Object *content;
 270    if (!wd) return NULL;
 271    if (!wd->content) return NULL;
 272    content = wd->content;
 273    elm_widget_sub_object_del(obj, wd->content);
 274    edje_object_part_unswallow(wd->frm, wd->content);
 275    wd->content = NULL;
 276    return content;
 277 }