X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/77d47192a89f7142f93c103760c8cbb824ec961d..81c882b613b5d99ddb1e5ab69fcd7ebccc287025:/docs/latex/wx/log.tex diff --git a/docs/latex/wx/log.tex b/docs/latex/wx/log.tex index 448c359565..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}\label{staticlogfunctions} +\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 @@ -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,7 @@ 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). To supress logging use a new +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. @@ -248,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 @@ -260,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, @@ -322,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}} @@ -351,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}. @@ -652,7 +669,7 @@ caller previously. \wxheading{See also} -\helpref{wxLogTextCtrl}{wxlogtextctrl},\\ +\helpref{wxTextCtrl}{wxtextctrl},\\ \helpref{wxStreamToTextRedirector}{wxstreamtotextredirector} \latexignore{\rtfignore{\wxheading{Members}}}