X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/cc81d32f2bf8c159f3b1bf6ddaf62e6d77720209..6294ac2e91af3408cfa04910b90ad7ace94f1220:/docs/latex/wx/log.tex diff --git a/docs/latex/wx/log.tex b/docs/latex/wx/log.tex index ce5acdf4df..447d73d2f9 100644 --- a/docs/latex/wx/log.tex +++ b/docs/latex/wx/log.tex @@ -6,12 +6,12 @@ %% Created: some time ago %% RCS-ID: $Id$ %% Copyright: (c) 1997-2001 Vadim Zeitlin -%% License: wxWindows license +%% License: wxWidgets license %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% \section{\class{wxLog}}\label{wxlog} -wxLog class defines the interface for the {\it log targets} used by wxWindows +wxLog class defines the interface for the {\it log targets} used by wxWidgets logging functions as explained in the \helpref{wxLog overview}{wxlogoverview}. The only situations when you need to directly use this class is when you want to derive your own log target because the existing ones don't satisfy your @@ -23,7 +23,7 @@ completely) the timestamp on the messages. Otherwise, it is completely hidden behind the {\it wxLogXXX()} functions and you may not even know about its existence. -See \helpref{log overview}{wxlogoverview} for the descriptions of wxWindows +See \helpref{log overview}{wxlogoverview} for the descriptions of wxWidgets logging facilities. \wxheading{Derived from} @@ -172,6 +172,7 @@ Add the {\it mask} to the list of allowed masks for \helpref{wxLogTrace}{wxlogtrace}. \wxheading{See also} + \helpref{RemoveTraceMask}{wxlogremovetracemask} \helpref{GetTraceMasks}{wxloggettracemasks} @@ -183,15 +184,17 @@ Removes all trace masks previously set with \helpref{AddTraceMask}{wxlogaddtracemask}. \wxheading{See also} + \helpref{RemoveTraceMask}{wxlogremovetracemask} \membersection{wxLog::GetTraceMasks}\label{wxloggettracemasks} -\func{static const wxArrayString &}{GetTraceMasks}{\void} +\func{static const wxArrayString \&}{GetTraceMasks}{\void} Returns the currently allowed list of string trace masks. \wxheading{See also} + \helpref{AddTraceMask}{wxlogaddtracemask}. \membersection{wxLog::OnLog}\label{wxlogonlog} @@ -228,7 +231,7 @@ logging immediately without waiting for \helpref{Flush}{wxlogflush} to be called (the standard GUI log target only shows the log dialog when it is flushed, so Suspend() works as expected with it). -\wxheading{See also:} +\wxheading{See also} \helpref{Resume}{wxlogresume},\\ \helpref{wxLogNull}{wxlogoverview} @@ -287,7 +290,7 @@ is already empty, nothing happens. Flushes the current log target if any, does nothing if there is none. -See also: +\wxheading{See also} \helpref{Flush}{wxlogflush} @@ -453,9 +456,9 @@ object was created. \section{\class{wxLogGui}}\label{wxloggui} -This is the default log target for the GUI wxWindows applications. It is passed +This is the default log target for the GUI wxWidgets applications. It is passed to \helpref{wxLog::SetActiveTarget}{wxlogsetactivetarget} at the program -startup and is deleted by wxWindows during the program shut down. +startup and is deleted by wxWidgets during the program shut down. \wxheading{Derived from} @@ -480,7 +483,7 @@ Default constructor. This class allows to temporarily suspend logging. All calls to the log functions during the life time of an object of this class are just ignored. -In particular, it can be used to suppress the log messages given by wxWindows +In particular, it can be used to suppress the log messages given by wxWidgets itself but it should be noted that it is rarely the best way to cope with this problem as {\bf all} log messages are suppressed, even if they indicate a completely different error than the one the programmer wanted to suppress. @@ -500,7 +503,7 @@ For instance, the example of the overview: wxLogMessage("..."); // ok \end{verbatim} -} +}% would be better written as: @@ -520,7 +523,7 @@ would be better written as: ... } \end{verbatim} -} +}% \wxheading{Derived from} @@ -575,7 +578,7 @@ Default ctor installs this object as the current active log target. This class can be used to redirect the log messages to a C file stream (not to be confused with C++ streams). It is the default log target for the non-GUI -wxWindows applications which send all the output to {\tt stderr}. +wxWidgets applications which send all the output to {\tt stderr}. \wxheading{Derived from} @@ -604,7 +607,7 @@ Constructs a log target which sends all the log messages to the given This class can be used to redirect the log messages to a C++ stream. -Please note that this class is only available if wxWindows was compiled with +Please note that this class is only available if wxWidgets was compiled with the standard iostream library support ({\tt wxUSE\_STD\_IOSTREAM} must be on). \wxheading{Derived from} @@ -724,7 +727,7 @@ any extra initializations. \membersection{wxLogWindow::OnFrameClose}\label{wxlogwindowonframeclose} -\func{virtual void}{OnFrameClose}{\param{wxFrame }{*frame}} +\func{virtual bool}{OnFrameClose}{\param{wxFrame }{*frame}} Called if the user closes the window interactively, will not be called if it is destroyed for another reason (such as when program