X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/da397248d3293b4336ec900e1eeac3d75a62c631..015fd9ef4833ec3d8b0043a1c7e448c8be4f734a:/wxPython/src/_cmndlgs.i diff --git a/wxPython/src/_cmndlgs.i b/wxPython/src/_cmndlgs.i index 242ea66e70..1e4c13c7de 100644 --- a/wxPython/src/_cmndlgs.i +++ b/wxPython/src/_cmndlgs.i @@ -660,8 +660,10 @@ parent window only.", ""); DocDeclStr( virtual bool , Update(int value, const wxString& newmsg = wxPyEmptyString), "Updates the dialog, setting the progress bar to the new value and, if -given changes the message above it. Returns true unless the Cancel -button has been pressed. +given changes the message above it. The value given should be less +than or equal to the maximum value given to the constructor and the +dialog is closed if it is equal to the maximum. Returns true unless +the Cancel button has been pressed. If false is returned, the application can either immediately destroy the dialog or ask the user for the confirmation and if the abort is