Change window transparency behavior (#403)

cztomczak · May 25, 2018 · f699c59 · f699c59
1 parent 5f7a3f1
commit f699c59
Show file tree

Hide file tree

Showing 8 changed files with 48 additions and 35 deletions.
diff --git a/README.md b/README.md
@@ -257,8 +257,8 @@ Additional information for v31.2 release:
 - [Tutorial](docs/Tutorial.md)
 
 
-### API categories
-
+### API categories
+
 #### Modules
 
  * [cefpython](api/cefpython.md#cefpython) module
@@ -313,9 +313,9 @@ Additional information for v31.2 release:
  * [StringVisitor](api/StringVisitor.md#stringvisitor-interface) interface
  * [WebRequestClient](api/WebRequestClient.md#webrequestclient-interface) interface
 
-
-### API index
-
+
+### API index
+
 * [Application settings](api/ApplicationSettings.md#application-settings)
   * [accept_language_list](api/ApplicationSettings.md#accept_language_list)
   * [app_user_model_id](api/ApplicationSettings.md#app_user_model_id)
@@ -748,7 +748,6 @@ Additional information for v31.2 release:
   * [SetAsChild](api/WindowInfo.md#setaschild)
   * [SetAsPopup](api/WindowInfo.md#setaspopup)
   * [SetAsOffscreen](api/WindowInfo.md#setasoffscreen)
-  * [SetTransparentPainting](api/WindowInfo.md#settransparentpainting)
 * [WindowUtils (class)](api/WindowUtils.md#windowutils-class)
   * [OnSetFocus ](api/WindowUtils.md#onsetfocus-win)
   * [OnSize ](api/WindowUtils.md#onsize-win)

diff --git a/api/API-index.md b/api/API-index.md
@@ -434,7 +434,6 @@
   * [SetAsChild](WindowInfo.md#setaschild)
   * [SetAsPopup](WindowInfo.md#setaspopup)
   * [SetAsOffscreen](WindowInfo.md#setasoffscreen)
-  * [SetTransparentPainting](WindowInfo.md#settransparentpainting)
 * [WindowUtils (class)](WindowUtils.md#windowutils-class)
   * [OnSetFocus ](WindowUtils.md#onsetfocus-win)
   * [OnSize ](WindowUtils.md#onsize-win)

diff --git a/docs/Migration-guide.md b/docs/Migration-guide.md
@@ -39,7 +39,8 @@ Table of contents:
 * [v66+ Linux patch that fixed HTTPS cache problems on pages with certificate errors was disabled](#v66-linux-patch-that-fixed-https-cache-problems-on-pages-with-certificate-errors-was-disabled)
 * [v66+ DisplayHandler.OnConsoleMessage has a new param 'level'](#v66-displayhandleronconsolemessage-has-a-new-param-level)
 * [v66+ LifespanHandler.OnBeforePopup is now called on UI thread](#v66-lifespanhandleronbeforepopup-is-now-called-on-ui-thread)
-* [V66+ RequestHandler.OnBeforeBrowse has a new param 'user_gesture'](#v66-requesthandleronbeforebrowse-has-a-new-param-user_gesture)
+* [v66+ RequestHandler.OnBeforeBrowse has a new param 'user_gesture'](#v66-requesthandleronbeforebrowse-has-a-new-param-user_gesture)
+* [v66+ Window transparency changes](#v66-window-transparency-changes)
 
 
 
@@ -324,8 +325,22 @@ callback is now called on UI thread. Previously it was called on
 IO thread.
 
 
-## V66+ RequestHandler.OnBeforeBrowse has a new param 'user_gesture'
+## v66+ RequestHandler.OnBeforeBrowse has a new param 'user_gesture'
 
 The RequestHandler.[OnBeforeBrowse](../api/RequestHandler.md#onbeforebrowse)
 callback has a new param `user_gesture`.
 
+
+## v66+ Window transparency changes
+
+1. OSR windows (off-screen rendering, also known as windowless) are now
+transparent by default. You can control its transperency with
+ApplicationSettings.[background_color](../api/ApplicationSettings.md#background_color) and BrowserSettings.[background_color](../api/BrowserSettings.md#background_color) options.
+The WindowInfo.`SetTransparentPainting` method is now deprecated. Calling
+it with True will do nothing, and calling it with False **will result
+in exception**.
+
+2. It is now possible to have
+transparent windows also in **windowed mode**. This seems to be working
+only on Linux (got it working on Fedora with just a change in window setting).
+
diff --git a/src/cef_v59..v66_changes.txt b/src/cef_v59..v66_changes.txt
@@ -27,20 +27,20 @@ BREAKAGE (needs updating Migration Guide doc)
 - + OnBeforeBrowse: new param 'user_gesture'
 - + update Migration Guide
 
-internal/cef_linux.h
-internal/cef_types_linux.h
-internal/cef_mac.h
-internal/cef_types_mac.h
-internal/cef_win.h
-internal/cef_types_win.h
-- OSR windows are transparent by default. To change it set
-  CefBrowserSettings.background_color .
-- CefWindowInfo (cef_window_info_t): transparent_painting_enabled option removed
-- CefWindowInfo.SetAsWindowless: 'transparent' param removed
-- Deprecate WindowInfo.SetTransparentPainting method. When set
-  to True do nothing. If set to False then raise Exception
-  and provide info on CefBrowserSettings.background_color.
-  - Update Migration Guide doc
++ internal/cef_linux.h
++ internal/cef_types_linux.h
++ internal/cef_mac.h
++ internal/cef_types_mac.h
++ internal/cef_win.h
++ internal/cef_types_win.h
+- + OSR windows are transparent by default. To change it set
+    CefBrowserSettings.background_color .
+- + CefWindowInfo (cef_window_info_t): transparent_painting_enabled option removed
+- + CefWindowInfo.SetAsWindowless: 'transparent' param removed
+- + Deprecate WindowInfo.SetTransparentPainting method. When set
+    to True do nothing. If set to False then raise Exception
+    and provide info on CefBrowserSettings.background_color.
+  - + Update Migration Guide doc
 
 internal/cef_types.h
 - cef_settings_t:

diff --git a/src/extern/cef/cef_linux.pxd b/src/extern/cef/cef_linux.pxd
@@ -15,8 +15,7 @@ cdef extern from "include/internal/cef_linux.h":
     cdef cppclass CefWindowInfo:
         void SetAsChild(CefWindowHandle parent,
                         const CefRect& windowRect)
-        void SetAsWindowless(CefWindowHandle parent,
-                             cpp_bool transparent)
+        void SetAsWindowless(CefWindowHandle parent)
 
     cdef cppclass CefMainArgs:
         CefMainArgs()

diff --git a/src/extern/cef/cef_mac.pxd b/src/extern/cef/cef_mac.pxd
@@ -14,8 +14,7 @@ cdef extern from "include/internal/cef_mac.h":
     cdef cppclass CefWindowInfo:
         void SetAsChild(CefWindowHandle parent,
                         int x, int y, int width, int height)
-        void SetAsWindowless(CefWindowHandle parent,
-                             cpp_bool transparent)
+        void SetAsWindowless(CefWindowHandle parent)
 
     cdef cppclass CefMainArgs:
         CefMainArgs()

diff --git a/src/extern/cef/cef_win.pxd b/src/extern/cef/cef_win.pxd
@@ -21,8 +21,7 @@ cdef extern from "include/internal/cef_win.h":
                         RECT windowRect)
         void SetAsPopup(CefWindowHandle parent,
                         const CefString& windowName)
-        void SetAsWindowless(CefWindowHandle parent,
-                        cpp_bool transparent)
+        void SetAsWindowless(CefWindowHandle parent)
 
     cdef cppclass CefMainArgs:
         CefMainArgs()

diff --git a/src/window_info.pyx b/src/window_info.pyx
@@ -63,21 +63,17 @@ cdef void SetCefWindowInfo(
                     <CefWindowHandle>windowInfo.parentWindowHandle,
                     windowName)
 
-    cdef cpp_bool transparent = bool(windowInfo.transparentPainting)
     if windowInfo.windowType == "offscreen":
         cefWindowInfo.SetAsWindowless(
-                <CefWindowHandle>windowInfo.parentWindowHandle,
-                transparent)
+                <CefWindowHandle>windowInfo.parentWindowHandle)
 
 cdef class WindowInfo:
     cdef public str windowType
     cdef public WindowHandle parentWindowHandle
     cdef public list windowRect # [left, top, right, bottom]
     cdef public py_string windowName
-    cdef public py_bool transparentPainting
 
     def __init__(self, title=""):
-        self.transparentPainting = False
         self.windowName = ""
         if title:
             self.windowName = title
@@ -135,4 +131,11 @@ cdef class WindowInfo:
 
     cpdef py_void SetTransparentPainting(self,
             py_bool transparentPainting):
-        self.transparentPainting = transparentPainting
+        """Deprecated."""
+        if transparentPainting:
+            # Do nothing, since v66 OSR windows are transparent by default
+            pass
+        else:
+            raise Exception("This method is deprecated since v66, see "
+                            "Migration Guide document.")
+