Name change replacements
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@27090 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
@@ -11,9 +11,9 @@ Classes: \helpref{wxLog}{wxlog},\\
|
||||
\helpref{wxLogPassThrough}{wxlogpassthrough},\\
|
||||
\helpref{wxStreamToTextRedirector}{wxstreamtotextredirector}
|
||||
|
||||
This is a general overview of logging classes provided by wxWindows. The word
|
||||
This is a general overview of logging classes provided by wxWidgets. The word
|
||||
logging here has a broad sense, including all of the program output, not only
|
||||
non interactive messages. The logging facilities included in wxWindows provide
|
||||
non interactive messages. The logging facilities included in wxWidgets provide
|
||||
the base {\it wxLog} class which defines the standard interface for a {\it log
|
||||
target} as well as several standard implementations of it and a family of
|
||||
functions to use with them.
|
||||
@@ -45,7 +45,7 @@ progress (another, but possibly confusing name for the same function is {\bf
|
||||
wxLogInfo}).
|
||||
\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.
|
||||
\item{\bf wxLogSysError} is mostly used by wxWindows itself, but might be
|
||||
\item{\bf wxLogSysError} is mostly used by wxWidgets 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
|
||||
@@ -68,8 +68,8 @@ to further restrict the amount of messages generated.
|
||||
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:
|
||||
generic mechanisms, but are not really adapted for wxWidgets, while the log
|
||||
classes are. Some of advantages in using wxWidgets log functions are:
|
||||
|
||||
\begin{itemize}\itemsep=0pt
|
||||
\item{\bf Portability} It is a common practice to use {\it printf()}
|
||||
@@ -99,10 +99,10 @@ informational messages.
|
||||
\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
|
||||
enough space. The actual error might have been detected inside wxWidgets code
|
||||
(say, in {\it wxFile::Write}), so the calling function doesn't really know the
|
||||
exact reason of the failure, it only knows that the data file couldn't be
|
||||
written to the disk. However, as wxWindows uses {\it wxLogError()} in this
|
||||
written to the disk. However, as wxWidgets 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.
|
||||
@@ -112,7 +112,7 @@ 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 is just a class deriving
|
||||
wxWidgets 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
|
||||
is {\it active} at any moment, this is the one used by {\it wxLogXXX()}
|
||||
@@ -138,7 +138,7 @@ also be used without any change. There are:
|
||||
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 wxLogGui} This is the standard log target for wxWindows
|
||||
\item{\bf wxLogGui} This is the standard log target for wxWidgets
|
||||
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.
|
||||
\item{\bf wxLogWindow} This log target provides a "log console" which
|
||||
|
Reference in New Issue
Block a user