fixed syntax errors (incorrect use of _)

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

diff --git a/docs/latex/wx/progdlg.tex b/docs/latex/wx/progdlg.tex
index fc7f5a5fe5db174ddb93f1c9a5c6ec690f332de8..ebe4bf768bca6a909ad1d7be3b53e7f809864e83 100644 (file)
--- 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
 \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}
 
 
 \wxheading{Derived from}
 

-\helpref{wxFrame}{wxframe}\\
+\helpref{wxDialog}{wxdialog}\\

 \helpref{wxWindow}{wxwindow}\\
 \helpref{wxEvtHandler}{wxevthandler}\\
 \helpref{wxObject}{wxobject}
 \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}}}
 
 
 \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
 
 \func{}{wxProgressDialog}{\param{const wxString\& }{title},
  \param{const wxString\& }{message},\rtfsp


@@ -38,8 +49,6 @@ window only.
 
 \docparam{parent}{Parent window.}
 
 
 \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:
 
 \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\_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
 \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.}
 \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,36 +75,40 @@ reached.}
 \end{twocollist}%
 }
 
 \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.
 
 
 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}
 
 \membersection{wxProgressDialog::Update}\label{wxprogressdialogupdate}
 

-\func{bool}{Update}{
-  \param{int }{value = -1},\rtfsp
-  \param{const char * }{newmsg = NULL},  }
+\func{virtual bool}{Update}{
+  \param{int }{value},\rtfsp
+  \param{const wxString\& }{newmsg = ""},\rtfsp
+  \param{bool *}{skip = NULL}}

 
 Updates the dialog, setting the progress bar to the new value and, if
 
 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
 or ask the user for the confirmation and if the abort is not confirmed the
 dialog may be resumed with \helpref{Resume}{wxprogressdialogresume} function.
 
 
 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.
 

-\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.
+\wxheading{Parameters}

 
 

+\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.}