[prev in list] [next in list] [prev in thread] [next in thread] 

List:       kde-commits
Subject:    KDE/kdelibs/kdeui/dialogs
From:       David Faure <faure () kde ! org>
Date:       2008-10-08 14:19:06
Message-ID: 1223475546.889131.322.nullmailer () svn ! kde ! org
[Download RAW message or body]

SVN commit 869222 by dfaure:

improve docs (mention default value for minimumDuration and describe behavior -- which happens
to be slightly different from the QProgressDialog behavior, surprisingly...)


 M  +10 -2     kprogressdialog.h  


--- trunk/KDE/kdelibs/kdeui/dialogs/kprogressdialog.h #869221:869222
@@ -172,12 +172,20 @@
 
         /**
          * Set the minimum number of milliseconds to wait before
-         * actually showing the dialog
+         * actually showing the dialog.
+         *
+         * If the expected duration of the task is less than the minimumDuration, the dialog will
+         * not appear at all. This prevents the dialog popping up for tasks that are quickly over.
+         * For tasks that are expected to exceed the minimumDuration, the dialog will pop up after
+         * the minimumDuration time.
+         * If set to 0, the dialog is always shown immediately. The default is
+         * 2000 milliseconds.
          */
         void setMinimumDuration(int ms);
 
         /**
-         * Returns the wait duration in milliseconds
+         * Returns the time that must pass before the dialog appears.
+         * @see setMinimumDuration
          */
         int minimumDuration() const;
 
[prev in list] [next in list] [prev in thread] [next in thread]