X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/fc2171bd4c660b8554dae2a1cbf34ff09f3032a6..32485259c1342115488d219776dfebeb3d4d81b1:/docs/latex/wx/log.tex diff --git a/docs/latex/wx/log.tex b/docs/latex/wx/log.tex index ec53f6792f..f96989dde2 100644 --- a/docs/latex/wx/log.tex +++ b/docs/latex/wx/log.tex @@ -6,7 +6,7 @@ %% Created: some time ago %% RCS-ID: $Id$ %% Copyright: (c) 1997-2001 Vadim Zeitlin -%% License: wxWidgets license +%% License: wxWindows license %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% \section{\class{wxLog}}\label{wxlog} @@ -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 @@ -215,7 +215,9 @@ Returns the pointer to the active log target (may be NULL). \func{static wxLog *}{SetActiveTarget}{\param{wxLog * }{ logtarget}} Sets the specified log target as the active one. Returns the pointer to the -previous active log target (may be NULL). +previous active log target (may be NULL). To supress logging use a new +instance of wxLogNull not NULL. If the active log target is set to NULL a +new default log target will be created when logging occurs. \membersection{wxLog::Suspend}\label{wxlogsuspend} @@ -402,14 +404,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} @@ -445,7 +447,7 @@ true}. \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 @@ -470,7 +472,7 @@ startup and is deleted by wxWidgets during the program shut down. \latexignore{\rtfignore{\wxheading{Members}}} -\membersection{wxLogGui::wxLogGui} +\membersection{wxLogGui::wxLogGui}\label{wxlogguictor} \func{}{wxLogGui}{\void} @@ -535,13 +537,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. @@ -594,7 +596,7 @@ wxWidgets 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}} @@ -625,7 +627,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}} @@ -655,7 +657,7 @@ caller previously. \latexignore{\rtfignore{\wxheading{Members}}} -\membersection{wxLogTextCtrl::wxLogTextCtrl} +\membersection{wxLogTextCtrl::wxLogTextCtrl}\label{wxlogtextctrlctor} \func{}{wxLogTextCtrl}{\param{wxTextCtrl }{*textctrl}} @@ -686,7 +688,7 @@ 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}}} @@ -711,14 +713,14 @@ log frame.} 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}} @@ -727,7 +729,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