X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/1ec5cbf3de62355577408ced5017c1844c71edaf..ec59d2ccea39b0225f49e6dd326d4d11940d656d:/docs/latex/wx/log.tex diff --git a/docs/latex/wx/log.tex b/docs/latex/wx/log.tex index fa31caabb9..20e9515b77 100644 --- a/docs/latex/wx/log.tex +++ b/docs/latex/wx/log.tex @@ -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}, @@ -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,10 +435,10 @@ 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} @@ -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} @@ -685,7 +688,7 @@ them normally by showing the standard log dialog. \membersection{wxLogWindow::wxLogWindow} -\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,16 +698,16 @@ 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. @@ -730,7 +733,7 @@ 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}