X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/edb247200c5b49e242e75c2e725a933c774006f8..58f1fdc926e4fc0f0b8ca49384d72e51bea2e86b:/docs/latex/wx/progdlg.tex

diff --git a/docs/latex/wx/progdlg.tex b/docs/latex/wx/progdlg.tex
index c73fed18a7..ebe4bf768b 100644
--- a/docs/latex/wx/progdlg.tex
+++ b/docs/latex/wx/progdlg.tex
@@ -1,3 +1,14 @@
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%% Name:        progdlg.tex
+%% Purpose:     wxProgressDialog documentation
+%% Author:      wxWidgets Team
+%% Modified by:
+%% Created:     01.06.03
+%% RCS-ID:      $Id$
+%% Copyright:   (c) wxWidgets Team
+%% License:     wxWindows license
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
 \section{\class{wxProgressDialog}}\label{wxprogressdialog}
 
 This class represents a dialog that shows a short message and a
@@ -5,7 +16,7 @@ progress bar. Optionally, it can display an ABORT button.
 
 \wxheading{Derived from}
 
-\helpref{wxFrame}{wxframe}\\
+\helpref{wxDialog}{wxdialog}\\
 \helpref{wxWindow}{wxwindow}\\
 \helpref{wxEvtHandler}{wxevthandler}\\
 \helpref{wxObject}{wxobject}
@@ -16,7 +27,7 @@ progress bar. Optionally, it can display an ABORT button.
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
-\membersection{wxProgressDialog::wxProgressDialog}\label{wxprogressdialogconstr}
+\membersection{wxProgressDialog::wxProgressDialog}\label{wxprogressdialogctor}
 
 \func{}{wxProgressDialog}{\param{const wxString\& }{title},
  \param{const wxString\& }{message},\rtfsp
@@ -38,8 +49,6 @@ window only.
 
 \docparam{parent}{Parent window.}
 
-\docparam{message}{Message to show on the dialog.}
-
 \docparam{style}{The dialog style. This is the combination of the following
 bitmask constants defined in wx/defs.h:
 
@@ -51,9 +60,13 @@ window is disabled, but not to the other ones.}
 \twocolitem{{\bf wxPD\_AUTO\_HIDE}}{Causes the progress dialog to disappear
 from screen as soon as the maximum value of the progress meter has been
 reached.}
+\twocolitem{{\bf wxPD\_SMOOTH}}{Causes smooth progress of the gauge control.}
 \twocolitem{{\bf wxPD\_CAN\_ABORT}}{This flag tells the dialog that it should have a
-"Cancel" button which the user may press. If this happens, the next call to 
- \helpref{Update()}{wxprogressdialogupdate} will return false.}
+"Cancel" button which the user may press. If this happens, the next call to
+\helpref{Update()}{wxprogressdialogupdate} will return false.}
+\twocolitem{{\bf wxPD\_CAN\_SKIP}}{This flag tells the dialog that it should have a
+"Skip" button which the user may press. If this happens, the next call to
+\helpref{Update()}{wxprogressdialogupdate} will return true in its skip parameter.}
 \twocolitem{{\bf wxPD\_ELAPSED\_TIME}}{This flag tells the dialog that it should show elapsed time (since creating the dialog).}
 \twocolitem{{\bf wxPD\_ESTIMATED\_TIME}}{This flag tells the dialog that it should show estimated time.}
 \twocolitem{{\bf wxPD\_REMAINING\_TIME}}{This flag tells the dialog that it should show remaining time.}
@@ -62,9 +75,9 @@ reached.}
 \end{twocollist}%
 }
 
-\membersection{wxProgressDialog::\destruct{wxProgressDialog}}
+\membersection{wxProgressDialog::\destruct{wxProgressDialog}}\label{wxprogressdialogdtor}
 
-\func{}{\destruct{wxMessageDialog}}{\void}
+\func{}{\destruct{wxProgressDialog}}{\void}
 
 Destructor. Deletes the dialog and enables all top level windows.
 
@@ -77,9 +90,10 @@ ABORT.
 
 \membersection{wxProgressDialog::Update}\label{wxprogressdialogupdate}
 
-\func{bool}{Update}{
+\func{virtual bool}{Update}{
   \param{int }{value},\rtfsp
-  \param{const wxString\&}{newmsg = ""},  }
+  \param{const wxString\& }{newmsg = ""},\rtfsp
+  \param{bool *}{skip = NULL}}
 
 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
@@ -91,9 +105,10 @@ dialog may be resumed with \helpref{Resume}{wxprogressdialogresume} function.
 
 \wxheading{Parameters}
 
-\docparam{value}{The new value of the progress meter. It must be strictly less
-than the maximum value given to the constructor (i.e., as usual in C, the
-index runs from $0$ to $maximum-1$).}
+\docparam{value}{The new value of the progress meter. It 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.}
 \docparam{newmsg}{The new messages for the progress dialog text, if it is
 empty (which is the default) the message is not changed.}
-
+\docparam{skip}{If "Skip" button was pressed since last
+\helpref{Update}{wxprogressdialogupdate} call the skip is true.}