updated wxTextFile docs; some typo corrections

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

diff --git a/docs/latex/wx/tlog.tex b/docs/latex/wx/tlog.tex
index 2213bd161d879c903d0201be5394a575e1bf092b..22c9b78ceb618ef1bb4d85537a5d5d7e07f48bfe 100644 (file)
--- a/docs/latex/wx/tlog.tex
+++ b/docs/latex/wx/tlog.tex
@@ -1,9 +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
 
 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


@@ -16,75 +14,86 @@ First of all, no knowledge of {\it wxLog} classes is needed to use them. For
 this, you should only know about {\it wxLogXXX()} functions. All of them have
 the same syntax as {\it printf()}, i.e. they take the format string as the
 first argument and a variable number of arguments. Here are all of them:
 this, you should only know about {\it wxLogXXX()} functions. All of them have
 the same syntax as {\it printf()}, i.e. they take the format string as the
 first argument and a variable number of arguments. Here are all of them:

+

 \begin{itemize}\itemsep=0pt
 \item{\bf wxLogFatalError} which is like {\it wxLogError}, but also
 terminates the program with the exit code 3 (using {\it abort()} standard
 function also terminates the program with this exit code).
 \begin{itemize}\itemsep=0pt
 \item{\bf wxLogFatalError} which is like {\it wxLogError}, but also
 terminates the program with the exit code 3 (using {\it abort()} standard
 function also terminates the program with this exit code).

-

 \item{\bf wxLogError} is the function to use for error messages, i.e. the
 messages that must be shown to the user. The default processing is to pop up a
 message box to inform the user about it.
 \item{\bf wxLogError} is the function to use for error messages, i.e. the
 messages that must be shown to the user. The default processing is to pop up a
 message box to inform the user about it.

-

 \item{\bf wxLogWarning} for warnings - they are also normally shown to the
 user, but don't interrupt the program work.
 \item{\bf wxLogWarning} for warnings - they are also normally shown to the
 user, but don't interrupt the program work.

-

 \item{\bf wxLogMessage} is for all normal, informational messages. They also
 appear in a message box by default (but it can be changed, see below). Notice
 that the standard behaviour is to not show informational messages if there are
 any errors later - the logic being that the later error messages make the
 informational messages preceding them meaningless.
 \item{\bf wxLogMessage} is for all normal, informational messages. They also
 appear in a message box by default (but it can be changed, see below). Notice
 that the standard behaviour is to not show informational messages if there are
 any errors later - the logic being that the later error messages make the
 informational messages preceding them meaningless.

-
-\item{\bf wxLogVerbose} is for verbose output. Normally, it's suppressed, but
+\item{\bf wxLogVerbose} is for verbose output. Normally, it is suppressed, but

 might be activated if the user wishes to know more details about the program
 progress (another, but possibly confusing name for the same function is {\bf
 might be activated if the user wishes to know more details about the program
 progress (another, but possibly confusing name for the same function is {\bf

-wxLogInfo}
-
+wxLogInfo}).

 \item{\bf wxLogStatus} is for status messages - they will go into the status
 \item{\bf wxLogStatus} is for status messages - they will go into the status

-bar of the active or specified (as the first argument)
-\helpref{wxFrame}{wxframe} if it has one.
-
+bar of the active or specified (as the first argument) \helpref{wxFrame}{wxframe} if it has one.

 \item{\bf wxLogSysError} is mostly used by wxWindows itself, but might be
 handy for logging errors after system call (API function) failure. It logs the
 \item{\bf wxLogSysError} is mostly used by wxWindows itself, but might be
 handy for logging errors after system call (API function) failure. It logs the

-specified message text as well as the last system error code ({\it errno} or
-{\it ::GetLastError()} depending on the platform) and the corresponding error
-message. The second form of this function takes the error code explitly as the
+specified message text as well as the last system error
+code ({\it errno} or {\it ::GetLastError()} depending on the platform) and the corresponding error
+message. The second form of this function takes the error code explicitly as the

 first argument.
 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).
 \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
 from other debug messages which would be flooded in them. Moreover, the second
 version of this function takes a trace mask as the first argument which allows
 to further restrict the amount of messages generated.
 \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
 from other debug messages which would be flooded in them. Moreover, the second
 version of this function takes a trace mask as the first argument which allows
 to further restrict the amount of messages generated.

-

 \end{itemize}
 
 \end{itemize}
 

-% VZ: Julian, am I pushing too much here?

 The usage of these functions should be fairly straightforward, however it may
 be asked why not use the other logging facilities, such as C standard stdio
 functions or C++ streams. The short answer is that they're all very good
 generic mechanisms, but are not really adapted for wxWindows, while the log
 classes are. Some of advantages in using wxWindows log functions are:
 The usage of these functions should be fairly straightforward, however it may
 be asked why not use the other logging facilities, such as C standard stdio
 functions or C++ streams. The short answer is that they're all very good
 generic mechanisms, but are not really adapted for wxWindows, while the log
 classes are. Some of advantages in using wxWindows log functions are:

-\begin{itemize}\itemsep=0pt

 
 

-\item{Portability} It's a common practice to use {\it printf()} statements or
+\begin{itemize}\itemsep=0pt
+\item{\bf Portability} It is a common practice to use {\it printf()} statements or

 cout/cerr C++ streams for writing out some (debug or otherwise) information.
 cout/cerr C++ streams for writing out some (debug or otherwise) information.

-Although it works just fine under Unix, these messages go strictly nowever
+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()}.
 
 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()}.
 

-\item{Flexibility} The output of wxLog functions can be redirected or
+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{wxTextCtrl}{wxtextctrl}, {\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
 only error messages and warnings might be logged, filtering out all
 informational messages.
 suppressed entirely based on their importance, which is either impossible or
 difficult to do with traditional methods. For example, only error messages, or
 only error messages and warnings might be logged, filtering out all
 informational messages.

-
-\item{Comlpeteness} Usually, an error message should be presented to the user
+\item{\bf Completeness} Usually, an error message should be presented to the user

 when some operation fails. Let's take a quite simple but common case of a file
 error: suppose that you're writing your data file on disk and there is not
 enough space. The actual error might have been detected inside wxWindows code
 when some operation fails. Let's take a quite simple but common case of a file
 error: suppose that you're writing your data file on disk and there is not
 enough space. The actual error might have been detected inside wxWindows code


@@ -94,17 +103,16 @@ written to the disk. However, as wxWindows uses {\it wxLogError()} in this
 situation, the exact error code (and the corresponding error message) will be
 given to the user together with "high level" message about data file writing
 error.
 situation, the exact error code (and the corresponding error message) will be
 given to the user together with "high level" message about data file writing
 error.

-

 \end{itemize}
 
 After having enumerated all the functions which are normally used to log the
 messages, and why would you want to use them we now describe how all this
 works.
 
 \end{itemize}
 
 After having enumerated all the functions which are normally used to log the
 messages, and why would you want to use them we now describe how all this
 works.
 

-wxWindows has the notion of a {\it log target}: it's just a class deriving
+wxWindows has the notion of a {\it log target}: it is 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
 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
 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


@@ -121,27 +129,26 @@ types yourself.
 There are some predefined classes deriving from wxLog and which might be
 helpful to see how you can create a new log target class and, of course, may
 also be used without any change. There are:
 There are some predefined classes deriving from wxLog and which might be
 helpful to see how you can create a new log target class and, of course, may
 also be used without any change. There are:

+

 \begin{itemize}\itemsep=0pt
 \item{\bf wxLogStderr} This class logs messages to a {\it FILE *}, using
 stderr by default as its name suggests.
 \begin{itemize}\itemsep=0pt
 \item{\bf wxLogStderr} This class logs messages to a {\it FILE *}, using
 stderr by default as its name suggests.

-

 \item{\bf wxLogStream} This class has the same functionality as wxLogStderr,
 but uses {\it ostream} and cerr instead of {\it FILE *} and stderr.
 \item{\bf wxLogStream} This class has the same functionality as wxLogStderr,
 but uses {\it ostream} and cerr instead of {\it FILE *} and stderr.

-

 \item{\bf wxLogGui} This is the standard log target for wxWindows
 \item{\bf wxLogGui} This is the standard log target for wxWindows

-applications (it's used by default if you don't do anything) and provides the
+applications (it is used by default if you don't do anything) and provides the

 most reasonable handling of all types of messages for given platform.
 most reasonable handling of all types of messages for given platform.

-

 \item{\bf wxLogWindow} This log target provides a "log console" which
 collects all messages generated by the application and also passes them to the
 previous active log target. The log window frame has a menu allowing user to
 clear the log, close it completely or save all messages to file.
 \item{\bf wxLogWindow} This log target provides a "log console" which
 collects all messages generated by the application and also passes them to the
 previous active log target. The log window frame has a menu allowing user to
 clear the log, close it completely or save all messages to file.

-

 \item{\bf wxLogNull} The last log class is quite particular: it doesn't do
 anything. The objects of this class may be instantiated to (temporarily)
 suppress output of {\it wxLogXXX()} functions. As an example, trying to open a
 \item{\bf wxLogNull} The last log class is quite particular: it doesn't do
 anything. The objects of this class may be instantiated to (temporarily)
 suppress output of {\it wxLogXXX()} functions. As an example, trying to open a

-non-existing file will usually provoke an error message, but if you for some
-reason it's unwanted, just use this construction:
+non-existing file will usually provoke an error message, but if for some
+reasons it is unwanted, just use this construction:
+
+{\small

 \begin{verbatim}
   wxFile file;
 
 \begin{verbatim}
   wxFile file;
 


@@ -154,5 +161,6 @@ reason it's unwanted, just use this construction:
   
   wxLogMessage("..."); // ok
 \end{verbatim}
   
   wxLogMessage("..."); // ok
 \end{verbatim}

-
+}

 \end{itemize}
 \end{itemize}

+