win: Add more description for automatic switch to alpha window by theme.

This is a documentation for e07061c5d5a9b1ec79278da82208ad486937b873.

diff --git a/src/lib/elm_win.c b/src/lib/elm_win.c
index 4f9bafce83f77f363b8f40853a81f230b0e2d26e..2446d8947b7c4e3add4d61f48535d7e7db900275 100644 (file)
--- a/src/lib/elm_win.c
+++ b/src/lib/elm_win.c
@@ -209,8 +209,8 @@ struct _Elm_Win_Data
    Eina_Bool    skip_focus : 1;
    Eina_Bool    floating : 1;
    Eina_Bool    noblank : 1;
-   Eina_Bool    theme_alpha : 1;
-   Eina_Bool    application_alpha : 1;
+   Eina_Bool    theme_alpha : 1; /**< alpha value fetched by a theme. this has higher priority than application_alpha */
+   Eina_Bool    application_alpha : 1; /**< alpha value set by an elm_win_alpha_set() api. this has lower priority than theme_alpha */
 };
 
 static const char SIG_DELETE_REQUEST[] = "delete,request";

diff --git a/src/lib/elm_win.eo b/src/lib/elm_win.eo
index a78309ed3d30eb136a152aff0a25dc952cae2417..76e317b1b31754c624ef89f2cbd7c42712d637dd 100644 (file)
--- a/src/lib/elm_win.eo
+++ b/src/lib/elm_win.eo
@@ -433,6 +433,10 @@ class Elm_Win (Elm_Widget, Elm_Interface_Atspi_Window,
             available, enabling this option will instead fallback to using shaped
             windows, with elm_win_shaped_set().
 
+            @note Alpha window can be enabled automatically by window theme style's property.
+            If "alpha" data.item is "1" or "true" in window style(eg. elm/win/base/default),
+            the window is switched to alpha automatically without the explicit api call.
+
             @see elm_win_alpha_set()
 
             @ingroup Win */