elm_frame: updated the eo prefix and documentation
authorSubhransu Mohanty <sub.mohanty@samsung.com>
Mon, 4 Jul 2016 11:10:29 +0000 (20:10 +0900)
committerJean-Philippe Andre <jp.andre@samsung.com>
Mon, 4 Jul 2016 11:21:12 +0000 (20:21 +0900)
Summary: No idea what else can be done with this widget.

Reviewers: jpeg, cedric, woohyun

Subscribers: raster, cedric, jpeg

Differential Revision: https://phab.enlightenment.org/D3930

src/Makefile_Elementary.am
src/lib/elementary/Makefile.am
src/lib/elementary/efl_ui_frame.c [moved from src/lib/elementary/elm_frame.c with 74% similarity]
src/lib/elementary/efl_ui_frame.eo [moved from src/lib/elementary/elm_frame.eo with 88% similarity]
src/lib/elementary/efl_ui_frame_legacy.h [moved from src/lib/elementary/elm_frame_legacy.h with 87% similarity]
src/lib/elementary/efl_ui_widget_frame.h [moved from src/lib/elementary/elm_widget_frame.h with 69% similarity]
src/lib/elementary/elm_frame.h
src/lib/elementary/elm_frame_eo.h [deleted file]

index 12d5961..9011b24 100644 (file)
@@ -30,7 +30,7 @@ elm_public_eolian_files = \
        lib/elementary/efl_ui_flip.eo \
        lib/elementary/efl_ui_flip_internal_part.eo \
        lib/elementary/elm_flipselector.eo \
-       lib/elementary/elm_frame.eo \
+       lib/elementary/efl_ui_frame.eo \
        lib/elementary/elm_gengrid.eo \
        lib/elementary/elm_gengrid_pan.eo \
        lib/elementary/elm_genlist.eo \
@@ -228,7 +228,7 @@ includesunstable_HEADERS = \
        lib/elementary/elm_widget_fileselector_entry.h \
        lib/elementary/efl_ui_widget_flip.h \
        lib/elementary/elm_widget_flipselector.h \
-       lib/elementary/elm_widget_frame.h \
+       lib/elementary/efl_ui_widget_frame.h \
        lib/elementary/elm_widget_gengrid.h \
        lib/elementary/elm_widget_genlist.h \
        lib/elementary/elm_widget_glview.h \
@@ -395,8 +395,8 @@ includesub_HEADERS = \
        lib/elementary/elm_focus_item.h \
        lib/elementary/elm_font.h \
        lib/elementary/elm_frame.h \
-       lib/elementary/elm_frame_eo.h \
-       lib/elementary/elm_frame_legacy.h \
+       lib/elementary/efl_ui_frame.eo.h \
+       lib/elementary/efl_ui_frame_legacy.h \
        lib/elementary/elm_gen.h \
        lib/elementary/elm_general.h \
        lib/elementary/elm_gengrid.h \
@@ -612,7 +612,7 @@ lib_elementary_libelementary_la_SOURCES = \
        lib/elementary/efl_ui_internal_text_interactive.c \
        lib/elementary/elm_flipselector.c \
        lib/elementary/elm_font.c \
-       lib/elementary/elm_frame.c \
+       lib/elementary/efl_ui_frame.c \
        lib/elementary/elm_gengrid.c \
        lib/elementary/elm_genlist.c \
        lib/elementary/elm_gesture_layer.c \
index 3b8cd0e..53739bd 100644 (file)
@@ -34,7 +34,7 @@ elm_eolian_files = \
        efl_ui_flip.eo \
        efl_ui_flip_internal_part.eo \
        elm_flipselector.eo \
-       elm_frame.eo \
+       efl_ui_frame.eo \
        elm_gengrid.eo \
        elm_gengrid_pan.eo \
        elm_genlist.eo \
@@ -185,7 +185,7 @@ includesunstable_HEADERS = \
        elm_widget_fileselector_entry.h \
        efl_ui_widget_flip.h \
        elm_widget_flipselector.h \
-       elm_widget_frame.h \
+       efl_ui_widget_frame.h \
        elm_widget_gengrid.h \
        elm_widget_genlist.h \
        elm_widget_glview.h \
@@ -340,8 +340,8 @@ includesub_HEADERS = \
        elm_focus_item.h \
        elm_font.h \
        elm_frame.h \
-       elm_frame_eo.h \
-       elm_frame_legacy.h \
+       efl_ui_frame.eo.h \
+       efl_ui_frame_legacy.h \
        elm_gen.h \
        elm_general.h \
        elm_gengrid.h \
@@ -548,7 +548,7 @@ libelementary_la_SOURCES = \
        efl_ui_flip.c \
        elm_flipselector.c \
        elm_font.c \
-       elm_frame.c \
+       efl_ui_frame.c \
        elm_gengrid.c \
        elm_genlist.c \
        elm_gesture_layer.c \
similarity index 74%
rename from src/lib/elementary/elm_frame.c
rename to src/lib/elementary/efl_ui_frame.c
index b89d5a2..7d8a0bb 100644 (file)
@@ -7,12 +7,12 @@
 
 #include <Elementary.h>
 #include "elm_priv.h"
-#include "elm_widget_frame.h"
+#include "efl_ui_widget_frame.h"
 #include "elm_widget_layout.h"
 
-#define MY_CLASS ELM_FRAME_CLASS
+#define MY_CLASS EFL_UI_FRAME_CLASS
 
-#define MY_CLASS_NAME "Elm_Frame"
+#define MY_CLASS_NAME "Efl_Ui_Frame"
 #define MY_CLASS_NAME_LEGACY "elm_frame"
 
 static const char SIG_CLICKED[] = "clicked";
@@ -38,14 +38,14 @@ static const Elm_Layout_Part_Alias_Description _text_aliases[] =
 
 static void
 _sizing_eval(Evas_Object *obj,
-             Elm_Frame_Data *sd EINA_UNUSED)
+             Efl_Ui_Frame_Data *sd EINA_UNUSED)
 {
    ELM_WIDGET_DATA_GET_OR_RETURN(obj, wd);
    Evas_Coord minw = -1, minh = -1;
    Evas_Coord cminw = -1, cminh = -1;
 
    edje_object_size_min_calc(wd->resize_obj, &minw, &minh);
-   efl_gfx_size_hint_combined_min_get(obj, &cminw, &cminh);
+   evas_object_size_hint_min_get(obj, &cminw, &cminh);
    if ((minw == cminw) && (minh == cminh)) return;
 
    evas_object_size_hint_min_set(obj, minw, minh);
@@ -53,13 +53,13 @@ _sizing_eval(Evas_Object *obj,
 }
 
 EOLIAN static Eina_Bool
-_elm_frame_elm_widget_focus_next_manager_is(Eo *obj EINA_UNUSED, Elm_Frame_Data *_pd EINA_UNUSED)
+_efl_ui_frame_elm_widget_focus_next_manager_is(Eo *obj EINA_UNUSED, Efl_Ui_Frame_Data *_pd EINA_UNUSED)
 {
    return EINA_TRUE;
 }
 
 EOLIAN static Eina_Bool
-_elm_frame_elm_widget_focus_next(Eo *obj EINA_UNUSED, Elm_Frame_Data *_pd EINA_UNUSED, Elm_Focus_Direction dir, Evas_Object **next, Elm_Object_Item **next_item)
+_efl_ui_frame_elm_widget_focus_next(Eo *obj EINA_UNUSED, Efl_Ui_Frame_Data *_pd EINA_UNUSED, Elm_Focus_Direction dir, Evas_Object **next, Elm_Object_Item **next_item)
 {
    Evas_Object *content;
 
@@ -75,13 +75,13 @@ _elm_frame_elm_widget_focus_next(Eo *obj EINA_UNUSED, Elm_Frame_Data *_pd EINA_U
 }
 
 EOLIAN static Eina_Bool
-_elm_frame_elm_widget_focus_direction_manager_is(Eo *obj EINA_UNUSED, Elm_Frame_Data *_pd EINA_UNUSED)
+_efl_ui_frame_elm_widget_focus_direction_manager_is(Eo *obj EINA_UNUSED, Efl_Ui_Frame_Data *_pd EINA_UNUSED)
 {
    return EINA_TRUE;
 }
 
 EOLIAN static Eina_Bool
-_elm_frame_elm_widget_focus_direction(Eo *obj EINA_UNUSED, Elm_Frame_Data *_pd EINA_UNUSED, const Evas_Object *base, double degree, Evas_Object **direction, Elm_Object_Item **direction_item, double *weight)
+_efl_ui_frame_elm_widget_focus_direction(Eo *obj EINA_UNUSED, Efl_Ui_Frame_Data *_pd EINA_UNUSED, const Evas_Object *base, double degree, Evas_Object **direction, Elm_Object_Item **direction_item, double *weight)
 {
    Evas_Object *content;
 
@@ -109,7 +109,7 @@ _on_recalc_done(void *data,
                 const char *sig EINA_UNUSED,
                 const char *src EINA_UNUSED)
 {
-   ELM_FRAME_DATA_GET(data, sd);
+   EFL_UI_FRAME_DATA_GET(data, sd);
    ELM_WIDGET_DATA_GET_OR_RETURN(data, wd);
 
    eo_event_callback_del
@@ -125,7 +125,7 @@ _on_frame_clicked(void *data,
                   const char *sig EINA_UNUSED,
                   const char *src EINA_UNUSED)
 {
-   ELM_FRAME_DATA_GET(data, sd);
+   EFL_UI_FRAME_DATA_GET(data, sd);
    ELM_WIDGET_DATA_GET_OR_RETURN(data, wd);
 
    if (sd->anim) return;
@@ -143,7 +143,7 @@ _on_frame_clicked(void *data,
 
 /* using deferred sizing evaluation, just like the parent */
 EOLIAN static void
-_elm_frame_efl_canvas_group_group_calculate(Eo *obj, Elm_Frame_Data *sd)
+_efl_ui_frame_efl_canvas_group_group_calculate(Eo *obj, Efl_Ui_Frame_Data *sd)
 {
    ELM_LAYOUT_DATA_GET(obj, ld);
 
@@ -156,7 +156,7 @@ _elm_frame_efl_canvas_group_group_calculate(Eo *obj, Elm_Frame_Data *sd)
 }
 
 EOLIAN static void
-_elm_frame_efl_canvas_group_group_add(Eo *obj, Elm_Frame_Data *_pd EINA_UNUSED)
+_efl_ui_frame_efl_canvas_group_group_add(Eo *obj, Efl_Ui_Frame_Data *_pd EINA_UNUSED)
 {
    ELM_WIDGET_DATA_GET_OR_RETURN(obj, wd);
 
@@ -179,13 +179,13 @@ _elm_frame_efl_canvas_group_group_add(Eo *obj, Elm_Frame_Data *_pd EINA_UNUSED)
 }
 
 EOLIAN static const Elm_Layout_Part_Alias_Description*
-_elm_frame_elm_layout_content_aliases_get(Eo *obj EINA_UNUSED, Elm_Frame_Data *_pd EINA_UNUSED)
+_efl_ui_frame_elm_layout_content_aliases_get(Eo *obj EINA_UNUSED, Efl_Ui_Frame_Data *_pd EINA_UNUSED)
 {
    return _content_aliases;
 }
 
 EOLIAN static const Elm_Layout_Part_Alias_Description*
-_elm_frame_elm_layout_text_aliases_get(Eo *obj EINA_UNUSED, Elm_Frame_Data *_pd EINA_UNUSED)
+_efl_ui_frame_elm_layout_text_aliases_get(Eo *obj EINA_UNUSED, Efl_Ui_Frame_Data *_pd EINA_UNUSED)
 {
    return _text_aliases;
 }
@@ -199,7 +199,7 @@ elm_frame_add(Evas_Object *parent)
 }
 
 EOLIAN static Eo *
-_elm_frame_eo_base_constructor(Eo *obj, Elm_Frame_Data *_pd EINA_UNUSED)
+_efl_ui_frame_eo_base_constructor(Eo *obj, Efl_Ui_Frame_Data *_pd EINA_UNUSED)
 {
    obj = eo_constructor(eo_super(obj, MY_CLASS));
    efl_canvas_object_type_set(obj, MY_CLASS_NAME_LEGACY);
@@ -210,20 +210,20 @@ _elm_frame_eo_base_constructor(Eo *obj, Elm_Frame_Data *_pd EINA_UNUSED)
 }
 
 EOLIAN static void
-_elm_frame_autocollapse_set(Eo *obj EINA_UNUSED, Elm_Frame_Data *sd, Eina_Bool autocollapse)
+_efl_ui_frame_autocollapse_set(Eo *obj EINA_UNUSED, Efl_Ui_Frame_Data *sd, Eina_Bool autocollapse)
 {
 
    sd->collapsible = !!autocollapse;
 }
 
 EOLIAN static Eina_Bool
-_elm_frame_autocollapse_get(Eo *obj EINA_UNUSED, Elm_Frame_Data *sd)
+_efl_ui_frame_autocollapse_get(Eo *obj EINA_UNUSED, Efl_Ui_Frame_Data *sd)
 {
    return sd->collapsible;
 }
 
 EOLIAN static void
-_elm_frame_collapse_set(Eo *obj, Elm_Frame_Data *sd, Eina_Bool collapse)
+_efl_ui_frame_collapse_set(Eo *obj, Efl_Ui_Frame_Data *sd, Eina_Bool collapse)
 {
    ELM_WIDGET_DATA_GET_OR_RETURN(obj, wd);
 
@@ -239,7 +239,7 @@ _elm_frame_collapse_set(Eo *obj, Elm_Frame_Data *sd, Eina_Bool collapse)
 }
 
 EOLIAN static void
-_elm_frame_collapse_go(Eo *obj, Elm_Frame_Data *sd, Eina_Bool collapse)
+_efl_ui_frame_collapse_go(Eo *obj, Efl_Ui_Frame_Data *sd, Eina_Bool collapse)
 {
    ELM_WIDGET_DATA_GET_OR_RETURN(obj, wd);
 
@@ -254,15 +254,15 @@ _elm_frame_collapse_go(Eo *obj, Elm_Frame_Data *sd, Eina_Bool collapse)
 }
 
 EOLIAN static Eina_Bool
-_elm_frame_collapse_get(Eo *obj EINA_UNUSED, Elm_Frame_Data *sd)
+_efl_ui_frame_collapse_get(Eo *obj EINA_UNUSED, Efl_Ui_Frame_Data *sd)
 {
    return sd->collapsed;
 }
 
 EOLIAN static void
-_elm_frame_class_constructor(Eo_Class *klass)
+_efl_ui_frame_class_constructor(Eo_Class *klass)
 {
       evas_smart_legacy_type_register(MY_CLASS_NAME_LEGACY, klass);
 }
 
-#include "elm_frame.eo.c"
+#include "efl_ui_frame.eo.c"
similarity index 88%
rename from src/lib/elementary/elm_frame.eo
rename to src/lib/elementary/efl_ui_frame.eo
index 053f349..db718a4 100644 (file)
@@ -1,8 +1,12 @@
-class Elm.Frame (Elm.Layout, Efl.Ui.Clickable)
+class Efl.Ui.Frame (Elm.Layout, Efl.Ui.Clickable)
 {
+   [[Frame widget
+
+   The Frame widget allows for collapsing and expanding the content widget
+   by clicking on the frame label.
+   the label and content can be set using text_set and content_set api.
+   ]]
    legacy_prefix: elm_frame;
-   eo_prefix: elm_obj_frame;
-   event_prefix: elm_frame;
    methods {
       @property collapse {
          set {
similarity index 87%
rename from src/lib/elementary/elm_frame_legacy.h
rename to src/lib/elementary/efl_ui_frame_legacy.h
index a0f51f8..3a1f89b 100644 (file)
@@ -8,4 +8,4 @@
  */
 EAPI Evas_Object                 *elm_frame_add(Evas_Object *parent);
 
-#include "elm_frame.eo.legacy.h"
\ No newline at end of file
+#include "efl_ui_frame.eo.legacy.h"
\ No newline at end of file
similarity index 69%
rename from src/lib/elementary/elm_widget_frame.h
rename to src/lib/elementary/efl_ui_widget_frame.h
index 6f74b24..30c3a79 100644 (file)
@@ -1,5 +1,5 @@
-#ifndef ELM_WIDGET_FRAME_H
-#define ELM_WIDGET_FRAME_H
+#ifndef EFL_UI_WIDGET_FRAME_H
+#define EFL_UI_WIDGET_FRAME_H
 
 #include "Elementary.h"
 
@@ -23,8 +23,8 @@
 /**
  * Base layout smart data extended with frame instance data.
  */
-typedef struct _Elm_Frame_Data Elm_Frame_Data;
-struct _Elm_Frame_Data
+typedef struct _Efl_Ui_Frame_Data Efl_Ui_Frame_Data;
+struct _Efl_Ui_Frame_Data
 {
    Eina_Bool             collapsed : 1;
    Eina_Bool             collapsible : 1;
@@ -35,11 +35,11 @@ struct _Elm_Frame_Data
  * @}
  */
 
-#define ELM_FRAME_DATA_GET(o, sd) \
-  Elm_Frame_Data * sd = eo_data_scope_get(o, ELM_FRAME_CLASS)
+#define EFL_UI_FRAME_DATA_GET(o, sd) \
+  Efl_Ui_Frame_Data * sd = eo_data_scope_get(o, EFL_UI_FRAME_CLASS)
 
-#define ELM_FRAME_DATA_GET_OR_RETURN(o, ptr)         \
-  ELM_FRAME_DATA_GET(o, ptr);                        \
+#define EFL_UI_FRAME_DATA_GET_OR_RETURN(o, ptr)         \
+  EFL_UI_FRAME_DATA_GET(o, ptr);                        \
   if (EINA_UNLIKELY(!ptr))                           \
     {                                                \
        CRI("No widget data for object %p (%s)",      \
@@ -47,8 +47,8 @@ struct _Elm_Frame_Data
        return;                                       \
     }
 
-#define ELM_FRAME_DATA_GET_OR_RETURN_VAL(o, ptr, val) \
-  ELM_FRAME_DATA_GET(o, ptr);                         \
+#define EFL_UI_FRAME_DATA_GET_OR_RETURN_VAL(o, ptr, val) \
+  EFL_UI_FRAME_DATA_GET(o, ptr);                         \
   if (EINA_UNLIKELY(!ptr))                            \
     {                                                 \
        CRI("No widget data for object %p (%s)",       \
@@ -56,8 +56,8 @@ struct _Elm_Frame_Data
        return val;                                    \
     }
 
-#define ELM_FRAME_CHECK(obj)                              \
-  if (EINA_UNLIKELY(!eo_isa((obj), ELM_FRAME_CLASS))) \
+#define EFL_UI_FRAME_CHECK(obj)                              \
+  if (EINA_UNLIKELY(!eo_isa((obj), EFL_UI_FRAME_CLASS))) \
     return
 
 #endif
index 5ff0e17..f1b1031 100644 (file)
  */
 
 #ifdef EFL_EO_API_SUPPORT
-#include "elm_frame_eo.h"
+#include "efl_ui_frame.eo.h"
 #endif
 #ifndef EFL_NOLEGACY_API_SUPPORT
-#include "elm_frame_legacy.h"
+#include "efl_ui_frame_legacy.h"
 #endif
 /**
  * @}
diff --git a/src/lib/elementary/elm_frame_eo.h b/src/lib/elementary/elm_frame_eo.h
deleted file mode 100644 (file)
index 4db1c98..0000000
+++ /dev/null
@@ -1 +0,0 @@
-#include "elm_frame.eo.h"
\ No newline at end of file