Add a section about async notifications to the documentation.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/branches/SOC2011_WEBVIEW@68599 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775

diff --git a/interface/wx/webview.h b/interface/wx/webview.h
index 2414f41e3820056614cfc280ae7986f4a6804b8c..eaa2a5c77adc2631f67c94ba60d7672e02b95e27 100644 (file)
--- a/interface/wx/webview.h
+++ b/interface/wx/webview.h
@@ -153,9 +153,16 @@ public:
     setting, see 
     <a href="http://msdn.microsoft.com/en-us/library/ee330730%28v=vs.85%29.aspx#browser_emulation">
     this</a> article for more information.
     setting, see 
     <a href="http://msdn.microsoft.com/en-us/library/ee330730%28v=vs.85%29.aspx#browser_emulation">
     this</a> article for more information.

-  
-    Note that errors are generally reported asynchronously though the
-    @c wxEVT_COMMAND_WEB_VIEW_ERROR event described below.
+
+    @section async Asynchronous Notifications
+    
+    Many of the methods in wxWebView are asynchronous, i.e. they return
+    immediately and perform their work in the background. This includes
+    functions such as LoadUrl() and Reload(). To receive notification of the 
+    progress and completion of these functions you need to handle the events
+    that are provided. Specifically @c wxEVT_COMMAND_WEB_VIEW_LOADED notifies
+    when the page or a sub-frame has finished loading and 
+    @c wxEVT_COMMAND_WEB_VIEW_ERROR notifies that an error has occurred.

     
     @section vfs Virtual File Systems and Custom Schemes
     
     
     @section vfs Virtual File Systems and Custom Schemes