From 4d20de73bd21b2f3da14147658a15e3e01b66faf Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?C=C4=83t=C4=83lin=20R=C4=83ceanu?= Date: Fri, 9 Dec 2016 18:09:43 +0200 Subject: [PATCH] Describe better which windows are affected by wxWindowDisabler It affects only windows shown on the screen and not already disabled. Closes https://github.com/wxWidgets/wxWidgets/pull/366 --- interface/wx/utils.h | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/interface/wx/utils.h b/interface/wx/utils.h index 12c433a3f3..020d6b5b39 100644 --- a/interface/wx/utils.h +++ b/interface/wx/utils.h @@ -58,13 +58,16 @@ enum wxShutdownFlags /** @class wxWindowDisabler - This class disables all windows of the application (may be with the - exception of one of them) in its constructor and enables them back in its - destructor. + This class disables all top level windows of the application (maybe with + the exception of one of them) in its constructor and enables them back in + its destructor. This is useful when you want to indicate to the user that the application is currently busy and cannot respond to user input. + @note When instantiated, this affects only windows shown on the screen and + not already disabled. + @library{wxcore} @category{misc}