Update Migration Guide document. Changes to Mac apps that

cztomczak · cztomczak · commit 4e77c936b88c · 2018-08-07T21:04:59.000+02:00
integrate into existing message loops (Qt, wxPython) (cztomczak#442).
diff --git a/README.md b/README.md
@@ -254,8 +254,8 @@ Additional information for v31.2 release:
 - [Tutorial](docs/Tutorial.md)
 
 
-### API categories
-
+### API categories
+
 #### Modules
 
  * [cefpython](api/cefpython.md#cefpython) module
@@ -310,9 +310,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)
@@ -652,7 +652,7 @@ Additional information for v31.2 release:
   * [ERR_UNSAFE_REDIRECT](api/NetworkError.md#err_unsafe_redirect)
 * [PaintBuffer (object)](api/PaintBuffer.md#paintbuffer-object)
   * [GetIntPointer](api/PaintBuffer.md#getintpointer)
-  * [GetString](api/PaintBuffer.md#getstring)
+  * [GetBytes](api/PaintBuffer.md#getbytes)
 * [RenderHandler (interface)](api/RenderHandler.md#renderhandler-interface)
   * [GetRootScreenRect](api/RenderHandler.md#getrootscreenrect)
   * [GetViewRect](api/RenderHandler.md#getviewrect)
diff --git a/api/API-index.md b/api/API-index.md
@@ -341,7 +341,7 @@
   * [ERR_UNSAFE_REDIRECT](NetworkError.md#err_unsafe_redirect)
 * [PaintBuffer (object)](PaintBuffer.md#paintbuffer-object)
   * [GetIntPointer](PaintBuffer.md#getintpointer)
-  * [GetString](PaintBuffer.md#getstring)
+  * [GetBytes](PaintBuffer.md#getbytes)
 * [RenderHandler (interface)](RenderHandler.md#renderhandler-interface)
   * [GetRootScreenRect](RenderHandler.md#getrootscreenrect)
   * [GetViewRect](RenderHandler.md#getviewrect)
diff --git a/docs/Migration-guide.md b/docs/Migration-guide.md
@@ -44,7 +44,8 @@ Table of contents:
 * [v66+ BrowserSettings.javascript_open_windows_disallowed option was removed](#v66-browsersettingsjavascript_open_windows_disallowed-option-was-removed)
 * [v66+ Threads removed: TID_DB, TID_PROCESS_LAUNCHER, TID_CACHE](#v66-threads-removed-tid_db-tid_process_launcher-tid_cache)
 * [v66+ cef.Request.Flags changed](#v66-cefrequestflags-changed)
-* [v66+ RequestHandler.GetCookieManager 'browser' param may be None](#v66-requesthandlergetcookiemanager-browser-param-may-be-none)
+* [v66+ RequestHandler.GetCookieManager not getting called in some cases](#v66-requesthandlergetcookiemanager-not-getting-called-in-some-cases)
+* [v66+ Changes to Mac apps that integrate into existing message loops (Qt, wxPython)](#v66-changes-to-mac-apps-that-integrate-into-existing-message-loops-qt-wxpython)
 
 
 
@@ -384,3 +385,19 @@ In some cases the RequestHandler.[GetCookieManager](../api/RequestHandler.md#get
 callback is not getting called due to a race condition.
 This bug is to be fixed in Issue [#429](../../../issues/429).
 
+
+## v66+ Changes to Mac apps that integrate into existing message loops (Qt, wxPython)
+
+The `qt.py` and `wxpython.py` examples were modified to set
+ApplicationSettings.[external_message_pump](../api/ApplicationSettings.md#external_message_pump)
+to `True`. Due to Issue [#442](../../../issues/442) it is required
+to implement both approaches to integrating with existing message
+loops at the same time:
+1. Call `cef.DoMessageLoopWork` in a 10ms timer
+2. Set `ApplicationSettings.external_message_pump` to True
+
+This is not a correct approach and is only a temporary fix. More
+testing is required to check if that resolves all the issues with message
+loop freezing. Only basic testing was performed. It was not tested of
+how this change affects performance.
+
