X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/1ec5cbf3de62355577408ced5017c1844c71edaf..0d2b62c57b32dce7e47d2810c85c524a22bd1796:/docs/latex/wx/log.tex diff --git a/docs/latex/wx/log.tex b/docs/latex/wx/log.tex index fa31caabb9..df109182d8 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} @@ -36,7 +36,7 @@ No base class \latexignore{\rtfignore{\wxheading{Function groups}}} -\membersection{Static functions} +\membersection{Static functions}\label{staticlogfunctions} The functions in this section work with and manipulate the active log target. The \helpref{OnLog()}{wxlogonlog} is called by the {\it wxLogXXX()} functions @@ -54,7 +54,7 @@ situations because it may easily lead to a loss of messages. \helpref{Suspend}{wxlogsuspend}\\ \helpref{Resume}{wxlogresume} -\membersection{Logging functions} +\membersection{Logging functions}\label{loggingfunctions} There are two functions which must be implemented by any derived class to actually process the log messages: \helpref{DoLog}{wxlogdolog} and @@ -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,13 +290,13 @@ 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} \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. @@ -348,7 +351,7 @@ for details. \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}. See also: \helpref{AddTraceMask}{wxlogaddtracemask}, @@ -399,14 +402,14 @@ delete wxLog::SetActiveTarget(...something else or NULL...); \latexignore{\rtfignore{\wxheading{Members}}} -\membersection{wxLogChain::wxLogChain}\label{wxlogchainwxlogchain} +\membersection{wxLogChain::wxLogChain}\label{wxlogchainctor} \func{}{wxLogChain}{\param{wxLog *}{logger}} Sets the specified {\tt logger} (which may be {\tt NULL}) as the default log target but the log messages are also passed to the previous log target if any. -\membersection{wxLogChain::\destruct{wxLogChain}} +\membersection{wxLogChain::\destruct{wxLogChain}}\label{wxlogchaindtor} \func{}{\destruct{wxLogChain}}{\void} @@ -423,8 +426,8 @@ NULL}). \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} @@ -432,17 +435,17 @@ had been called. \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 -TRUE}. +true}. \membersection{wxLogChain::SetLog}\label{wxlogchainsetlog} \func{void}{SetLog}{\param{wxLog *}{logger}} Sets another log target to use (may be {\tt NULL}). The log target specified -in the \helpref{constructor}{wxlogchainwxlogchain} or in a previous call to +in the \helpref{constructor}{wxlogchainctor} or in a previous call to this function is deleted. This doesn't change the old log target value (the one the messages are @@ -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} @@ -467,7 +470,7 @@ startup and is deleted by wxWindows during the program shut down. \latexignore{\rtfignore{\wxheading{Members}}} -\membersection{wxLogGui::wxLogGui} +\membersection{wxLogGui::wxLogGui}\label{wxlogguictor} \func{}{wxLogGui}{\void} @@ -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} @@ -532,13 +535,13 @@ would be better written as: \latexignore{\rtfignore{\wxheading{Members}}} -\membersection{wxLogNull::wxLogNull} +\membersection{wxLogNull::wxLogNull}\label{wxlognullctor} \func{}{wxLogNull}{\void} Suspends logging. -\membersection{wxLogNull::\destruct{wxLogNull}} +\membersection{wxLogNull::\destruct{wxLogNull}}\label{wxlognulldtor} Resumes logging. @@ -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} @@ -591,7 +594,7 @@ wxWindows applications which send all the output to {\tt stderr}. \latexignore{\rtfignore{\wxheading{Members}}} -\membersection{wxLogStderr::wxLogStderr} +\membersection{wxLogStderr::wxLogStderr}\label{wxlogstderrctor} \func{}{wxLogStderr}{\param{FILE }{*fp = NULL}} @@ -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} @@ -622,7 +625,7 @@ the standard iostream library support ({\tt wxUSE\_STD\_IOSTREAM} must be on). \latexignore{\rtfignore{\wxheading{Members}}} -\membersection{wxLogStream::wxLogStream} +\membersection{wxLogStream::wxLogStream}\label{wxlogstreamctor} \func{}{wxLogStream}{\param{std::ostream }{*ostr = NULL}} @@ -652,7 +655,7 @@ caller previously. \latexignore{\rtfignore{\wxheading{Members}}} -\membersection{wxLogTextCtrl::wxLogTextCtrl} +\membersection{wxLogTextCtrl::wxLogTextCtrl}\label{wxlogtextctrlctor} \func{}{wxLogTextCtrl}{\param{wxTextCtrl }{*textctrl}} @@ -683,9 +686,9 @@ them normally by showing the standard log dialog. \latexignore{\rtfignore{\wxheading{Members}}} -\membersection{wxLogWindow::wxLogWindow} +\membersection{wxLogWindow::wxLogWindow}\label{wxlogwindowctor} -\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. @@ -695,27 +698,27 @@ Creates the log frame window and starts collecting the messages in it. \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.} -\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} -\func{void}{Show}{\param{bool }{show = {\tt TRUE}}} +\func{void}{Show}{\param{bool }{show = {\tt true}}} Shows or hides the frame. -\membersection{wxLogWindow::GetFrame} +\membersection{wxLogWindow::GetFrame}\label{wxlogwindowgetframe} \constfunc{wxFrame *}{GetFrame}{\void} Returns the associated log frame window. This may be used to position or resize it but use \helpref{wxLogWindow::Show}{wxlogwindowshow} to show or hide it. -\membersection{wxLogWindow::OnFrameCreate} +\membersection{wxLogWindow::OnFrameCreate}\label{wxlogwindowonframecreate} \func{virtual void}{OnFrameCreate}{\param{wxFrame }{*frame}} @@ -724,13 +727,13 @@ 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 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}