moved GetRed() in its correct place in alphabetical order

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

diff --git a/docs/latex/wx/log.tex b/docs/latex/wx/log.tex
index 1a883331827a664282740b1b42411384b1e59e8f..ce5acdf4dfbb0258da01af3d5f45405fb3931dc6 100644 (file)
--- a/docs/latex/wx/log.tex
+++ b/docs/latex/wx/log.tex
@@ -57,7 +57,7 @@ situations because it may easily lead to a loss of messages.
 \membersection{Logging functions}
 
 There are two functions which must be implemented by any derived class to
 \membersection{Logging functions}
 
 There are two functions which must be implemented by any derived class to

-actually process the log messages: \helpref{DoLog}{wxlogdolog} and 
+actually process the log messages: \helpref{DoLog}{wxlogdolog} and

 \helpref{DoLogString}{wxlogdologstring}. The second function receives a string
 which just has to be output in some way and the easiest way to write a new log
 target is to override just this function in the derived class. If more control
 \helpref{DoLogString}{wxlogdologstring}. The second function receives a string
 which just has to be output in some way and the easiest way to write a new log
 target is to override just this function in the derived class. If more control


@@ -72,15 +72,12 @@ night in the current time zone).
 There also functions to support message buffering. Why are they needed?
 Some of wxLog implementations, most notably the standard wxLogGui class,
 buffer the messages (for example, to avoid showing the user a zillion of modal
 There also functions to support message buffering. Why are they needed?
 Some of wxLog implementations, most notably the standard wxLogGui class,
 buffer the messages (for example, to avoid showing the user a zillion of modal

-message boxes one after another - which would be really annoying). 
+message boxes one after another -- which would be really annoying).

 \helpref{Flush()}{wxlogflush} shows them all and clears the buffer contents.
 \helpref{Flush()}{wxlogflush} shows them all and clears the buffer contents.

-Although this function doesn't do anything if the buffer is already empty,
-\helpref{HasPendingMessages()}{wxloghaspendingmessages} is also provided which
-allows to explicitly verify it.
+This function doesn't do anything if the buffer is already empty.

 
 \helpref{Flush}{wxlogflush}\\
 
 \helpref{Flush}{wxlogflush}\\

-\helpref{FlushActive}{wxlogflushactive}\\
-\helpref{HasPendingMessages}{wxloghaspendingmessages}
+\helpref{FlushActive}{wxlogflushactive}

 
 \membersection{Customization}\label{wxlogcustomization}
 
 
 \membersection{Customization}\label{wxlogcustomization}
 


@@ -96,9 +93,9 @@ 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:
 
 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 
-\helpref{GetTraceMask}{wxloggettracemask} and using 
-\helpref{wxLogTrace}{wxlogtrace} which takes an integer mask or by using 
+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.
 
 The difference between bit-wise and string trace masks is that a message using
 \helpref{AddTraceMask}{wxlogaddtracemask} for string trace masks.
 
 The difference between bit-wise and string trace masks is that a message using


@@ -112,7 +109,7 @@ For example,
 // wxTraceOleCalls is one of standard bit masks
 wxLogTrace(wxTraceRefCount | wxTraceOleCalls, "Active object ref count: %d", nRef);
 \end{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 
+will do something only if the current trace mask contains both

 {\tt wxTraceRefCount} and {\tt wxTraceOle}, but
 
 \begin{verbatim}
 {\tt wxTraceRefCount} and {\tt wxTraceOle}, but
 
 \begin{verbatim}


@@ -131,7 +128,7 @@ the preferred way of working with trace messages. The integer trace mask is
 kept for compatibility and for additional (but very rarely needed) flexibility
 only.
 
 kept for compatibility and for additional (but very rarely needed) flexibility
 only.
 

-The standard trace masks are given in \helpref{wxLogTrace}{wxlogtrace} 
+The standard trace masks are given in \helpref{wxLogTrace}{wxlogtrace}

 documentation.
 
 Finally, the {\it wxLog::DoLog()} function automatically prepends a time stamp
 documentation.
 
 Finally, the {\it wxLog::DoLog()} function automatically prepends a time stamp


@@ -145,7 +142,7 @@ format disables timestamping of the messages completely.
 {\bf NB:} Timestamping is disabled for Visual C++ users in debug builds by
 default because otherwise it would be impossible to directly go to the line
 from which the log message was generated by simply clicking in the debugger
 {\bf NB:} Timestamping is disabled for Visual C++ users in debug builds by
 default because otherwise it would be impossible to directly go to the line
 from which the log message was generated by simply clicking in the debugger

-window on the corresponding error message. If you wish to enable it, please use 
+window on the corresponding error message. If you wish to enable it, please use

 \helpref{SetTimestamp}{wxlogsettimestamp} explicitly.
 
 \helpref{AddTraceMask}{wxlogaddtracemask}\\
 \helpref{SetTimestamp}{wxlogsettimestamp} explicitly.
 
 \helpref{AddTraceMask}{wxlogaddtracemask}\\


@@ -171,7 +168,7 @@ window on the corresponding error message. If you wish to enable it, please use
 
 \func{static void}{AddTraceMask}{\param{const wxString\& }{mask}}
 
 
 \func{static void}{AddTraceMask}{\param{const wxString\& }{mask}}
 

-Add the {\it mask} to the list of allowed masks for 
+Add the {\it mask} to the list of allowed masks for

 \helpref{wxLogTrace}{wxlogtrace}.
 
 \wxheading{See also}
 \helpref{wxLogTrace}{wxlogtrace}.
 
 \wxheading{See also}


@@ -182,7 +179,7 @@ Add the {\it mask} to the list of allowed masks for
 
 \func{static void}{ClearTraceMasks}{\void}
 
 
 \func{static void}{ClearTraceMasks}{\void}
 

-Removes all trace masks previously set with 
+Removes all trace masks previously set with

 \helpref{AddTraceMask}{wxlogaddtracemask}.
 
 \wxheading{See also}
 \helpref{AddTraceMask}{wxlogaddtracemask}.
 
 \wxheading{See also}


@@ -240,7 +237,7 @@ flushed, so Suspend() works as expected with it).
 
 \func{static void}{Resume}{\void}
 
 
 \func{static void}{Resume}{\void}
 

-Resumes logging previously suspended by a call to 
+Resumes logging previously suspended by a call to

 \helpref{Suspend}{wxlogsuspend}. All messages logged in the meanwhile will be
 flushed soon.
 
 \helpref{Suspend}{wxlogsuspend}. All messages logged in the meanwhile will be
 flushed soon.
 


@@ -253,7 +250,7 @@ of the message as specified in the call of {\it wxLogXXX()} function which
 generated it and {\it timestamp} is the moment when the message was generated.
 
 The base class version prepends the timestamp to the message, adds a prefix
 generated it and {\it timestamp} is the moment when the message was generated.
 
 The base class version prepends the timestamp to the message, adds a prefix

-corresponding to the log level and then calls 
+corresponding to the log level and then calls

 \helpref{DoLogString}{wxlogdologstring} with the resulting string.
 
 \membersection{wxLog::DoLogString}\label{wxlogdologstring}
 \helpref{DoLogString}{wxlogdologstring} with the resulting string.
 
 \membersection{wxLog::DoLogString}\label{wxlogdologstring}


@@ -263,7 +260,7 @@ corresponding to the log level and then calls
 Called to log the specified string. The timestamp is already included into the
 string but still passed to this function.
 
 Called to log the specified string. The timestamp is already included into the
 string but still passed to this function.
 

-A simple implementation may just send the string to {\tt stdout} or, better, 
+A simple implementation may just send the string to {\tt stdout} or, better,

 {\tt stderr}.
 
 \membersection{wxLog::DontCreateOnDemand}\label{wxlogdontcreateondemand}
 {\tt stderr}.
 
 \membersection{wxLog::DontCreateOnDemand}\label{wxlogdontcreateondemand}


@@ -274,7 +271,7 @@ Instructs wxLog to not create new log targets on the fly if there is none
 currently. (Almost) for internal use only: it is supposed to be called by the
 application shutdown code.
 
 currently. (Almost) for internal use only: it is supposed to be called by the
 application shutdown code.
 

-Note that this function also calls 
+Note that this function also calls

 \helpref{ClearTraceMasks}{wxlogcleartracemasks}.
 
 \membersection{wxLog::Flush}\label{wxlogflush}
 \helpref{ClearTraceMasks}{wxlogcleartracemasks}.
 
 \membersection{wxLog::Flush}\label{wxlogflush}


@@ -294,16 +291,9 @@ See also:
 
 \helpref{Flush}{wxlogflush}
 
 
 \helpref{Flush}{wxlogflush}
 

-\membersection{wxLog::HasPendingMessages}\label{wxloghaspendingmessages}
-
-\constfunc{bool}{HasPendingMessages}{\void}
-
-Returns true if there are any messages in the buffer (not yet shown to the
-user). (Almost) for internal use only.
-

 \membersection{wxLog::SetVerbose}\label{wxlogsetverbose}
 
 \membersection{wxLog::SetVerbose}\label{wxlogsetverbose}
 

-\func{static void}{SetVerbose}{\param{bool }{ verbose = TRUE}}
+\func{static void}{SetVerbose}{\param{bool }{ verbose = true}}

 
 Activates or deactivates verbose mode in which the verbose messages are
 logged as the normal ones instead of being silently dropped.
 
 Activates or deactivates verbose mode in which the verbose messages are
 logged as the normal ones instead of being silently dropped.


@@ -314,6 +304,19 @@ 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::SetLogLevel}\label{wxlogsetloglevel}
+
+\func{static void}{SetLogLevel}{\param{wxLogLevel }{ logLevel}}
+
+Specifies that log messages with $level > logLevel$ should be ignored
+and not sent to the active log target.
+
+\membersection{wxLog::GetLogLevel}\label{wxloggetloglevel}
+
+\func{static wxLogLevel}{GetLogLevel}{\void}
+
+Returns the current log level limit.
+

 \membersection{wxLog::SetTimestamp}\label{wxlogsettimestamp}
 
 \func{void}{SetTimestamp}{\param{const char * }{ format}}
 \membersection{wxLog::SetTimestamp}\label{wxlogsettimestamp}
 
 \func{void}{SetTimestamp}{\param{const char * }{ format}}


@@ -345,17 +348,17 @@ for details.
 
 \func{static bool}{IsAllowedTraceMask}{\param{const wxChar *}{mask}}
 
 
 \func{static bool}{IsAllowedTraceMask}{\param{const wxChar *}{mask}}
 

-Returns TRUE if the {\it mask} is one of allowed masks for 
+Returns true if the {\it mask} is one of allowed masks for

 \helpref{wxLogTrace}{wxlogtrace}.
 
 \helpref{wxLogTrace}{wxlogtrace}.
 

-See also: \helpref{AddTraceMask}{wxlogaddtracemask}, 
+See also: \helpref{AddTraceMask}{wxlogaddtracemask},

 \helpref{RemoveTraceMask}{wxlogremovetracemask}
 
 \membersection{wxLog::RemoveTraceMask}\label{wxlogremovetracemask}
 
 \func{static void}{RemoveTraceMask}{\param{const wxString\& }{mask}}
 
 \helpref{RemoveTraceMask}{wxlogremovetracemask}
 
 \membersection{wxLog::RemoveTraceMask}\label{wxlogremovetracemask}
 
 \func{static void}{RemoveTraceMask}{\param{const wxString\& }{mask}}
 

-Remove the {\it mask} from the list of allowed masks for 
+Remove the {\it mask} from the list of allowed masks for

 \helpref{wxLogTrace}{wxlogtrace}.
 
 See also: \helpref{AddTraceMask}{wxlogaddtracemask}
 \helpref{wxLogTrace}{wxlogtrace}.
 
 See also: \helpref{AddTraceMask}{wxlogaddtracemask}


@@ -365,7 +368,7 @@ See also: \helpref{AddTraceMask}{wxlogaddtracemask}
 \section{\class{wxLogChain}}\label{wxlogchain}
 
 This simple class allows to chain log sinks, that is to install a new sink but
 \section{\class{wxLogChain}}\label{wxlogchain}
 
 This simple class allows to chain log sinks, that is to install a new sink but

-keep passing log messages to the old one instead of replacing it completely as 
+keep passing log messages to the old one instead of replacing it completely as

 \helpref{SetActiveTarget}{wxlogsetactivetarget} does.
 
 It is especially useful when you want to divert the logs somewhere (for
 \helpref{SetActiveTarget}{wxlogsetactivetarget} does.
 
 It is especially useful when you want to divert the logs somewhere (for


@@ -380,7 +383,9 @@ wxLogChain *logChain = new wxLogChain(new wxLogStderr);
 // all the log messages are sent to stderr and also processed as usually
 ...
 
 // 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}
 
 
 \end{verbatim}
 


@@ -418,8 +423,8 @@ NULL}).
 
 \constfunc{bool}{IsPassingMessages}{\void}
 
 
 \constfunc{bool}{IsPassingMessages}{\void}
 

-Returns {\tt TRUE} if the messages are passed to the previously active log
-target (default) or {\tt FALSE} if \helpref{PassMessages}{wxlogchainpassmessages} 
+Returns {\tt true} if the messages are passed to the previously active log
+target (default) or {\tt false} if \helpref{PassMessages}{wxlogchainpassmessages}

 had been called.
 
 \membersection{wxLogChain::PassMessages}\label{wxlogchainpassmessages}
 had been called.
 
 \membersection{wxLogChain::PassMessages}\label{wxlogchainpassmessages}


@@ -427,10 +432,10 @@ had been called.
 \func{void}{PassMessages}{\param{bool }{passMessages}}
 
 By default, the log messages are passed to the previously active log target.
 \func{void}{PassMessages}{\param{bool }{passMessages}}
 
 By default, the log messages are passed to the previously active log target.

-Calling this function with {\tt FALSE} parameter disables this behaviour
+Calling this function with {\tt false} parameter disables this behaviour

 (presumably temporarily, as you shouldn't use wxLogChain at all otherwise) and
 it can be reenabled by calling it again with {\it passMessages} set to {\tt
 (presumably temporarily, as you shouldn't use wxLogChain at all otherwise) and
 it can be reenabled by calling it again with {\it passMessages} set to {\tt

-TRUE}.
+true}.

 
 \membersection{wxLogChain::SetLog}\label{wxlogchainsetlog}
 
 
 \membersection{wxLogChain::SetLog}\label{wxlogchainsetlog}
 


@@ -547,7 +552,7 @@ 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,
 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} 
+this class must be derived from to implement \helpref{DoLog}{wxlogdolog}

 and/or \helpref{DoLogString}{wxlogdologstring} methods.
 
 \wxheading{Derived from}
 and/or \helpref{DoLogString}{wxlogdologstring} methods.
 
 \wxheading{Derived from}


@@ -590,7 +595,7 @@ wxWindows applications which send all the output to {\tt stderr}.
 
 \func{}{wxLogStderr}{\param{FILE }{*fp = NULL}}
 
 
 \func{}{wxLogStderr}{\param{FILE }{*fp = NULL}}
 

-Constructs a log target which sends all the log messages to the given 
+Constructs a log target which sends all the log messages to the given

 {\tt FILE}. If it is {\tt NULL}, the messages are sent to {\tt stderr}.
 
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% wxLogStream %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 {\tt FILE}. If it is {\tt NULL}, the messages are sent to {\tt stderr}.
 
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% wxLogStream %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%


@@ -621,7 +626,7 @@ the standard iostream library support ({\tt wxUSE\_STD\_IOSTREAM} must be on).
 
 \func{}{wxLogStream}{\param{std::ostream }{*ostr = NULL}}
 
 
 \func{}{wxLogStream}{\param{std::ostream }{*ostr = NULL}}
 

-Constructs a log target which sends all the log messages to the given 
+Constructs a log target which sends all the log messages to the given

 output stream. If it is {\tt NULL}, the messages are sent to {\tt cerr}.
 
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% wxLogTextCtrl %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 output stream. If it is {\tt NULL}, the messages are sent to {\tt cerr}.
 
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% wxLogTextCtrl %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%


@@ -680,7 +685,7 @@ them normally by showing the standard log dialog.
 
 \membersection{wxLogWindow::wxLogWindow}
 
 
 \membersection{wxLogWindow::wxLogWindow}
 

-\func{}{wxLogWindow}{\param{wxFrame }{*parent}, \param{const wxChar }{*title}, \param{bool }{show = {\tt TRUE}}, \param{bool }{passToOld = {\tt TRUE}}}
+\func{}{wxLogWindow}{\param{wxFrame }{*parent}, \param{const wxChar }{*title}, \param{bool }{show = {\tt true}}, \param{bool }{passToOld = {\tt true}}}

 
 Creates the log frame window and starts collecting the messages in it.
 
 
 Creates the log frame window and starts collecting the messages in it.
 


@@ -690,16 +695,16 @@ Creates the log frame window and starts collecting the messages in it.
 
 \docparam{title}{The title for the log frame}
 
 
 \docparam{title}{The title for the log frame}
 

-\docparam{show}{{\tt TRUE} to show the frame initially (default), otherwise 
+\docparam{show}{{\tt true} to show the frame initially (default), otherwise

 \helpref{wxLogWindow::Show}{wxlogwindowshow} must be called later.}
 
 \helpref{wxLogWindow::Show}{wxlogwindowshow} must be called later.}
 

-\docparam{passToOld}{{\tt TRUE} to process the log messages normally in addition to
-logging them in the log frame (default), {\tt FALSE} to only log them in the
+\docparam{passToOld}{{\tt true} to process the log messages normally in addition to
+logging them in the log frame (default), {\tt false} to only log them in the

 log frame.}
 
 \membersection{wxLogWindow::Show}\label{wxlogwindowshow}
 
 log frame.}
 
 \membersection{wxLogWindow::Show}\label{wxlogwindowshow}
 

-\func{void}{Show}{\param{bool }{show = {\tt TRUE}}}
+\func{void}{Show}{\param{bool }{show = {\tt true}}}

 
 Shows or hides the frame.
 
 
 Shows or hides the frame.
 


@@ -725,7 +730,7 @@ Called if the user closes the window interactively, will not be
 called if it is destroyed for another reason (such as when program
 exits).
 
 called if it is destroyed for another reason (such as when program
 exits).
 

-Return {\tt TRUE} from here to allow the frame to close, {\tt FALSE} to
+Return {\tt true} from here to allow the frame to close, {\tt false} to

 prevent this from happening.
 
 \wxheading{See also}
 prevent this from happening.
 
 \wxheading{See also}