X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/5ac9433d0a888f2c5d160537285ea3bd3e57af24..81c882b613b5d99ddb1e5ab69fcd7ebccc287025:/docs/latex/wx/log.tex

diff --git a/docs/latex/wx/log.tex b/docs/latex/wx/log.tex
index 447d73d2f9..77e8803c11 100644
--- a/docs/latex/wx/log.tex
+++ b/docs/latex/wx/log.tex
@@ -6,7 +6,7 @@
 %% Created:     some time ago
 %% RCS-ID:      $Id$
 %% Copyright:   (c) 1997-2001 Vadim Zeitlin
-%% License:     wxWidgets license
+%% License:     wxWindows license
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
 \section{\class{wxLog}}\label{wxlog}
@@ -36,7 +36,7 @@ No base class
 
 \latexignore{\rtfignore{\wxheading{Function groups}}}
 
-\membersection{Static functions}
+\membersection{Global functions}
 
 The functions in this section work with and manipulate the active log target.
 The \helpref{OnLog()}{wxlogonlog} is called by the {\it wxLogXXX()} functions
@@ -54,7 +54,7 @@ situations because it may easily lead to a loss of messages.
 \helpref{Suspend}{wxlogsuspend}\\
 \helpref{Resume}{wxlogresume}
 
-\membersection{Logging functions}
+\membersection{Logging functions}\label{loggingfunctions}
 
 There are two functions which must be implemented by any derived class to
 actually process the log messages: \helpref{DoLog}{wxlogdolog} and
@@ -155,7 +155,9 @@ window on the corresponding error message. If you wish to enable it, please use
 \helpref{SetTimestamp}{wxlogsettimestamp}\\
 \helpref{GetTimestamp}{wxloggettimestamp}\\
 \helpref{SetTraceMask}{wxlogsettracemask}\\
-\helpref{GetTraceMask}{wxloggettracemask}
+\helpref{GetTraceMask}{wxloggettracemask}\\
+\helpref{SetRepetitionCounting}{wxlogsetrepetitioncounting}\\
+\helpref{GetRepetitionCounting}{wxloggetrepetitioncounting}
 
 %%%%% MEMBERS HERE %%%%%
 \helponly{\insertatlevel{2}{
@@ -199,7 +201,7 @@ Returns the currently allowed list of string trace masks.
 
 \membersection{wxLog::OnLog}\label{wxlogonlog}
 
-\func{static void}{OnLog}{\param{wxLogLevel }{ level}, \param{const char * }{ message}}
+\func{static void}{OnLog}{\param{wxLogLevel }{ level}, \param{const wxString\& }{ message}}
 
 Forwards the message at specified level to the {\it DoLog()} function of the
 active log target if there is any, does nothing otherwise.
@@ -215,7 +217,9 @@ Returns the pointer to the active log target (may be NULL).
 \func{static wxLog *}{SetActiveTarget}{\param{wxLog * }{ logtarget}}
 
 Sets the specified log target as the active one. Returns the pointer to the
-previous active log target (may be NULL).
+previous active log target (may be NULL).  To suppress logging use a new
+instance of wxLogNull not NULL.  If the active log target is set to NULL a
+new default log target will be created when logging occurs.
 
 \membersection{wxLog::Suspend}\label{wxlogsuspend}
 
@@ -246,7 +250,7 @@ flushed soon.
 
 \membersection{wxLog::DoLog}\label{wxlogdolog}
 
-\func{virtual void}{DoLog}{\param{wxLogLevel }{level}, \param{const wxChar }{*msg}, \param{time\_t }{timestamp}}
+\func{virtual void}{DoLog}{\param{wxLogLevel }{level}, \param{const wxString\& }{msg}, \param{time\_t }{timestamp}}
 
 Called to process the message of the specified severity. {\it msg} is the text
 of the message as specified in the call of {\it wxLogXXX()} function which
@@ -258,9 +262,9 @@ corresponding to the log level and then calls
 
 \membersection{wxLog::DoLogString}\label{wxlogdologstring}
 
-\func{virtual void}{DoLogString}{\param{const wxChar }{*msg}, \param{time\_t }{timestamp}}
+\func{virtual void}{DoLogString}{\param{const wxString\& }{msg}, \param{time\_t }{timestamp}}
 
-Called to log the specified string. The timestamp is already included into the
+Called to log the specified string. The timestamp is already included in the
 string but still passed to this function.
 
 A simple implementation may just send the string to {\tt stdout} or, better,
@@ -320,6 +324,21 @@ and not sent to the active log target.
 
 Returns the current log level limit.
 
+\membersection{wxLog::SetRepetitionCounting}\label{wxlogsetrepetitioncounting}
+
+\func{static void}{SetRepetitionCounting}{\param{bool }{ repetCounting = true}}
+
+Enables logging mode in which a log message is logged once, and in case exactly
+the same message successively repeats one or more times, only the number of 
+repetitions is logged.
+
+\membersection{wxLog::GetRepetitionCounting}\label{wxloggetrepetitioncounting}
+
+\func{static bool}{GetRepetitionCounting}{\void}
+
+Returns whether the repetition counting mode is enabled.
+
+
 \membersection{wxLog::SetTimestamp}\label{wxlogsettimestamp}
 
 \func{void}{SetTimestamp}{\param{const char * }{ format}}
@@ -349,7 +368,7 @@ for details.
 
 \membersection{wxLog::IsAllowedTraceMask}\label{wxlogisallowedtracemask}
 
-\func{static bool}{IsAllowedTraceMask}{\param{const wxChar *}{mask}}
+\func{static bool}{IsAllowedTraceMask}{\param{const wxString\& }{mask}}
 
 Returns true if the {\it mask} is one of allowed masks for
 \helpref{wxLogTrace}{wxlogtrace}.
@@ -402,14 +421,14 @@ delete wxLog::SetActiveTarget(...something else or NULL...);
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
-\membersection{wxLogChain::wxLogChain}\label{wxlogchainwxlogchain}
+\membersection{wxLogChain::wxLogChain}\label{wxlogchainctor}
 
 \func{}{wxLogChain}{\param{wxLog *}{logger}}
 
 Sets the specified {\tt logger} (which may be {\tt NULL}) as the default log
 target but the log messages are also passed to the previous log target if any.
 
-\membersection{wxLogChain::\destruct{wxLogChain}}
+\membersection{wxLogChain::\destruct{wxLogChain}}\label{wxlogchaindtor}
 
 \func{}{\destruct{wxLogChain}}{\void}
 
@@ -445,7 +464,7 @@ true}.
 \func{void}{SetLog}{\param{wxLog *}{logger}}
 
 Sets another log target to use (may be {\tt NULL}). The log target specified
-in the \helpref{constructor}{wxlogchainwxlogchain} or in a previous call to
+in the \helpref{constructor}{wxlogchainctor} or in a previous call to
 this function is deleted.
 
 This doesn't change the old log target value (the one the messages are
@@ -470,7 +489,7 @@ startup and is deleted by wxWidgets during the program shut down.
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
-\membersection{wxLogGui::wxLogGui}
+\membersection{wxLogGui::wxLogGui}\label{wxlogguictor}
 
 \func{}{wxLogGui}{\void}
 
@@ -535,13 +554,13 @@ would be better written as:
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
-\membersection{wxLogNull::wxLogNull}
+\membersection{wxLogNull::wxLogNull}\label{wxlognullctor}
 
 \func{}{wxLogNull}{\void}
 
 Suspends logging.
 
-\membersection{wxLogNull::\destruct{wxLogNull}}
+\membersection{wxLogNull::\destruct{wxLogNull}}\label{wxlognulldtor}
 
 Resumes logging.
 
@@ -594,7 +613,7 @@ wxWidgets applications which send all the output to {\tt stderr}.
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
-\membersection{wxLogStderr::wxLogStderr}
+\membersection{wxLogStderr::wxLogStderr}\label{wxlogstderrctor}
 
 \func{}{wxLogStderr}{\param{FILE }{*fp = NULL}}
 
@@ -625,7 +644,7 @@ the standard iostream library support ({\tt wxUSE\_STD\_IOSTREAM} must be on).
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
-\membersection{wxLogStream::wxLogStream}
+\membersection{wxLogStream::wxLogStream}\label{wxlogstreamctor}
 
 \func{}{wxLogStream}{\param{std::ostream }{*ostr = NULL}}
 
@@ -650,12 +669,12 @@ caller previously.
 
 \wxheading{See also}
 
-\helpref{wxLogTextCtrl}{wxlogtextctrl},\\
+\helpref{wxTextCtrl}{wxtextctrl},\\
 \helpref{wxStreamToTextRedirector}{wxstreamtotextredirector}
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
-\membersection{wxLogTextCtrl::wxLogTextCtrl}
+\membersection{wxLogTextCtrl::wxLogTextCtrl}\label{wxlogtextctrlctor}
 
 \func{}{wxLogTextCtrl}{\param{wxTextCtrl }{*textctrl}}
 
@@ -686,7 +705,7 @@ them normally by showing the standard log dialog.
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
-\membersection{wxLogWindow::wxLogWindow}
+\membersection{wxLogWindow::wxLogWindow}\label{wxlogwindowctor}
 
 \func{}{wxLogWindow}{\param{wxFrame }{*parent}, \param{const wxChar }{*title}, \param{bool }{show = {\tt true}}, \param{bool }{passToOld = {\tt true}}}
 
@@ -711,14 +730,14 @@ log frame.}
 
 Shows or hides the frame.
 
-\membersection{wxLogWindow::GetFrame}
+\membersection{wxLogWindow::GetFrame}\label{wxlogwindowgetframe}
 
 \constfunc{wxFrame *}{GetFrame}{\void}
 
 Returns the associated log frame window. This may be used to position or resize
 it but use \helpref{wxLogWindow::Show}{wxlogwindowshow} to show or hide it.
 
-\membersection{wxLogWindow::OnFrameCreate}
+\membersection{wxLogWindow::OnFrameCreate}\label{wxlogwindowonframecreate}
 
 \func{virtual void}{OnFrameCreate}{\param{wxFrame }{*frame}}