From 23ac76056fd0ae75149dab806fc266e6ee9b0115 Mon Sep 17 00:00:00 2001
From: Robert Roebling <robert@roebling.de>
Date: Sat, 9 Sep 2006 13:46:11 +0000
Subject: [PATCH]   Applied doc patch.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@41091 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
---
 docs/latex/wx/gauge.tex   | 31 ++++++++++++++---
 docs/latex/wx/progdlg.tex | 72 +++++++++++++++++++++++----------------
 2 files changed, 69 insertions(+), 34 deletions(-)

diff --git a/docs/latex/wx/gauge.tex b/docs/latex/wx/gauge.tex
index 563bdbbc8e..49bf0d7346 100644
--- a/docs/latex/wx/gauge.tex
+++ b/docs/latex/wx/gauge.tex
@@ -1,6 +1,19 @@
 \section{\class{wxGauge}}\label{wxgauge}
 
 A gauge is a horizontal or vertical bar which shows a quantity (often time).
+
+wxGauge supports two working modes: determinate and indeterminate progress.
+
+The first is the usual working mode (see \helpref{SetValue}{wxgaugesetvalue}
+and \helpref{SetRange}{wxgaugesetrange}) while the second can be used when
+the program is doing some processing but you don't know how much progress is
+being done.
+In this case, you can periodically call the \helpref{Pulse}{wxgaugepulse}
+function to make the progress bar switch to indeterminate mode (graphically
+it's usually a set of blocks which move or bounce in the bar control).
+
+wxGauge supports dynamic switch between these two work modes.
+
 There are no user commands for the gauge.
 
 \wxheading{Derived from}
@@ -55,7 +68,7 @@ Constructor, creating and showing a gauge.
 
 \docparam{id}{Window identifier.}
 
-\docparam{range}{Integer range (maximum value) of the gauge.}
+\docparam{range}{Integer range (maximum value) of the gauge. It is ignored when the gauge is used in indeterminate mode.}
 
 \docparam{pos}{Window position.}
 
@@ -108,10 +121,6 @@ This method is not implemented (returns $0$) for most platforms.
 
 Returns the maximum position of the gauge.
 
-\wxheading{Remarks}
-
-This method is not implemented (doesn't do anything) for most platforms.
-
 \wxheading{See also}
 
 \helpref{wxGauge::SetRange}{wxgaugesetrange}
@@ -171,6 +180,7 @@ This method is not implemented (doesn't do anything) for most platforms.
 \func{void}{SetRange}{\param{int }{range}}
 
 Sets the range (maximum value) of the gauge.
+This function makes the gauge switch to determinate mode, if it's not already.
 
 \wxheading{See also}
 
@@ -193,6 +203,7 @@ This method is not implemented (doesn't do anything) for most platforms.
 \func{void}{SetValue}{\param{int }{pos}}
 
 Sets the position of the gauge.
+This function makes the gauge switch to determinate mode, if it's not already.
 
 \wxheading{Parameters}
 
@@ -203,3 +214,13 @@ Sets the position of the gauge.
 \helpref{wxGauge::GetValue}{wxgaugegetvalue}
 
 
+\membersection{wxGauge::Pulse}\label{wxgaugepulse}
+
+\func{void}{Pulse}{\void}
+
+Switch the gauge to indeterminate mode (if required) and makes the gauge move
+a bit to indicate the user that some progress has been made.
+
+Note that after calling this function the value returned by \helpref{GetValue}{wxgaugegetvalue}
+is undefined and thus you need to explicitely call \helpref{SetValue}{wxgaugesetvalue} if you
+want to restore the determinate mode.
diff --git a/docs/latex/wx/progdlg.tex b/docs/latex/wx/progdlg.tex
index ebe4bf768b..c63864efc5 100644
--- a/docs/latex/wx/progdlg.tex
+++ b/docs/latex/wx/progdlg.tex
@@ -12,7 +12,9 @@
 \section{\class{wxProgressDialog}}\label{wxprogressdialog}
 
 This class represents a dialog that shows a short message and a
-progress bar. Optionally, it can display an ABORT button.
+progress bar. Optionally, it can display ABORT and SKIP buttons,
+the elapsed, remaining and estimated time for the end of the progress.
+
 
 \wxheading{Derived from}
 
@@ -25,6 +27,30 @@ progress bar. Optionally, it can display an ABORT button.
 
 <wx/progdlg.h>
 
+
+\wxheading{Window styles}
+
+\twocolwidtha{7cm}
+\begin{twocollist}\itemsep=0pt
+\twocolitem{\windowstyle{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{\windowstyle{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{\windowstyle{wxPD\_SMOOTH}}{Causes smooth progress of the gauge control.}
+\twocolitem{\windowstyle{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{\windowstyle{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{\windowstyle{wxPD\_ELAPSED\_TIME}}{This flag tells the dialog that it should show elapsed time (since creating the dialog).}
+\twocolitem{\windowstyle{wxPD\_ESTIMATED\_TIME}}{This flag tells the dialog that it should show estimated time.}
+\twocolitem{\windowstyle{wxPD\_REMAINING\_TIME}}{This flag tells the dialog that it should show remaining time.}
+\end{twocollist}%
+
+
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 \membersection{wxProgressDialog::wxProgressDialog}\label{wxprogressdialogctor}
@@ -49,31 +75,7 @@ window only.
 
 \docparam{parent}{Parent window.}
 
-\docparam{style}{The dialog style. This is the combination of the following
-bitmask constants defined in wx/defs.h:
-
-\twocolwidtha{7cm}
-\begin{twocollist}\itemsep=0pt
-\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{{\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.}
-\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\_SMOOTH}}{This flag tells the dialog that it should use
-%smooth gauge (has effect only under 32bit Windows).}
-\end{twocollist}%
-}
+\docparam{style}{The dialog style. See \helpref{wxProgressDialog}{wxprogressdialog}.}
 
 \membersection{wxProgressDialog::\destruct{wxProgressDialog}}\label{wxprogressdialogdtor}
 
@@ -96,10 +98,10 @@ ABORT.
   \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
+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.
 
@@ -111,4 +113,16 @@ 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.}
+\helpref{Update}{wxprogressdialogupdate} call, this is set to true.}
+
+
+\membersection{wxProgressDialog::UpdatePulse}\label{wxprogressdialogupdatepulse}
+
+\func{virtual bool}{UpdatePulse}{
+  \param{const wxString\& }{newmsg = ""},\rtfsp
+  \param{bool *}{skip = NULL}}
+
+Just like \helpref{Update}{wxprogressdialogupdate} but makes
+the gauge control run in indeterminate mode (see \helpref{wxGauge}{wxgauge} documentation),
+sets the remaining and the estimated time labels (if present) to {\tt Unknown} and moves
+the progress bar a bit to indicate that some progress was done.
-- 
2.50.0

