Document new wxProgressDialog auto-resizing behaviour

The dialog now grows automatically as needed and Fit() can be called to
shrink it back if desired and this behaviour is consistent under all
platforms.
This commit is contained in:
Vadim Zeitlin
2017-10-27 01:45:50 +02:00
parent 4101849b4d
commit ec82ae1302

View File

@@ -192,12 +192,12 @@ public:
for the user to dismiss it, meaning that this function does not return for the user to dismiss it, meaning that this function does not return
until this happens. until this happens.
Notice that you may want to call Fit() to change the dialog size to Notice that if @a newmsg is longer than the currently shown message,
conform to the length of the new message if desired. The dialog does the dialog size will be automatically increased to account for it.
not do this automatically, except for the native MSW implementation However if the new message is shorter than the previous one, the dialog
which does increase the dialog size if necessary (but still doesn't doesn't shrink back to avoid constant resizes if the message is changed
shrink it back even if the text becomes shorter and you need to call often. To shrink back the dialog to fit its current contents you may
Fit() explicitly if you want this to happen). call Fit() explicitly.
@param value @param value
The new value of the progress meter. It should be less than or equal to The new value of the progress meter. It should be less than or equal to