X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/09914df7b85fe17845223b291ab65925dceba6f2..3f8e5072f7391db2158f44c6b9209bbb3db6eb06:/docs/latex/wx/tlog.tex?ds=sidebyside diff --git a/docs/latex/wx/tlog.tex b/docs/latex/wx/tlog.tex index 0cdc287607..f123323aa0 100644 --- a/docs/latex/wx/tlog.tex +++ b/docs/latex/wx/tlog.tex @@ -1,10 +1,7 @@ -\section{Log classes overview}\label{wxlogoverview} +\section{wxLog classes overview}\label{wxlogoverview} -Classes: \helpref{wxLog}{wxlog}\\ -\helpref{wxLogStderr}{wxlogstderr},\\ -\helpref{wxLogOstream}{wxlogostream}, \helpref{wxLogTextCtrl}{wxlogtextctrl},\\ -\helpref{wxLogWindow}{wxlogwindow}, \helpref{wxLogGui}{wxloggui},\\ -\helpref{wxLogNull}{wxlognull} +Classes: \helpref{wxLog}{wxlog}, wxLogStderr, +wxLogOstream, wxLogTextCtrl, wxLogWindow, wxLogGui, wxLogNull This is a general overview of logging classes provided by wxWindows. The word logging here has a broad sense, including all of the program output, not only @@ -47,6 +44,9 @@ first argument. \item{\bf wxLogDebug} is {\bf the} right function for debug output. It only does anything at all in the debug mode (when the preprocessor symbol \_\_WXDEBUG\_\_ is defined) and expands to nothing in release mode (otherwise). +{\bf Tip:} under Windows, you must either run the program under debugger or +use a 3rd party program such as \urlref{DbgView}{http://www.sysinternals.com} +to actually see the debug output. \item{\bf wxLogTrace} as {\bf wxLogDebug} only does something in debug build. The reason for making it a separate function from it is that usually there are a lot of trace messages, so it might make sense to separate them @@ -68,6 +68,26 @@ Although it works just fine under Unix, these messages go strictly nowhere under Windows where the stdout of GUI programs is not assigned to anything. Thus, you might view {\it wxLogMessage()} as a simple substitute for {\it printf()}. + +Moreover {\it wxMSW} doesn't have a {\bf console} as you may have with {\it + wxGTK}. Under {\it wxMSW}, a call using {\it cout} just goes nowhere. To +cope with this problem, {\it wxWindows} provides a way to redirect {\it cout} +calls to \helpref{wxTreeCtrl}{wxtreectrl}, {\it i.e.}: +{\small +\begin{verbatim} + wxLogWindow *logger=new wxLogWindow(your_frame,"Logger"); + cout=*new ostream(logger->GetTextCtrl()); + wxLog::SetActiveTarget(logger); +\end{verbatim} +} +On the opposite, if you like your {\it wxLogXXX} calls to behave as a {\it cout} +call does, just write : +{\small +\begin{verbatim} + wxLog *logger=new wxLogStream(&cout); + wxLog::SetActiveTarget(logger); +\end{verbatim} +} \item{\bf Flexibility} The output of wxLog functions can be redirected or suppressed entirely based on their importance, which is either impossible or difficult to do with traditional methods. For example, only error messages, or @@ -92,7 +112,7 @@ works. wxWindows has the notion of a {\it log target}: it's just a class deriving from \helpref{wxLog}{wxlog}. As such, it implements the virtual functions of the base class which are called when a message is logged. Only one log target -is {\it active} at any moment, this is the one used by \it{wxLogXXX()} +is {\it active} at any moment, this is the one used by {\it wxLogXXX()} functions. The normal usage of a log object (i.e. object of a class derived from wxLog) is to install it as the active target with a call to {\it SetActiveTarget()} and it will be used automatically by all subsequent calls