X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/a0d43d79c250226513eca97d10bb67a38dbe1d66..19f6bff4484b97ef036a793820eb30c0a6df92b5:/docs/latex/wx/log.tex?ds=sidebyside diff --git a/docs/latex/wx/log.tex b/docs/latex/wx/log.tex index 2fd6de0d1a..ae311235b4 100644 --- a/docs/latex/wx/log.tex +++ b/docs/latex/wx/log.tex @@ -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. @@ -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,9 +324,24 @@ 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}} +\func{void}{SetTimestamp}{\param{const wxStrgin\&}{ format}} Sets the timestamp format prepended by the default log targets to all messages. The string may contain any normal characters as well as \% @@ -333,7 +350,7 @@ Passing a NULL value (not empty string) to this function disables message timest \membersection{wxLog::GetTimestamp}\label{wxloggettimestamp} -\constfunc{const char *}{GetTimestamp}{\void} +\constfunc{const wxString\&}{GetTimestamp}{\void} Returns the current timestamp format string. @@ -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}. @@ -417,6 +434,13 @@ target but the log messages are also passed to the previous log target if any. Destroys the previous log target. +\membersection{wxLogChain::DetachOldLog}\label{wxlogchaindetacholdlog} + +\func{void}{DetachOldLog}{\void} + +Detaches the old log target so it won't be destroyed when the wxLogChain object +is destroyed. + \membersection{wxLogChain::GetOldLog}\label{wxlogchaingetoldlog} \constfunc{wxLog *}{GetOldLog}{\void} @@ -547,19 +571,47 @@ Suspends logging. Resumes logging. -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% wxLogPassThrough %%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% wxLogInterposer %%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -\section{\class{wxLogPassThrough}}\label{wxlogpassthrough} +\section{\class{wxLogInterposer}}\label{wxloginterposer} A special version of \helpref{wxLogChain}{wxlogchain} which uses itself as the -new log target. Maybe more clearly, it means that this is a log target which -forwards the log messages to the previously installed one in addition to +new log target. It forwards log messages to the previously installed one in addition to processing them itself. Unlike \helpref{wxLogChain}{wxlogchain} which is usually used directly as is, this class must be derived from to implement \helpref{DoLog}{wxlogdolog} and/or \helpref{DoLogString}{wxlogdologstring} methods. +wxLogInterposer destroys the previous log target in its destructor. If you +don't want this to happen, use wxLogInterposerTemp instead. + +\wxheading{Derived from} + +\helpref{wxLogChain}{wxlogchain} + +\wxheading{Include files} + + + +\latexignore{\rtfignore{\wxheading{Members}}} + +\membersection{wxLogInterposer::wxLogInterposer}\label{wxloginterposerctor} + +The default constructor installs this object as the current active log target. + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% wxLogInterposerTemp %%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + +\section{\class{wxLogInterposerTemp}}\label{wxloginterposertemp} + +A special version of \helpref{wxLogChain}{wxlogchain} which uses itself as the +new log target. It forwards log messages to the previously installed one in addition to +processing them itself. Unlike \helpref{wxLogInterposer}{wxloginterposer}, it doesn't +delete the old target which means it can be used to temporarily redirect log output. + +As per wxLogInterposer, this class must be derived from to implement \helpref{DoLog}{wxlogdolog} +and/or \helpref{DoLogString}{wxlogdologstring} methods. + \wxheading{Derived from} \helpref{wxLogChain}{wxlogchain} @@ -570,9 +622,9 @@ and/or \helpref{DoLogString}{wxlogdologstring} methods. \latexignore{\rtfignore{\wxheading{Members}}} -\membersection{wxLogPassThrough::wxLogPassThrough}\label{wxlogpassthroughctor} +\membersection{wxLogInterposerTemp::wxLogInterposerTemp}\label{wxloginterposertempctor} -Default ctor installs this object as the current active log target. +The default constructor installs this object as the current active log target. %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% wxLogStderr %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% @@ -676,7 +728,7 @@ them normally by showing the standard log dialog. \wxheading{Derived from} -\helpref{wxLogPassThrough}{wxlogpassthrough} +\helpref{wxLogInterposer}{wxloginterposer} \wxheading{Include files}