X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/d993e05b2dca1092b98936c7f3b4917c41922d01..fc715b5088d317ad09cad84f0d9d375bfac055fd:/docs/latex/wx/log.tex diff --git a/docs/latex/wx/log.tex b/docs/latex/wx/log.tex index 41fd6f6700..7fb5832297 100644 --- a/docs/latex/wx/log.tex +++ b/docs/latex/wx/log.tex @@ -341,16 +341,24 @@ Returns whether the repetition counting mode is enabled. \membersection{wxLog::SetTimestamp}\label{wxlogsettimestamp} -\func{void}{SetTimestamp}{\param{const wxStrgin\&}{ format}} +\func{static void}{SetTimestamp}{\param{const wxString\&}{ format}} Sets the timestamp format prepended by the default log targets to all messages. The string may contain any normal characters as well as \% prefixed format specificators, see {\it strftime()} manual for details. -Passing a NULL value (not empty string) to this function disables message timestamping. +Passing an empty string to this function disables message time stamping. + +\membersection{wxLog::DisableTimestamp}\label{wxlogdisabletimestamp} + +\func{void}{SetTimestamp}{\param{const wxString\&}{ format}} + +Disables time stamping of the log messages. + +\newsince{2.9} \membersection{wxLog::GetTimestamp}\label{wxloggettimestamp} -\constfunc{const wxString\&}{GetTimestamp}{\void} +\func{static const wxString\&}{GetTimestamp}{\void} Returns the current timestamp format string. @@ -363,6 +371,8 @@ section for details. \membersection{wxLog::GetTraceMask}\label{wxloggettracemask} +\func{static wxTraceMask}{GetTraceMask}{\void} + Returns the current trace mask, see \helpref{Customization}{wxlogcustomization} section for details. @@ -434,6 +444,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} @@ -564,19 +581,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} @@ -587,9 +632,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 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% @@ -693,7 +738,7 @@ them normally by showing the standard log dialog. \wxheading{Derived from} -\helpref{wxLogPassThrough}{wxlogpassthrough} +\helpref{wxLogInterposer}{wxloginterposer} \wxheading{Include files}