win: Mark unstable APIs as @beta (stack API)
authorJean-Philippe Andre <jp.andre@samsung.com>
Wed, 29 Mar 2017 00:39:34 +0000 (09:39 +0900)
committerJean-Philippe Andre <jp.andre@samsung.com>
Wed, 29 Mar 2017 00:51:28 +0000 (09:51 +0900)
We have a tag for unstable API, use it. It'll be visible in the
doc and force users to add the macro before being able to compile
code.

This amends d8dd685966858dcc393302.

src/bin/elementary/test_win_stack.c
src/lib/elementary/efl_ui_win.c
src/lib/elementary/efl_ui_win.eo

index 128a805..23df1bf 100644 (file)
@@ -1,6 +1,9 @@
 #ifdef HAVE_CONFIG_H
 # include "elementary_config.h"
 #endif
+
+// Stack API is still beta (and EO only)
+#define EFL_UI_WIN_BETA
 #include <Elementary.h>
 
 static int level = 0;
@@ -72,7 +75,7 @@ _win_new(Evas_Object *stack_top, const char *title)
 static void
 _bt_popto(void *data EINA_UNUSED, Evas_Object *obj EINA_UNUSED, void *event_info EINA_UNUSED)
 {
-   elm_win_stack_pop_to(popto_win);
+   efl_ui_win_stack_pop_to(popto_win);
 }
 
 static void
@@ -84,7 +87,7 @@ _bt_pressed(void *data, Evas_Object *obj EINA_UNUSED, void *event_info EINA_UNUS
    level++;
    snprintf(buf, sizeof(buf), "Level %i", level);
    win = _win_new(data, buf);
-   elm_win_stack_master_id_set(win, elm_win_stack_id_get(data));
+   efl_ui_win_stack_master_id_set(win, efl_ui_win_stack_id_get(data));
    evas_object_show(win);
 }
 
@@ -94,7 +97,7 @@ test_win_stack(void *data EINA_UNUSED, Evas_Object *obj EINA_UNUSED, void *event
    Evas_Object *bg, *bx, *bt, *lb, *win;
 
    win = elm_win_add(NULL, "window-stack", ELM_WIN_BASIC);
-   elm_win_stack_base_set(win, EINA_TRUE);
+   efl_ui_win_stack_base_set(win, EINA_TRUE);
    elm_win_title_set(win, "Window Stack");
    elm_win_autodel_set(win, EINA_TRUE);
 
index 647de13..9e326a2 100644 (file)
@@ -6,6 +6,7 @@
 #define ELM_INTERFACE_ATSPI_WIDGET_ACTION_PROTECTED
 #define EFL_INPUT_EVENT_PROTECTED
 #define EFL_GFX_SIZE_HINT_PROTECTED
+#define EFL_UI_WIN_BETA
 
 #include <Elementary.h>
 #include <Elementary_Cursor.h>
index d1ece4b..8e63c08 100644 (file)
@@ -733,7 +733,7 @@ class Efl.Ui.Win (Elm.Widget, Efl.Canvas, Elm.Interface.Atspi.Window,
                            $false otherwise.]]
          }
       }
-      @property stack_id {
+      @property stack_id @beta {
          get {
             [[Get the stack ID string of the window as an opaque string.
 
@@ -746,9 +746,7 @@ class Efl.Ui.Win (Elm.Widget, Efl.Canvas, Elm.Interface.Atspi.Window,
               use by other windows to make this window part of a stack
               of windows to be placed on top of eachother as if they are
               a series of dialogs or questions one after the other and
-              that you may go back through history.
-
-              WARNING: This API is not stable - do not use yet]]
+              that you may go back through history.]]
          }
          values {
             id: string; [[An opaque string that has no specific format,
@@ -756,16 +754,14 @@ class Efl.Ui.Win (Elm.Widget, Efl.Canvas, Elm.Interface.Atspi.Window,
                           display.]]
          }
       }
-      @property stack_master_id {
+      @property stack_master_id @beta {
          set {
             [[Set the window stack ID to use as the master top-level.
 
               This sets the ID string to be used as the master top-level
               window as the base of a stack of windows. This must be set
               before the first time the window is shown and should never
-              be changed after that point in time ever again.
-
-              WARNING: This API is not stable - do not use yet]]
+              be changed after that point in time ever again.]]
          }
          get {
             [[Get the stack master Id that has been set.]]
@@ -776,7 +772,7 @@ class Efl.Ui.Win (Elm.Widget, Efl.Canvas, Elm.Interface.Atspi.Window,
                           display.]]
          }
       }
-      @property stack_base {
+      @property stack_base @beta {
          [[The stack base state of this window
 
            This is a boolean flag that determines if this window will
@@ -785,9 +781,7 @@ class Efl.Ui.Win (Elm.Widget, Efl.Canvas, Elm.Interface.Atspi.Window,
            correctly.
 
            This state should be set before a window is shown for the
-           first time and never changed again after that.
-
-           WARNING: This API is not stable - do not use yet]]
+           first time and never changed again after that.]]
 
          set {}
          get {}
@@ -796,13 +790,11 @@ class Efl.Ui.Win (Elm.Widget, Efl.Canvas, Elm.Interface.Atspi.Window,
                           otherwise.]]
          }
       }
-      stack_pop_to {
+      stack_pop_to @beta {
          [[Pop (delete) all windows in the stack above this window.
 
            This will try and delete all the windows in the stack that
-           are above the window.
-
-           WARNING: This API is not stable - do not use yet]]
+           are above the window.]]
       }
       socket_listen {
          [[Create a socket to provide the service for Plug widget.]]