documented that wxHSCROLL disables wrapping; added comment to the source

[wxWidgets.git] / docs / latex / wx / progdlg.tex

diff --git a/docs/latex/wx/progdlg.tex b/docs/latex/wx/progdlg.tex
index e07785da3c3a9bb4a87501e1a31693903bfdf4e5..24851fe91620fd089944e3b34add4239906daff0 100644 (file)
--- a/docs/latex/wx/progdlg.tex
+++ b/docs/latex/wx/progdlg.tex
@@ -45,21 +45,20 @@ bitmask constants defined in wx/defs.h:
 
 \twocolwidtha{7cm}
 \begin{twocollist}\itemsep=0pt
-\twocolitem{wxPD\_APP\_MODAL}{Make the progress dialog modal. If this flag is
+\twocolitem{{\bf wxPD\_APP\_MODAL}}{Make the progress dialog modal. If this flag is
 not given, it is only "locally" modal - that is the input to the parent
 window is disabled, but not to the other ones.}
-\twocolitem{wxPD\_AUTO\_HIDE}{By default, the progress dialog will disappear
+\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. This flag prevents it from doing it - instead the dialog will wait
-until the user closes it.}
-\twocolitem{wxPD\_CAN\_ABORT}{This flag tells the dialog that it should have a
+reached.}
+\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.}
-\twocolitem{wxPD\_ELAPSED\_TIME}{This flag tells the dialog that it should show elapsed time (since creating the dialog).}
-\twocolitem{wxPD\_ESTIMATED\_TIME}{This flag tells the dialog that it should show estimated time.}
-\twocolitem{wxPD\_REMAINING\_TIME}{This flag tells the dialog that it should show remaining time.}
-\twocolitem{wxGA\_SMOOTH}{This flag tells the dialog that it should use
-smooth gauge (has effect only under 32bit Windows).}
+ \helpref{Update()}{wxprogressdialogupdate} will return false.}
+\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.}
+%\twocolitem{{\bf wxPD\_SMOOTH}}{This flag tells the dialog that it should use
+%smooth gauge (has effect only under 32bit Windows).}
 \end{twocollist}%
 }
 
@@ -69,30 +68,32 @@ smooth gauge (has effect only under 32bit Windows).}
 
 Destructor. Deletes the dialog and enables all top level windows.
 
+\membersection{wxProgressDialog::Resume}\label{wxprogressdialogresume}
+
+\func{void}{Resume}{\void}
+
+Can be used to continue with the dialog, after the user had chosen
+ABORT.
+
 \membersection{wxProgressDialog::Update}\label{wxprogressdialogupdate}
 
 \func{bool}{Update}{
-  \param{int }{value = -1},\rtfsp
-  \param{const char * }{newmsg = NULL},  }
+  \param{int }{value},\rtfsp
+  \param{const wxString\& }{newmsg = ""}}
 
 Updates the dialog, setting the progress bar to the new value and, if
-given changes the message above it. Returns TRUE if the ABORT button 
-has \emph{not} been pressed.
+given changes the message above it. Returns true unless the Cancel button
+has been pressed.
 
-If FALSE is returned, the application can either immediately destroy the dialog
+If false is returned, the application can either immediately destroy the dialog
 or ask the user for the confirmation and if the abort is not confirmed the
 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{newmsg}{The new messages for the progress dialog text, if none is
-given the message is not changed.}
-
-\membersection{wxProgressDialog::Resume}\label{wxprogressdialogresume}
-
-\func{void}{Resume}{\void}
-
-Can be used to continue with the dialog, after the user had chosen
-ABORT.
+\docparam{newmsg}{The new messages for the progress dialog text, if it is
+empty (which is the default) the message is not changed.}