added wxHtmlHelpController::AddBook(wxFileName)

[wxWidgets.git] / docs / latex / wx / log.tex

diff --git a/docs/latex/wx/log.tex b/docs/latex/wx/log.tex
index e0acaf998f8d7a15445dd30a510987ba1fdd56cf..aed457e94d26f248a2905eef240d5807da655235 100644 (file)
--- a/docs/latex/wx/log.tex
+++ b/docs/latex/wx/log.tex
@@ -136,7 +136,7 @@ documentation.
 
 Finally, the {\it wxLog::DoLog()} function automatically prepends a time stamp
 to all the messages. The format of the time stamp may be changed: it can be
-any string with \% specificators fully described in the documentation of the
+any string with \% specifications fully described in the documentation of the
 standard {\it strftime()} function. For example, the default format is
 "[\%d/\%b/\%y \%H:\%M:\%S] " which gives something like "[17/Sep/98 22:10:16] "
 (without quotes) for the current date. Setting an empty string as the time
@@ -151,6 +151,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{GetTraceMasks}{wxloggettracemasks}\\
 \helpref{IsAllowedTraceMask}{wxlogisallowedtracemask}\\
 \helpref{SetVerbose}{wxlogsetverbose}\\
 \helpref{GetVerbose}{wxloggetverbose}\\
@@ -173,7 +174,9 @@ window on the corresponding error message. If you wish to enable it, please use
 Add the {\it mask} to the list of allowed masks for 
 \helpref{wxLogTrace}{wxlogtrace}.
 
-See also: \helpref{RemoveTraceMask}{wxlogremovetracemask}
+\wxheading{See also}
+\helpref{RemoveTraceMask}{wxlogremovetracemask}
+\helpref{GetTraceMasks}{wxloggettracemasks}
 
 \membersection{wxLog::ClearTraceMasks}\label{wxlogcleartracemasks}
 
@@ -182,7 +185,17 @@ See also: \helpref{RemoveTraceMask}{wxlogremovetracemask}
 Removes all trace masks previously set with 
 \helpref{AddTraceMask}{wxlogaddtracemask}.
 
-See also: \helpref{RemoveTraceMask}{wxlogremovetracemask}
+\wxheading{See also}
+\helpref{RemoveTraceMask}{wxlogremovetracemask}
+
+\membersection{wxLog::GetTraceMasks}\label{wxloggettracemasks}
+
+\func{static const wxArrayString &}{GetTraceMasks}{\void}
+
+Returns the currently allowed list of string trace masks.
+
+\wxheading{See also}
+\helpref{AddTraceMask}{wxlogaddtracemask}.
 
 \membersection{wxLog::OnLog}\label{wxlogonlog}
 
@@ -292,7 +305,7 @@ user). (Almost) for internal use only.
 
 \func{static void}{SetVerbose}{\param{bool }{ verbose = TRUE}}
 
-Activates or desactivates verbose mode in which the verbose messages are
+Activates or deactivates verbose mode in which the verbose messages are
 logged as the normal ones instead of being silently dropped.
 
 \membersection{wxLog::GetVerbose}\label{wxloggetverbose}
@@ -367,7 +380,9 @@ wxLogChain *logChain = new wxLogChain(new wxLogStderr);
 // all the log messages are sent to stderr and also processed as usually
 ...
 
-delete logChain;
+// don't delete logChain directly as this would leave a dangling
+// pointer as active log target, use SetActiveTarget() instead
+delete wxLog::SetActiveTarget(...something else or NULL...);
 
 \end{verbatim}
 
@@ -524,6 +539,33 @@ Suspends logging.
 
 Resumes logging.
 
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% wxLogPassThrough %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+\section{\class{wxLogPassThrough}}\label{wxlogpassthrough}
+
+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
+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.
+
+\wxheading{Derived from}
+
+\helpref{wxLogChain}{wxlogchain}
+
+\wxheading{Include files}
+
+<wx/log.h>
+
+\latexignore{\rtfignore{\wxheading{Members}}}
+
+\membersection{wxLogPassThrough::wxLogPassThrough}\label{wxlogpassthroughctor}
+
+Default ctor installs this object as the current active log target.
+
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% wxLogStderr %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
 \section{\class{wxLogStderr}}\label{wxlogstderr}
@@ -699,30 +741,3 @@ prevent this from happening.
 Called right before the log frame is going to be deleted: will
 always be called unlike \helpref{OnFrameClose()}{wxlogwindowonframeclose}.
 
-%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% wxLogPassThrough %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-
-\section{\class{wxLogPassThrough}}\label{wxlogpassthrough}
-
-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
-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.
-
-\wxheading{Derived from}
-
-\helpref{wxLogChain}{wxlogchain}
-
-\wxheading{Include files}
-
-<wx/log.h>
-
-\latexignore{\rtfignore{\wxheading{Members}}}
-
-\membersection{wxLogPassThrough::wxLogPassThrough}\label{wxlogpassthroughctor}
-
-Default ctor installs this object as the current active log target.
-