X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/ac7f0167aaced8162b8f40725102b5900681ce23..bf7945cef10c0844a32e95695c544d829da9293a:/docs/latex/wx/log.tex

diff --git a/docs/latex/wx/log.tex b/docs/latex/wx/log.tex
index 3c8d763200..7de410ebbd 100644
--- a/docs/latex/wx/log.tex
+++ b/docs/latex/wx/log.tex
@@ -30,8 +30,9 @@ No base class
 The functions in this section work with and manipulate the active log target.
 The {\it OnLog()} is called by the {\it wxLogXXX()} functions and invokes the 
 {\it DoLog()} of the active log target if any. Get/Set methods are used to
-install/query the current active target and, finally, {\it
-DontCreateOnDemand()} disables the automatic creation of a standard log target
+install/query the current active target and, finally, 
+\helpref{DontCreateOnDemand()}{wxlogdontcreateondemand} 
+disables the automatic creation of a standard log target
 if none actually exists. It is only useful when the application is terminating
 and shouldn't be used in other situations because it may easily lead to a loss
 of messages.
@@ -62,13 +63,14 @@ without writing a new log target class (which, aside of being a matter of
 several minutes, allows you to do anything you want).
 
 The verbose messages are the trace messages which are not disabled in the
-release mode and are generated by \helpref{wxLogVerbose}{wxlogverbose}. They are not normally
-shown to the user because they present little interest, but may be activated,
-for example, in order to help the user find some program problem.
+release mode and are generated by \helpref{wxLogVerbose}{wxlogverbose}. They
+are not normally shown to the user because they present little interest, but
+may be activated, for example, in order to help the user find some program
+problem.
 
 As for the (real) trace messages, their handling depends on the settings of
 the (application global) {\it trace mask}. There are two ways to specify it:
-either by using helpref{SetTraceMask}{wxlogsettracemask} and 
+either by using \helpref{SetTraceMask}{wxlogsettracemask} and 
 \helpref{GetTraceMask}{wxloggettracemask} and using 
 \helpref{wxLogTrace}{wxlogtrace} which takes an integer mask or by using 
 \helpref{AddTraceMask}{wxlogaddtracemask} for string trace masks.
@@ -79,17 +81,21 @@ current mask while a message using string mask will be logged simply if the
 mask had been added before to the list of allowed ones.
 
 For example,
+
 \begin{verbatim}
 // wxTraceOleCalls is one of standard bit masks
 wxLogTrace(wxTraceRefCount | wxTraceOleCalls, "Active object ref count: %d", nRef);
 \end{verbatim}
 will do something only if the current trace mask contains both 
 {\tt wxTraceRefCount} and {\tt wxTraceOle}, but
+
 \begin{verbatim}
 // wxTRACE_OleCalls is one of standard string masks
-wxLogTrace(wxTACE_OleCalls, "IFoo::Bar() called");
+wxLogTrace(wxTRACE_OleCalls, "IFoo::Bar() called");
 \end{verbatim}
+
 will log the message if it was preceded by
+
 \begin{verbatim}
 wxLog::AddTraceMask(wxTRACE_OleCalls);
 \end{verbatim}
@@ -118,6 +124,7 @@ window on the corresponding error message. If you wish to enable it, please use
 
 \helpref{AddTraceMask}{wxlogaddtracemask}\\
 \helpref{RemoveTraceMask}{wxlogremovetracemask}\\
+\helpref{ClearTraceMasks}{wxlogcleartracemasks}\\
 \helpref{IsAllowedTraceMask}{wxlogisallowedtracemask}\\
 \helpref{SetVerbose}{wxlogsetverbose}\\
 \helpref{GetVerbose}{wxloggetverbose}\\
@@ -142,6 +149,15 @@ Add the {\it mask} to the list of allowed masks for
 
 See also: \helpref{RemoveTraceMask}{wxlogremovetracemask}
 
+\membersection{wxLog::ClearTraceMasks}\label{wxlogcleartracemasks}
+
+\func{static void}{ClearTraceMasks}{\void}
+
+Removes all trace masks previously set with 
+\helpref{AddTraceMask}{wxlogaddtracemask}.
+
+See also: \helpref{RemoveTraceMask}{wxlogremovetracemask}
+
 \membersection{wxLog::OnLog}\label{wxlogonlog}
 
 \func{static void}{OnLog}{\param{wxLogLevel }{ level}, \param{const char * }{ message}}
@@ -167,7 +183,11 @@ previous active log target (may be NULL).
 \func{static void}{DontCreateOnDemand}{\void}
 
 Instructs wxLog to not create new log targets on the fly if there is none
-currently. (Almost) for internal use only.
+currently. (Almost) for internal use only: it is supposed to be called by the
+application shutdown code.
+
+Note that this function also calls 
+\helpref{ClearTraceMasks}{wxlogcleartracemasks}.
 
 \membersection{wxLog::Flush}\label{wxlogflush}
 
