[SLP Merge] 2011/7/14 12:00PM
[framework/uifw/elementary.git] / src / lib / elm_panes.c
index 9d1ef6e..9a8658b 100644 (file)
@@ -2,7 +2,8 @@
 #include "elm_priv.h"
 
 /**
- * @defgroup Panes panes
+ * @defgroup Panes Panes
+ * @ingroup Elementary
  *
  */
 
@@ -14,15 +15,15 @@ struct _Widget_Data
 
    struct
      {
-       Evas_Object *left;
-       Evas_Object *right;
+        Evas_Object *left;
+        Evas_Object *right;
      } contents;
 
    struct
      {
-       int x_diff;
-       int y_diff;
-       Eina_Bool move;
+        int x_diff;
+        int y_diff;
+        Eina_Bool move;
      } move;
 
    Eina_Bool clicked_double;
@@ -32,10 +33,24 @@ struct _Widget_Data
 
 static const char *widtype = NULL;
 static void _del_hook(Evas_Object *obj);
+static void _mirrored_set(Evas_Object *obj, Eina_Bool rtl);
 static void _theme_hook(Evas_Object *obj);
 static void _sizing_eval(Evas_Object *obj);
 static void _changed_size_hints(void *data, Evas *e, Evas_Object *obj, void *event_info);
 
+static const char SIG_CLICKED[] = "clicked";
+static const char SIG_PRESS[] = "press";
+static const char SIG_UNPRESS[] = "unpress";
+static const char SIG_CLICKED_DOUBLE[] = "clicked,double";
+
+static const Evas_Smart_Cb_Description _signals[] = {
+   {SIG_CLICKED, ""},
+   {SIG_PRESS, ""},
+   {SIG_UNPRESS, ""},
+   {SIG_CLICKED_DOUBLE, ""},
+   {NULL, NULL}
+};
+
 static void
 _del_hook(Evas_Object *obj)
 {
@@ -45,25 +60,89 @@ _del_hook(Evas_Object *obj)
 }
 
 static void
+_mirrored_set(Evas_Object *obj, Eina_Bool rtl)
+{
+   Widget_Data *wd = elm_widget_data_get(obj);
+   if (!wd) return;
+   edje_object_mirrored_set(wd->panes, rtl);
+}
+
+static void
 _theme_hook(Evas_Object *obj)
 {
    Widget_Data *wd = elm_widget_data_get(obj);
    const char *style = elm_widget_style_get(obj);
+   double size;
 
    if (!wd) return;
+   _elm_widget_mirrored_reload(obj);
+   _mirrored_set(obj, elm_widget_mirrored_get(obj));
+   size = elm_panes_content_left_size_get(obj);
+
    if (wd->horizontal)
      _elm_theme_object_set(obj, wd->panes, "panes", "horizontal", style);
    else
      _elm_theme_object_set(obj, wd->panes, "panes", "vertical", style);
 
    if (wd->contents.left)
-     edje_object_part_swallow(wd->panes, "elm.swallow.left", wd->contents.right);
+     edje_object_part_swallow(wd->panes, "elm.swallow.left", wd->contents.left);
    if (wd->contents.right)
      edje_object_part_swallow(wd->panes, "elm.swallow.right", wd->contents.right);
+   if(wd->contents.left && wd->contents.right)
+     edje_object_signal_emit(wd->panes, "elm.panes.pair", "elm");
+   if(wd->fixed)
+     edje_object_signal_emit(wd->panes, "elm.panes.fixed", "elm");
 
    edje_object_scale_set(wd->panes, elm_widget_scale_get(obj) *
                          _elm_config->scale);
    _sizing_eval(obj);
+   elm_panes_content_left_size_set(obj, size);
+}
+
+static Eina_Bool
+_elm_panes_focus_next_hook(const Evas_Object *obj, Elm_Focus_Direction dir, Evas_Object **next)
+{
+   Widget_Data *wd = elm_widget_data_get(obj);
+
+   if (!wd)
+     return EINA_FALSE;
+
+   double w, h;
+   edje_object_part_drag_value_get(wd->panes, "elm.bar", &w, &h);
+   if (((wd->horizontal) && ( h == 0.0 )) || ((!wd->horizontal) && ( w == 0.0 )))
+     return elm_widget_focus_next_get(wd->contents.right, dir, next);
+
+   Evas_Object *chain[2];
+
+   /* Direction */
+   if (dir == ELM_FOCUS_PREVIOUS)
+     {
+        chain[0] = wd->contents.right;
+        chain[1] = wd->contents.left;
+     }
+   else if (dir == ELM_FOCUS_NEXT)
+     {
+        chain[0] = wd->contents.left;
+        chain[1] = wd->contents.right;
+     }
+   else
+     return EINA_FALSE;
+
+   unsigned char i = elm_widget_focus_get(chain[1]);
+
+   if (elm_widget_focus_next_get(chain[i], dir, next))
+     return EINA_TRUE;
+
+   i = !i;
+
+   Evas_Object *to_focus;
+   if (elm_widget_focus_next_get(chain[i], dir, &to_focus))
+     {
+        *next = to_focus;
+        return !!i;
+     }
+
+   return EINA_FALSE;
 }
 
 static void
@@ -88,24 +167,24 @@ _sub_del(void *data __UNUSED__, Evas_Object *obj __UNUSED__, void *event_info __
    if (!wd) return;
    if (sub == wd->contents.left)
      {
-       evas_object_event_callback_del_full(sub, EVAS_CALLBACK_CHANGED_SIZE_HINTS,
+        evas_object_event_callback_del_full(sub, EVAS_CALLBACK_CHANGED_SIZE_HINTS,
                                             _changed_size_hints, obj);
-       wd->contents.left = NULL;
-       _sizing_eval(obj);
+        wd->contents.left = NULL;
+        _sizing_eval(obj);
      }
    else if (sub == wd->contents.right)
      {
-       evas_object_event_callback_del_full(sub, EVAS_CALLBACK_CHANGED_SIZE_HINTS,
+        evas_object_event_callback_del_full(sub, EVAS_CALLBACK_CHANGED_SIZE_HINTS,
                                             _changed_size_hints, obj);
-       wd->contents.right= NULL;
-       _sizing_eval(obj);
+        wd->contents.right= NULL;
+        _sizing_eval(obj);
      }
 }
 
 static void
 _clicked(void *data, Evas_Object *obj __UNUSED__ , const char *emission __UNUSED__, const char *source __UNUSED__)
 {
-   evas_object_smart_callback_call(data, "clicked", NULL);
+   evas_object_smart_callback_call(data, SIG_CLICKED, NULL);
 }
 
 static void
@@ -119,26 +198,26 @@ _clicked_double(void *data, Evas_Object *obj __UNUSED__ , const char *emission _
 static void
 _press(void *data, Evas_Object *obj __UNUSED__ , const char *emission __UNUSED__, const char *source __UNUSED__)
 {
-   evas_object_smart_callback_call(data, "press", NULL);
+   evas_object_smart_callback_call(data, SIG_PRESS, NULL);
 }
 
 static void
 _unpress(void *data, Evas_Object *obj __UNUSED__ , const char *emission __UNUSED__, const char *source __UNUSED__)
 {
    Widget_Data *wd = elm_widget_data_get(data);
-   evas_object_smart_callback_call(data, "unpress", NULL);
+   evas_object_smart_callback_call(data, SIG_UNPRESS, NULL);
 
    if (wd->clicked_double)
      {
-       evas_object_smart_callback_call(data, "clicked,double", NULL);
-       wd->clicked_double = EINA_FALSE;
+        evas_object_smart_callback_call(data, SIG_CLICKED_DOUBLE, NULL);
+        wd->clicked_double = EINA_FALSE;
      }
 }
 
 /**
  * Add a new panes to the parent
  *
- * @param parent The parent object
+ * @param[in] parent The parent object
  * @return The new object or NULL if it cannot be created
  *
  * @ingroup Panes
@@ -150,15 +229,16 @@ elm_panes_add(Evas_Object *parent)
    Evas *e;
    Widget_Data *wd;
 
-   wd = ELM_NEW(Widget_Data);
-   e = evas_object_evas_get(parent);
-   obj = elm_widget_add(e);
+   ELM_WIDGET_STANDARD_SETUP(wd, Widget_Data, parent, e, obj, NULL);
+
    ELM_SET_WIDTYPE(widtype, "panes");
-   elm_widget_type_set(obj, widtype);
+   elm_widget_type_set(obj, "panes");
+   elm_widget_can_focus_set(obj, EINA_FALSE);
    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_focus_next_hook_set(obj, _elm_panes_focus_next_hook);
 
    wd->panes = edje_object_add(e);
    _elm_theme_object_set(obj, wd->panes, "panes", "vertical", "default");
@@ -167,190 +247,219 @@ elm_panes_add(Evas_Object *parent)
 
    elm_panes_content_left_size_set(obj, 0.5);
 
-   edje_object_signal_callback_add(wd->panes, "elm,action,click", "", 
+   edje_object_signal_callback_add(wd->panes, "elm,action,click", "",
                                    _clicked, obj);
-   edje_object_signal_callback_add(wd->panes, "elm,action,click,double", "", 
+   edje_object_signal_callback_add(wd->panes, "elm,action,click,double", "",
                                    _clicked_double, obj);
-   edje_object_signal_callback_add(wd->panes, "elm,action,press", "", 
+   edje_object_signal_callback_add(wd->panes, "elm,action,press", "",
                                    _press, obj);
-   edje_object_signal_callback_add(wd->panes, "elm,action,unpress", "", 
+   edje_object_signal_callback_add(wd->panes, "elm,action,unpress", "",
                                    _unpress, obj);
 
    evas_object_smart_callback_add(obj, "sub-object-del", _sub_del, obj);
-   evas_object_event_callback_add(obj, EVAS_CALLBACK_CHANGED_SIZE_HINTS, 
+   evas_object_event_callback_add(obj, EVAS_CALLBACK_CHANGED_SIZE_HINTS,
                                   _changed_size_hints, obj);
 
+   evas_object_smart_callbacks_descriptions_set(obj, _signals);
+
+   _mirrored_set(obj, elm_widget_mirrored_get(obj));
    _sizing_eval(obj);
    return obj;
 }
 
+
 /**
- * Set a control as a left/top content of the pane
+ * Set the left/top content of the panes widget
  *
- * @param obj The pane object
- * @param content The object to be set as 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_panes_content_left_unset() function.
+ *
+ * @param[in] obj The panes object
+ * @param[in] content The new left/top content object
  *
  * @ingroup Panes
  */
-EAPI void elm_panes_content_left_set(Evas_Object *obj, Evas_Object *content)
+EAPI void
+elm_panes_content_left_set(Evas_Object *obj, Evas_Object *content)
 {
+   ELM_CHECK_WIDTYPE(obj, widtype);
    Widget_Data *wd = elm_widget_data_get(obj);
-
    if (wd->contents.left)
      {
-       evas_object_del(wd->contents.left);
-       wd->contents.left = NULL;
+        evas_object_del(wd->contents.left);
+        wd->contents.left = NULL;
      }
-
    if (content)
      {
-       wd->contents.left = content;
-       elm_widget_sub_object_add(obj, content);
-       edje_object_part_swallow(wd->panes, "elm.swallow.left", content);
+        wd->contents.left = content;
+        elm_widget_sub_object_add(obj, content);
+        edje_object_part_swallow(wd->panes, "elm.swallow.left", content);
+        if (wd->contents.right)
+          edje_object_signal_emit(wd->panes, "elm.panes.pair", "elm");
      }
+   else
+      edje_object_signal_emit(wd->panes, "elm.panes.unpair", "elm");
 }
 
 /**
- * Set a control as a right/bottom content of the pane
+ * Set the right/bottom content of the panes widget
+ *
+ * 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_panes_content_right_unset() function.
  *
- * @param obj The pane object
- * @param content The object to be set as content
+ * @param[in] obj The panes object
+ * @param[in] content The new right/bottom content object
  *
  * @ingroup Panes
  */
-EAPI void elm_panes_content_right_set(Evas_Object *obj, Evas_Object *content)
+EAPI void
+elm_panes_content_right_set(Evas_Object *obj, Evas_Object *content)
 {
+   ELM_CHECK_WIDTYPE(obj, widtype);
    Widget_Data *wd = elm_widget_data_get(obj);
-
    if (wd->contents.right)
      {
-       evas_object_del(wd->contents.right);
-       wd->contents.right = NULL;
+        evas_object_del(wd->contents.right);
+        wd->contents.right = NULL;
      }
-
    if (content)
      {
-       wd->contents.right = content;
-       elm_widget_sub_object_add(obj, content);
-       edje_object_part_swallow(wd->panes, "elm.swallow.right", content);
+        wd->contents.right = content;
+        elm_widget_sub_object_add(obj, content);
+        edje_object_part_swallow(wd->panes, "elm.swallow.right", content);
+        if (wd->contents.left)
+          edje_object_signal_emit(wd->panes, "elm.panes.pair", "elm");
      }
+   else
+     edje_object_signal_emit(wd->panes, "elm.panes.unpair", "elm");
 }
 
 /**
- * Get the left/top content of the pane
+ * Get the left/top content used for the panes
+ *
+ * Return the left/top content object which is set for this widget.
  *
- * @param obj The pane object
- * @return The Evas Object set as a left/top content of the pane
+ * @param[in] obj The panes object
+ * @return The left/top content object that is being used
  *
  * @ingroup Panes
  */
-EAPI Evas_Object
-*elm_panes_content_left_get(const Evas_Object *obj)
+EAPI Evas_Object *
+elm_panes_content_left_get(const Evas_Object *obj)
 {
+   ELM_CHECK_WIDTYPE(obj, widtype) NULL;
    Widget_Data *wd = elm_widget_data_get(obj);
    return wd->contents.left;
 }
 
 /**
- * Get the right/bottom content of the pane
+ * Get the right/bottom content used for the panes
+ *
+ * Return the right/bottom content object which is set for this widget.
  *
- * @param obj The pane object
- * @return The Evas Object set as a right/bottom content of the pane
+ * @param[in] obj The panes object
+ * @return The right/bottom content object that is being used
  *
  * @ingroup Panes
  */
-EAPI Evas_Object
-*elm_panes_content_right_get(const Evas_Object *obj)
+EAPI Evas_Object *
+elm_panes_content_right_get(const Evas_Object *obj)
 {
+   ELM_CHECK_WIDTYPE(obj, widtype) NULL;
    Widget_Data *wd = elm_widget_data_get(obj);
    return wd->contents.right;
 }
 
 /**
- * Unset a control from a left/top content of the pane
+ * Unset the left/top content used for the panes
+ *
+ * Unparent and return the left content object which was set for this widget.
  *
- * @param obj The pane object
- * @return The content being unset
+ * @param[in] obj The panes object
+ * @return The left/top content object that was being used
  *
  * @ingroup Panes
  */
 EAPI Evas_Object *
 elm_panes_content_left_unset(Evas_Object *obj)
 {
-        ELM_CHECK_WIDTYPE(obj, widtype) NULL;
-        Widget_Data *wd;
-        Evas_Object *content;
-
-        wd = elm_widget_data_get(obj);
-
-        content = edje_object_part_swallow_get(wd->panes, "elm.swallow.left");
-        if(!content) return NULL;
-        edje_object_part_unswallow(wd->panes, content);
-        elm_widget_sub_object_del(obj, content);
-        wd->contents.left = NULL;
-        return content;
+   ELM_CHECK_WIDTYPE(obj, widtype) NULL;
+   Widget_Data *wd = elm_widget_data_get(obj);
+   if (!wd) return NULL;
+   if (!wd->contents.left) return NULL;
+   Evas_Object *content = wd->contents.left;
+   elm_widget_sub_object_del(obj, content);
+   edje_object_part_unswallow(wd->panes, content);
+   evas_object_hide(content);
+   wd->contents.left = NULL;
+   edje_object_signal_emit(wd->panes, "elm.panes.unpair", "elm");
+   return content;
 }
 
 /**
- * Unset a control from a right/bottom content of the pane
+ * Unset the right/bottom content used for the panes
+ *
+ * Unparent and return the right content object which was set for this widget.
  *
- * @param obj The pane object
-  * @return The content being unset
+ * @param[in] obj The panes object
+  * @return The right/bottom content object that was being used
  *
  * @ingroup Panes
  */
 EAPI Evas_Object *
 elm_panes_content_right_unset(Evas_Object *obj)
 {
-        ELM_CHECK_WIDTYPE(obj, widtype) NULL;
-        Widget_Data *wd;
-        Evas_Object *content;
-
-        wd = elm_widget_data_get(obj);
-
-        content = edje_object_part_swallow_get(wd->panes, "elm.swallow.right");
-        if(!content) return NULL;
-        edje_object_part_unswallow(wd->panes, content);
-        elm_widget_sub_object_del(obj, content);
-        wd->contents.right = NULL;
-        return content;
+   ELM_CHECK_WIDTYPE(obj, widtype) NULL;
+   Widget_Data *wd = elm_widget_data_get(obj);
+   if (!wd) return NULL;
+   if (!wd->contents.right) return NULL;
+   Evas_Object *content = wd->contents.right;
+   elm_widget_sub_object_del(obj, content);
+   edje_object_part_unswallow(wd->panes, content);
+   evas_object_hide(content);
+   wd->contents.right = NULL;
+   edje_object_signal_emit(wd->panes, "elm.panes.unpair", "elm");
+   return content;
 }
 
 /**
  * Get the relative normalized size of left/top content of the pane
  *
- * @param obj The pane object
+ * @param[in] obj The panes object
  * @return The value of type double in the range [0.0,1.0]
  *
  * @ingroup Panes
  */
-EAPI double 
+EAPI double
 elm_panes_content_left_size_get(const Evas_Object *obj)
 {
+   ELM_CHECK_WIDTYPE(obj, widtype) 0.0;
    Widget_Data *wd = elm_widget_data_get(obj);
    double w, h;
 
    edje_object_part_drag_value_get(wd->panes, "elm.bar", &w, &h);
-
-   if (wd->horizontal)
-     return h;
-   else
-     return w;
+   if (wd->horizontal) return h;
+   else return w;
 }
 
 /**
- * Set a size of the left content with a relative normalized double value
+ * Set a size of the left/top content with a relative normalized double value
  *
- * @param obj The pane object
- * @param size The value of type double in the range [0.0,1.0]
+ * @param[in] obj The panes object
+ * @param[in] size The value of type double in the range [0.0,1.0]
  *
  * @ingroup Panes
  */
-EAPI void 
+EAPI void
 elm_panes_content_left_size_set(Evas_Object *obj, double size)
 {
+   ELM_CHECK_WIDTYPE(obj, widtype);
    Widget_Data *wd = elm_widget_data_get(obj);
 
+   if (size < 0.0) size = 0.0;
+   else if (size > 1.0) size = 1.0;
    if (wd->horizontal)
      edje_object_part_drag_value_set(wd->panes, "elm.bar", 0.0, size);
    else
@@ -358,16 +467,19 @@ elm_panes_content_left_size_set(Evas_Object *obj, double size)
 }
 
 /**
- * Set the type of an existing pane object to horizontal/vertical
+ * Set the type of an existing panes object to horizontal/vertical
  *
- * @param obj The pane object
- * @param horizontal Boolean value. If true, then the type is set to horizontal else vertical
+ * By default the panes is of vertical type
+ *
+ * @param[in] obj The panes object
+ * @param[in] horizontal Boolean value. If true, then the type is set to horizontal else vertical
  *
  * @ingroup Panes
  */
-EAPI void 
+EAPI void
 elm_panes_horizontal_set(Evas_Object *obj, Eina_Bool horizontal)
 {
+   ELM_CHECK_WIDTYPE(obj, widtype);
    Widget_Data *wd = elm_widget_data_get(obj);
 
    wd->horizontal = horizontal;
@@ -378,49 +490,51 @@ elm_panes_horizontal_set(Evas_Object *obj, Eina_Bool horizontal)
 /**
  * Indicate if the type of pane object is horizontal or not
  *
- * @param obj The pane object
+ * @param[in] obj The panes object
  * @return true if it is of horizontal type else false
  *
  * @ingroup Panes
  */
-EAPI Eina_Bool 
-elm_panes_horizontal_is(const Evas_Object *obj)
+EAPI Eina_Bool
+elm_panes_horizontal_get(const Evas_Object *obj)
 {
+   ELM_CHECK_WIDTYPE(obj, widtype) EINA_FALSE;
    Widget_Data *wd = elm_widget_data_get(obj);
-
    return wd->horizontal;
 }
 
 /**
- * Set a handler of the pane object non-movable or movable
+ * Set a handler of the pane object movable or non-movable
  *
- * @param obj The pane object
- * @param fixed If set to true then the views size can't be changed using handler otherwise using handler they can be resized
+ * @param[in] obj The panes object
+ * @param[in] fixed If set to true then the views size can't be changed using handler otherwise using handler they can be resized
  *
  * @ingroup Panes
  */
 EAPI void
 elm_panes_fixed_set(Evas_Object *obj, Eina_Bool fixed)
 {
+   ELM_CHECK_WIDTYPE(obj, widtype);
    Widget_Data *wd = elm_widget_data_get(obj);
    wd->fixed = fixed;
-   if(wd->fixed == EINA_TRUE)
-      edje_object_signal_emit(wd->panes, "elm.fixed", "movement.decider");
+   if (wd->fixed == EINA_TRUE)
+     edje_object_signal_emit(wd->panes, "elm.panes.fixed", "elm");
    else
-      edje_object_signal_emit(wd->panes, "elm.unfixed", "movement.decider");
+     edje_object_signal_emit(wd->panes, "elm.panes.unfixed", "elm");
 }
 
 /**
- * Indicate if the handler of the pane object can be moved with user interaction
+ * Indicate if the handler of the panes object can be moved with user interaction
  *
- * @param obj The pane object
+ * @param[in] obj The panes object
  * @return false if the views can be resized using handler else true
  *
  * @ingroup Panes
  */
 EAPI Eina_Bool
-elm_panes_fixed_is(const Evas_Object *obj)
+elm_panes_fixed_get(const Evas_Object *obj)
 {
+   ELM_CHECK_WIDTYPE(obj, widtype) EINA_FALSE;
    Widget_Data *wd = elm_widget_data_get(obj);
    return wd->fixed;
 }