From 25b2deb8a59ecabca03d137e4c89a964ae2aff71 Mon Sep 17 00:00:00 2001 From: Steve Lamerton Date: Mon, 8 Aug 2011 11:22:40 +0000 Subject: [PATCH] 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 --- interface/wx/webview.h | 13 ++++++++++--- 1 file changed, 10 insertions(+), 3 deletions(-) diff --git a/interface/wx/webview.h b/interface/wx/webview.h index 2414f41e38..eaa2a5c77a 100644 --- a/interface/wx/webview.h +++ b/interface/wx/webview.h @@ -153,9 +153,16 @@ public: setting, see this 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 -- 2.45.2