Fix to minimal sample project file; changed protected -> public in wxGIFDecoder

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

diff --git a/docs/latex/wx/log.tex b/docs/latex/wx/log.tex
index 03c4fa98bc1cc7e3bdb395782f24c8283c44aa33..5afc5969cf38fe8b816804cc169b74da1cb8328e 100644 (file)
--- 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.
@@ -39,7 +40,9 @@ of messages.
 \helpref{OnLog}{wxlogonlog}\\
 \helpref{GetActiveTarget}{wxloggetactivetarget}\\
 \helpref{SetActiveTarget}{wxlogsetactivetarget}\\
-\helpref{DontCreateOnDemand}{wxlogdontcreateondemand}
+\helpref{DontCreateOnDemand}{wxlogdontcreateondemand}\\
+\helpref{Suspend}{wxlogsuspend}\\
+\helpref{Resume}{wxlogresume}
 
 \membersection{Message buffering}
 
@@ -123,6 +126,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}\\
@@ -147,6 +151,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,12 +180,43 @@ Returns the pointer to the active log target (may be NULL).
 Sets the specified log target as the active one. Returns the pointer to the
 previous active log target (may be NULL).
 
+\membersection{wxLog::Suspend}\label{wxlogsuspend}
+
+\func{static void}{Suspend}{\void}
+
+Suspends the logging until \helpref{Resume}{wxlogresume} is called. Note that
+the latter must be called the same number of times as the former to undo it,
+i.e. if you call Suspend() twice you must call Resume() twice as well.
+
+Note that suspending the logging means that the log sink won't be be flushed
+periodically, it doesn't have any effect if the current log target does the
+logging immediately without waiting for \helpref{Flush}{wxlogflush} to be
+called (the standard GUI log target only shows the log dialog when it is
+flushed, so Suspend() works as expected with it).
+
+\wxheading{See also:}
+
+\helpref{Resume}{wxlogresume},\\
+\helpref{wxLogNull}{wxlogoverview}
+
+\membersection{wxLog::Resume}\label{wxlogresume}
+
+\func{static void}{Resume}{\void}
+
+Resumes logging previously suspended by a call to 
+\helpref{Suspend}{wxlogsuspend}. All messages logged in the meanwhile will be
+flushed soon.
+
 \membersection{wxLog::DontCreateOnDemand}\label{wxlogdontcreateondemand}
 
 \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}