wxPython documentation updates

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

diff --git a/docs/latex/wx/log.tex b/docs/latex/wx/log.tex
index de29116f552bf972cdc8a392fa6b5c437f54d398..0e2604ace66b3a0d81e571a83a306656aeebbbd6 100644 (file)
--- a/docs/latex/wx/log.tex
+++ b/docs/latex/wx/log.tex
@@ -19,12 +19,16 @@ logging facilities.
 
 No base class
 
 
 No base class
 

+\wxheading{Include files}
+
+<wx/log.h>
+

 \latexignore{\rtfignore{\wxheading{Function groups}}}
 
 \membersection{Static functions}
 
 The functions in this section work with and manipulate the active log target.
 \latexignore{\rtfignore{\wxheading{Function groups}}}
 
 \membersection{Static functions}
 
 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
+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
 {\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


@@ -48,6 +52,7 @@ empty, {\it HasPendingMessages()} is also provided which allows to explicitly
 verify it.
 
 \helpref{Flush}{wxlogflush}\\
 verify it.
 
 \helpref{Flush}{wxlogflush}\\

+\helpref{FlushActive}{wxlogflushactive}\\

 \helpref{HasPendingMessages}{haspendingmessages}
 
 \membersection{Customization}\label{wxlogcustomization}
 \helpref{HasPendingMessages}{haspendingmessages}
 
 \membersection{Customization}\label{wxlogcustomization}


@@ -74,7 +79,7 @@ As for the (real) trace messages, they come in different kinds:
 
 The trace mask is a bit mask which tells which (if any) of these trace
 messages are going to be actually logged. For the trace message to appear
 
 The trace mask is a bit mask which tells which (if any) of these trace
 messages are going to be actually logged. For the trace message to appear

-somewhere, all the bits in the mask used in the call to {\it wxLogTrace()}
+somewhere, all the bits in the mask used in the call to {\it wxLogTrace()} 

 function must be set in the current trace mask. For example,
 \begin{verbatim}
 wxLogTrace(wxTraceRefCount | wxTraceOle, "Active object ref count: %d", nRef);
 function must be set in the current trace mask. For example,
 \begin{verbatim}
 wxLogTrace(wxTraceRefCount | wxTraceOle, "Active object ref count: %d", nRef);


@@ -92,8 +97,8 @@ format disables timestamping of the messages completely.
 
 \helpref{SetVerbose}{wxlogsetverbose}\\
 \helpref{GetVerbose}{wxloggetverbose}\\
 
 \helpref{SetVerbose}{wxlogsetverbose}\\
 \helpref{GetVerbose}{wxloggetverbose}\\

-\helpref{SetTimeStampFormat}{wxlogsettimestampformat}\\
-\helpref{GetTimeStampFormat}{wxloggettimestampformat}\\
+\helpref{SetTimestamp}{wxlogsettimestamp}\\
+\helpref{GetTimestamp}{wxloggettimestamp}\\

 \helpref{SetTraceMask}{wxlogsettracemask}\\
 \helpref{GetTraceMask}{wxloggettracemask}
 
 \helpref{SetTraceMask}{wxlogsettracemask}\\
 \helpref{GetTraceMask}{wxloggettracemask}
 


@@ -138,6 +143,16 @@ currently. (Almost) for internal use only.
 Shows all the messages currently in buffer and clears it. If the buffer
 is already empty, nothing happens.
 
 Shows all the messages currently in buffer and clears it. If the buffer
 is already empty, nothing happens.
 

+\membersection{wxLog::FlushActive}\label{wxlogflushactive}
+
+\func{static void}{FlushActive}{\void}
+
+Flushes the current log target if any, does nothing if there is none.
+
+See also:
+
+\helpref{Flush}{wxlogflush}
+

 \membersection{wxLog::HasPendingMessages}\label{haspendingmessages}
 
 \constfunc{bool}{HasPendingMessages}{\void}
 \membersection{wxLog::HasPendingMessages}\label{haspendingmessages}
 
 \constfunc{bool}{HasPendingMessages}{\void}


@@ -158,18 +173,18 @@ logged as the normal ones instead of being silently dropped.
 
 Returns whether the verbose mode is currently active.
 
 
 Returns whether the verbose mode is currently active.
 

-\membersection{wxLog::SetTimeStampFormat}\label{wxlogsettimestampformat}
+\membersection{wxLog::SetTimestamp}\label{wxlogsettimestamp}

 
 

-\func{void}{SetTimeStampFormat}{\param{const char * }{ format}}
+\func{void}{SetTimestamp}{\param{const char * }{ 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.
 
 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 an empty string to this function disables message timestamping.
+Passing a NULL value (not empty string) to this function disables message timestamping.

 
 

-\membersection{wxLog::GetTimeStampFormat}\label{wxloggettimestampformat}
+\membersection{wxLog::GetTimestamp}\label{wxloggettimestamp}

 
 

-\constfunc{const char *}{GetTimeStampFormat}{\void}
+\constfunc{const char *}{GetTimestamp}{\void}

 
 Returns the current timestamp format string.
 
 
 Returns the current timestamp format string.