Added wxRect::Intersect() documentation (patch 1868322 from Laurent Humbertclaude).

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

diff --git a/docs/latex/wx/log.tex b/docs/latex/wx/log.tex
index 026dc1eadd913db056f63ca1e9a038bb54405cf2..7a606ef27c9820d208ad01ee17afef2c9c3629ae 100644 (file)
--- a/docs/latex/wx/log.tex
+++ b/docs/latex/wx/log.tex
@@ -34,6 +34,10 @@ No base class
 
 <wx/log.h>
 
 
 <wx/log.h>
 

+\wxheading{Library}
+
+\helpref{wxCore}{librarieslist}
+

 \latexignore{\rtfignore{\wxheading{Function groups}}}
 
 \membersection{Global functions}
 \latexignore{\rtfignore{\wxheading{Function groups}}}
 
 \membersection{Global functions}


@@ -201,7 +205,7 @@ Returns the currently allowed list of string trace masks.
 
 \membersection{wxLog::OnLog}\label{wxlogonlog}
 
 
 \membersection{wxLog::OnLog}\label{wxlogonlog}
 

-\func{static void}{OnLog}{\param{wxLogLevel }{ level}, \param{const char * }{ message}}
+\func{static void}{OnLog}{\param{wxLogLevel }{ level}, \param{const wxString\& }{ message}}

 
 Forwards the message at specified level to the {\it DoLog()} function of the
 active log target if there is any, does nothing otherwise.
 
 Forwards the message at specified level to the {\it DoLog()} function of the
 active log target if there is any, does nothing otherwise.


@@ -250,7 +254,7 @@ flushed soon.
 
 \membersection{wxLog::DoLog}\label{wxlogdolog}
 
 
 \membersection{wxLog::DoLog}\label{wxlogdolog}
 

-\func{virtual void}{DoLog}{\param{wxLogLevel }{level}, \param{const wxChar }{*msg}, \param{time\_t }{timestamp}}
+\func{virtual void}{DoLog}{\param{wxLogLevel }{level}, \param{const wxString\& }{msg}, \param{time\_t }{timestamp}}

 
 Called to process the message of the specified severity. {\it msg} is the text
 of the message as specified in the call of {\it wxLogXXX()} function which
 
 Called to process the message of the specified severity. {\it msg} is the text
 of the message as specified in the call of {\it wxLogXXX()} function which


@@ -262,7 +266,7 @@ corresponding to the log level and then calls
 
 \membersection{wxLog::DoLogString}\label{wxlogdologstring}
 
 
 \membersection{wxLog::DoLogString}\label{wxlogdologstring}
 

-\func{virtual void}{DoLogString}{\param{const wxChar }{*msg}, \param{time\_t }{timestamp}}
+\func{virtual void}{DoLogString}{\param{const wxString\& }{msg}, \param{time\_t }{timestamp}}

 
 Called to log the specified string. The timestamp is already included in the
 string but still passed to this function.
 
 Called to log the specified string. The timestamp is already included in the
 string but still passed to this function.


@@ -341,16 +345,24 @@ Returns whether the repetition counting mode is enabled.
 
 \membersection{wxLog::SetTimestamp}\label{wxlogsettimestamp}
 
 
 \membersection{wxLog::SetTimestamp}\label{wxlogsettimestamp}
 

-\func{void}{SetTimestamp}{\param{const char * }{ 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.
 
 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}
 
 
 \membersection{wxLog::GetTimestamp}\label{wxloggettimestamp}
 

-\constfunc{const char *}{GetTimestamp}{\void}
+\func{static const wxString\&}{GetTimestamp}{\void}

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


@@ -363,12 +375,14 @@ section for details.
 
 \membersection{wxLog::GetTraceMask}\label{wxloggettracemask}
 
 
 \membersection{wxLog::GetTraceMask}\label{wxloggettracemask}
 

+\func{static wxTraceMask}{GetTraceMask}{\void}
+

 Returns the current trace mask, see \helpref{Customization}{wxlogcustomization} section
 for details.
 
 \membersection{wxLog::IsAllowedTraceMask}\label{wxlogisallowedtracemask}
 
 Returns the current trace mask, see \helpref{Customization}{wxlogcustomization} section
 for details.
 
 \membersection{wxLog::IsAllowedTraceMask}\label{wxlogisallowedtracemask}
 

-\func{static bool}{IsAllowedTraceMask}{\param{const wxChar *}{mask}}
+\func{static bool}{IsAllowedTraceMask}{\param{const wxString\& }{mask}}

 
 Returns true if the {\it mask} is one of allowed masks for
 \helpref{wxLogTrace}{wxlogtrace}.
 
 Returns true if the {\it mask} is one of allowed masks for
 \helpref{wxLogTrace}{wxlogtrace}.


@@ -419,6 +433,10 @@ delete wxLog::SetActiveTarget(...something else or NULL...);
 
 <wx/log.h>
 
 
 <wx/log.h>
 

+\wxheading{Library}
+
+\helpref{wxBase}{librarieslist}
+

 \latexignore{\rtfignore{\wxheading{Members}}}
 
 \membersection{wxLogChain::wxLogChain}\label{wxlogchainctor}
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 \membersection{wxLogChain::wxLogChain}\label{wxlogchainctor}


@@ -434,6 +452,13 @@ target but the log messages are also passed to the previous log target if any.
 
 Destroys the previous log target.
 
 
 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}
 \membersection{wxLogChain::GetOldLog}\label{wxlogchaingetoldlog}
 
 \constfunc{wxLog *}{GetOldLog}{\void}


@@ -552,6 +577,10 @@ would be better written as:
 
 <wx/log.h>
 
 
 <wx/log.h>
 

+\wxheading{Library}
+
+\helpref{wxBase}{librarieslist}
+

 \latexignore{\rtfignore{\wxheading{Members}}}
 
 \membersection{wxLogNull::wxLogNull}\label{wxlognullctor}
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 \membersection{wxLogNull::wxLogNull}\label{wxlognullctor}


@@ -564,32 +593,70 @@ Suspends logging.
 
 Resumes 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
 
 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.
 
 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}
 
 \wxheading{Derived from}
 

-\helpref{wxLogChain}{wxlogchain}
+\helpref{wxLogChain}{wxlogchain}\\
+\helpref{wxLog}{wxlog}

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

+\wxheading{Library}
+
+\helpref{wxBase}{librarieslist}
+

 \latexignore{\rtfignore{\wxheading{Members}}}
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 

-\membersection{wxLogPassThrough::wxLogPassThrough}\label{wxlogpassthroughctor}
+\membersection{wxLogInterposer::wxLogInterposer}\label{wxloginterposerctor}
+
+The default constructor installs this object as the current active log target.
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% wxLogInterposerTemp %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

 
 

-Default ctor installs this object as the current active log target.
+\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}\\
+\helpref{wxLog}{wxlog}
+
+\wxheading{Include files}
+
+<wx/log.h>
+
+\wxheading{Library}
+
+\helpref{wxBase}{librarieslist}
+
+\latexignore{\rtfignore{\wxheading{Members}}}
+
+\membersection{wxLogInterposerTemp::wxLogInterposerTemp}\label{wxloginterposertempctor}
+
+The default constructor installs this object as the current active log target.

 
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% wxLogStderr %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
 
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% wxLogStderr %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 


@@ -607,6 +674,10 @@ wxWidgets applications which send all the output to {\tt stderr}.
 
 <wx/log.h>
 
 
 <wx/log.h>
 

+\wxheading{Library}
+
+\helpref{wxBase}{librarieslist}
+

 \wxheading{See also}
 
 \helpref{wxLogStream}{wxlogstream}
 \wxheading{See also}
 
 \helpref{wxLogStream}{wxlogstream}


@@ -637,6 +708,10 @@ the standard iostream library support ({\tt wxUSE\_STD\_IOSTREAM} must be on).
 
 <wx/log.h>
 
 
 <wx/log.h>
 

+\wxheading{Library}
+
+\helpref{wxBase}{librarieslist}
+

 \wxheading{See also}
 
 \helpref{wxLogStderr}{wxlogstderr},\\
 \wxheading{See also}
 
 \helpref{wxLogStderr}{wxlogstderr},\\


@@ -693,7 +768,9 @@ them normally by showing the standard log dialog.
 
 \wxheading{Derived from}
 
 
 \wxheading{Derived from}
 

-\helpref{wxLogPassThrough}{wxlogpassthrough}
+\helpref{wxLogInterposer}{wxloginterposer}\\
+\helpref{wxLogChain}{wxlogchain}\\
+\helpref{wxLog}{wxlog}

 
 \wxheading{Include files}
 
 
 \wxheading{Include files}