1 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
3 %% Purpose: wxLog and related classes documentation
4 %% Author: Vadim Zeitlin
6 %% Created: some time ago
8 %% Copyright: (c) 1997-2001 Vadim Zeitlin
9 %% License: wxWidgets license
10 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
12 \section{\class{wxLog
}}\label{wxlog
}
14 wxLog class defines the interface for the
{\it log targets
} used by wxWidgets
15 logging functions as explained in the
\helpref{wxLog overview
}{wxlogoverview
}.
16 The only situations when you need to directly use this class is when you want
17 to derive your own log target because the existing ones don't satisfy your
18 needs. Another case is if you wish to customize the behaviour of the standard
19 logging classes (all of which respect the wxLog settings): for example, set
20 which trace messages are logged and which are not or change (or even remove
21 completely) the timestamp on the messages.
23 Otherwise, it is completely hidden behind the
{\it wxLogXXX()
} functions and
24 you may not even know about its existence.
26 See
\helpref{log overview
}{wxlogoverview
} for the descriptions of wxWidgets
29 \wxheading{Derived from
}
33 \wxheading{Include files
}
37 \latexignore{\rtfignore{\wxheading{Function groups
}}}
39 \membersection{Static functions
}
41 The functions in this section work with and manipulate the active log target.
42 The
\helpref{OnLog()
}{wxlogonlog
} is called by the
{\it wxLogXXX()
} functions
43 and invokes the
\helpref{DoLog()
}{wxlogdolog
} of the active log target if any.
44 Get/Set methods are used to install/query the current active target and,
45 finally,
\helpref{DontCreateOnDemand()
}{wxlogdontcreateondemand
} disables the
46 automatic creation of a standard log target if none actually exists. It is
47 only useful when the application is terminating and shouldn't be used in other
48 situations because it may easily lead to a loss of messages.
50 \helpref{OnLog
}{wxlogonlog
}\\
51 \helpref{GetActiveTarget
}{wxloggetactivetarget
}\\
52 \helpref{SetActiveTarget
}{wxlogsetactivetarget
}\\
53 \helpref{DontCreateOnDemand
}{wxlogdontcreateondemand
}\\
54 \helpref{Suspend
}{wxlogsuspend
}\\
55 \helpref{Resume
}{wxlogresume
}
57 \membersection{Logging functions
}
59 There are two functions which must be implemented by any derived class to
60 actually process the log messages:
\helpref{DoLog
}{wxlogdolog
} and
61 \helpref{DoLogString
}{wxlogdologstring
}. The second function receives a string
62 which just has to be output in some way and the easiest way to write a new log
63 target is to override just this function in the derived class. If more control
64 over the output format is needed, then the first function must be overridden
65 which allows to construct custom messages depending on the log level or even
66 do completely different things depending on the message severity (for example,
67 throw away all messages except warnings and errors, show warnings on the
68 screen and forward the error messages to the user's (or programmer's) cell
69 phone - maybe depending on whether the timestamp tells us if it is day or
70 night in the current time zone).
72 There also functions to support message buffering. Why are they needed?
73 Some of wxLog implementations, most notably the standard wxLogGui class,
74 buffer the messages (for example, to avoid showing the user a zillion of modal
75 message boxes one after another -- which would be really annoying).
76 \helpref{Flush()
}{wxlogflush
} shows them all and clears the buffer contents.
77 This function doesn't do anything if the buffer is already empty.
79 \helpref{Flush
}{wxlogflush
}\\
80 \helpref{FlushActive
}{wxlogflushactive
}
82 \membersection{Customization
}\label{wxlogcustomization
}
84 The functions below allow some limited customization of wxLog behaviour
85 without writing a new log target class (which, aside of being a matter of
86 several minutes, allows you to do anything you want).
88 The verbose messages are the trace messages which are not disabled in the
89 release mode and are generated by
\helpref{wxLogVerbose
}{wxlogverbose
}. They
90 are not normally shown to the user because they present little interest, but
91 may be activated, for example, in order to help the user find some program
94 As for the (real) trace messages, their handling depends on the settings of
95 the (application global)
{\it trace mask
}. There are two ways to specify it:
96 either by using
\helpref{SetTraceMask
}{wxlogsettracemask
} and
97 \helpref{GetTraceMask
}{wxloggettracemask
} and using
98 \helpref{wxLogTrace
}{wxlogtrace
} which takes an integer mask or by using
99 \helpref{AddTraceMask
}{wxlogaddtracemask
} for string trace masks.
101 The difference between bit-wise and string trace masks is that a message using
102 integer trace mask will only be logged if all bits of the mask are set in the
103 current mask while a message using string mask will be logged simply if the
104 mask had been added before to the list of allowed ones.
109 // wxTraceOleCalls is one of standard bit masks
110 wxLogTrace(wxTraceRefCount | wxTraceOleCalls, "Active object ref count:
%d", nRef);
112 will do something only if the current trace mask contains both
113 {\tt wxTraceRefCount
} and
{\tt wxTraceOle
}, but
116 // wxTRACE_OleCalls is one of standard string masks
117 wxLogTrace(wxTRACE_OleCalls, "IFoo::Bar() called");
120 will log the message if it was preceded by
123 wxLog::AddTraceMask(wxTRACE_OleCalls);
126 Using string masks is simpler and allows to easily add custom ones, so this is
127 the preferred way of working with trace messages. The integer trace mask is
128 kept for compatibility and for additional (but very rarely needed) flexibility
131 The standard trace masks are given in
\helpref{wxLogTrace
}{wxlogtrace
}
134 Finally, the
{\it wxLog::DoLog()
} function automatically prepends a time stamp
135 to all the messages. The format of the time stamp may be changed: it can be
136 any string with \% specifications fully described in the documentation of the
137 standard
{\it strftime()
} function. For example, the default format is
138 "
[\%d/\%b/\%y \%H:\%M:\%S
] " which gives something like "
[17/Sep/
98 22:
10:
16] "
139 (without quotes) for the current date. Setting an empty string as the time
140 format disables timestamping of the messages completely.
142 {\bf NB:
} Timestamping is disabled for Visual C++ users in debug builds by
143 default because otherwise it would be impossible to directly go to the line
144 from which the log message was generated by simply clicking in the debugger
145 window on the corresponding error message. If you wish to enable it, please use
146 \helpref{SetTimestamp
}{wxlogsettimestamp
} explicitly.
148 \helpref{AddTraceMask
}{wxlogaddtracemask
}\\
149 \helpref{RemoveTraceMask
}{wxlogremovetracemask
}\\
150 \helpref{ClearTraceMasks
}{wxlogcleartracemasks
}\\
151 \helpref{GetTraceMasks
}{wxloggettracemasks
}\\
152 \helpref{IsAllowedTraceMask
}{wxlogisallowedtracemask
}\\
153 \helpref{SetVerbose
}{wxlogsetverbose
}\\
154 \helpref{GetVerbose
}{wxloggetverbose
}\\
155 \helpref{SetTimestamp
}{wxlogsettimestamp
}\\
156 \helpref{GetTimestamp
}{wxloggettimestamp
}\\
157 \helpref{SetTraceMask
}{wxlogsettracemask
}\\
158 \helpref{GetTraceMask
}{wxloggettracemask
}
160 %%%%% MEMBERS HERE %%%%%
161 \helponly{\insertatlevel{2}{
167 \membersection{wxLog::AddTraceMask
}\label{wxlogaddtracemask
}
169 \func{static void
}{AddTraceMask
}{\param{const wxString\&
}{mask
}}
171 Add the
{\it mask
} to the list of allowed masks for
172 \helpref{wxLogTrace
}{wxlogtrace
}.
176 \helpref{RemoveTraceMask
}{wxlogremovetracemask
}
177 \helpref{GetTraceMasks
}{wxloggettracemasks
}
179 \membersection{wxLog::ClearTraceMasks
}\label{wxlogcleartracemasks
}
181 \func{static void
}{ClearTraceMasks
}{\void}
183 Removes all trace masks previously set with
184 \helpref{AddTraceMask
}{wxlogaddtracemask
}.
188 \helpref{RemoveTraceMask
}{wxlogremovetracemask
}
190 \membersection{wxLog::GetTraceMasks
}\label{wxloggettracemasks
}
192 \func{static const wxArrayString \&
}{GetTraceMasks
}{\void}
194 Returns the currently allowed list of string trace masks.
198 \helpref{AddTraceMask
}{wxlogaddtracemask
}.
200 \membersection{wxLog::OnLog
}\label{wxlogonlog
}
202 \func{static void
}{OnLog
}{\param{wxLogLevel
}{ level
},
\param{const char *
}{ message
}}
204 Forwards the message at specified level to the
{\it DoLog()
} function of the
205 active log target if there is any, does nothing otherwise.
207 \membersection{wxLog::GetActiveTarget
}\label{wxloggetactivetarget
}
209 \func{static wxLog *
}{GetActiveTarget
}{\void}
211 Returns the pointer to the active log target (may be NULL).
213 \membersection{wxLog::SetActiveTarget
}\label{wxlogsetactivetarget
}
215 \func{static wxLog *
}{SetActiveTarget
}{\param{wxLog *
}{ logtarget
}}
217 Sets the specified log target as the active one. Returns the pointer to the
218 previous active log target (may be NULL).
220 \membersection{wxLog::Suspend
}\label{wxlogsuspend
}
222 \func{static void
}{Suspend
}{\void}
224 Suspends the logging until
\helpref{Resume
}{wxlogresume
} is called. Note that
225 the latter must be called the same number of times as the former to undo it,
226 i.e. if you call Suspend() twice you must call Resume() twice as well.
228 Note that suspending the logging means that the log sink won't be be flushed
229 periodically, it doesn't have any effect if the current log target does the
230 logging immediately without waiting for
\helpref{Flush
}{wxlogflush
} to be
231 called (the standard GUI log target only shows the log dialog when it is
232 flushed, so Suspend() works as expected with it).
236 \helpref{Resume
}{wxlogresume
},\\
237 \helpref{wxLogNull
}{wxlogoverview
}
239 \membersection{wxLog::Resume
}\label{wxlogresume
}
241 \func{static void
}{Resume
}{\void}
243 Resumes logging previously suspended by a call to
244 \helpref{Suspend
}{wxlogsuspend
}. All messages logged in the meanwhile will be
247 \membersection{wxLog::DoLog
}\label{wxlogdolog
}
249 \func{virtual void
}{DoLog
}{\param{wxLogLevel
}{level
},
\param{const wxChar
}{*msg
},
\param{time
\_t }{timestamp
}}
251 Called to process the message of the specified severity.
{\it msg
} is the text
252 of the message as specified in the call of
{\it wxLogXXX()
} function which
253 generated it and
{\it timestamp
} is the moment when the message was generated.
255 The base class version prepends the timestamp to the message, adds a prefix
256 corresponding to the log level and then calls
257 \helpref{DoLogString
}{wxlogdologstring
} with the resulting string.
259 \membersection{wxLog::DoLogString
}\label{wxlogdologstring
}
261 \func{virtual void
}{DoLogString
}{\param{const wxChar
}{*msg
},
\param{time
\_t }{timestamp
}}
263 Called to log the specified string. The timestamp is already included into the
264 string but still passed to this function.
266 A simple implementation may just send the string to
{\tt stdout
} or, better,
269 \membersection{wxLog::DontCreateOnDemand
}\label{wxlogdontcreateondemand
}
271 \func{static void
}{DontCreateOnDemand
}{\void}
273 Instructs wxLog to not create new log targets on the fly if there is none
274 currently. (Almost) for internal use only: it is supposed to be called by the
275 application shutdown code.
277 Note that this function also calls
278 \helpref{ClearTraceMasks
}{wxlogcleartracemasks
}.
280 \membersection{wxLog::Flush
}\label{wxlogflush
}
282 \func{virtual void
}{Flush
}{\void}
284 Shows all the messages currently in buffer and clears it. If the buffer
285 is already empty, nothing happens.
287 \membersection{wxLog::FlushActive
}\label{wxlogflushactive
}
289 \func{static void
}{FlushActive
}{\void}
291 Flushes the current log target if any, does nothing if there is none.
295 \helpref{Flush
}{wxlogflush
}
297 \membersection{wxLog::SetVerbose
}\label{wxlogsetverbose
}
299 \func{static void
}{SetVerbose
}{\param{bool
}{ verbose = true
}}
301 Activates or deactivates verbose mode in which the verbose messages are
302 logged as the normal ones instead of being silently dropped.
304 \membersection{wxLog::GetVerbose
}\label{wxloggetverbose
}
306 \func{static bool
}{GetVerbose
}{\void}
308 Returns whether the verbose mode is currently active.
310 \membersection{wxLog::SetLogLevel
}\label{wxlogsetloglevel
}
312 \func{static void
}{SetLogLevel
}{\param{wxLogLevel
}{ logLevel
}}
314 Specifies that log messages with $level > logLevel$ should be ignored
315 and not sent to the active log target.
317 \membersection{wxLog::GetLogLevel
}\label{wxloggetloglevel
}
319 \func{static wxLogLevel
}{GetLogLevel
}{\void}
321 Returns the current log level limit.
323 \membersection{wxLog::SetTimestamp
}\label{wxlogsettimestamp
}
325 \func{void
}{SetTimestamp
}{\param{const char *
}{ format
}}
327 Sets the timestamp format prepended by the default log targets to all
328 messages. The string may contain any normal characters as well as \%
329 prefixed format specificators, see
{\it strftime()
} manual for details.
330 Passing a NULL value (not empty string) to this function disables message timestamping.
332 \membersection{wxLog::GetTimestamp
}\label{wxloggettimestamp
}
334 \constfunc{const char *
}{GetTimestamp
}{\void}
336 Returns the current timestamp format string.
338 \membersection{wxLog::SetTraceMask
}\label{wxlogsettracemask
}
340 \func{static void
}{SetTraceMask
}{\param{wxTraceMask
}{ mask
}}
342 Sets the trace mask, see
\helpref{Customization
}{wxlogcustomization
}
345 \membersection{wxLog::GetTraceMask
}\label{wxloggettracemask
}
347 Returns the current trace mask, see
\helpref{Customization
}{wxlogcustomization
} section
350 \membersection{wxLog::IsAllowedTraceMask
}\label{wxlogisallowedtracemask
}
352 \func{static bool
}{IsAllowedTraceMask
}{\param{const wxChar *
}{mask
}}
354 Returns true if the
{\it mask
} is one of allowed masks for
355 \helpref{wxLogTrace
}{wxlogtrace
}.
357 See also:
\helpref{AddTraceMask
}{wxlogaddtracemask
},
358 \helpref{RemoveTraceMask
}{wxlogremovetracemask
}
360 \membersection{wxLog::RemoveTraceMask
}\label{wxlogremovetracemask
}
362 \func{static void
}{RemoveTraceMask
}{\param{const wxString\&
}{mask
}}
364 Remove the
{\it mask
} from the list of allowed masks for
365 \helpref{wxLogTrace
}{wxlogtrace
}.
367 See also:
\helpref{AddTraceMask
}{wxlogaddtracemask
}
369 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% wxLogChain %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
371 \section{\class{wxLogChain
}}\label{wxlogchain
}
373 This simple class allows to chain log sinks, that is to install a new sink but
374 keep passing log messages to the old one instead of replacing it completely as
375 \helpref{SetActiveTarget
}{wxlogsetactivetarget
} does.
377 It is especially useful when you want to divert the logs somewhere (for
378 example to a file or a log window) but also keep showing the error messages
379 using the standard dialogs as
\helpref{wxLogGui
}{wxlogoverview
} does by default.
384 wxLogChain *logChain = new wxLogChain(new wxLogStderr);
386 // all the log messages are sent to stderr and also processed as usually
389 // don't delete logChain directly as this would leave a dangling
390 // pointer as active log target, use SetActiveTarget() instead
391 delete wxLog::SetActiveTarget(...something else or NULL...);
395 \wxheading{Derived from
}
397 \helpref{wxLog
}{wxlog
}
399 \wxheading{Include files
}
403 \latexignore{\rtfignore{\wxheading{Members
}}}
405 \membersection{wxLogChain::wxLogChain
}\label{wxlogchainwxlogchain
}
407 \func{}{wxLogChain
}{\param{wxLog *
}{logger
}}
409 Sets the specified
{\tt logger
} (which may be
{\tt NULL
}) as the default log
410 target but the log messages are also passed to the previous log target if any.
412 \membersection{wxLogChain::
\destruct{wxLogChain
}}
414 \func{}{\destruct{wxLogChain
}}{\void}
416 Destroys the previous log target.
418 \membersection{wxLogChain::GetOldLog
}\label{wxlogchaingetoldlog
}
420 \constfunc{wxLog *
}{GetOldLog
}{\void}
422 Returns the pointer to the previously active log target (which may be
{\tt
425 \membersection{wxLogChain::IsPassingMessages
}\label{wxlogchainispassingmessages
}
427 \constfunc{bool
}{IsPassingMessages
}{\void}
429 Returns
{\tt true
} if the messages are passed to the previously active log
430 target (default) or
{\tt false
} if
\helpref{PassMessages
}{wxlogchainpassmessages
}
433 \membersection{wxLogChain::PassMessages
}\label{wxlogchainpassmessages
}
435 \func{void
}{PassMessages
}{\param{bool
}{passMessages
}}
437 By default, the log messages are passed to the previously active log target.
438 Calling this function with
{\tt false
} parameter disables this behaviour
439 (presumably temporarily, as you shouldn't use wxLogChain at all otherwise) and
440 it can be reenabled by calling it again with
{\it passMessages
} set to
{\tt
443 \membersection{wxLogChain::SetLog
}\label{wxlogchainsetlog
}
445 \func{void
}{SetLog
}{\param{wxLog *
}{logger
}}
447 Sets another log target to use (may be
{\tt NULL
}). The log target specified
448 in the
\helpref{constructor
}{wxlogchainwxlogchain
} or in a previous call to
449 this function is deleted.
451 This doesn't change the old log target value (the one the messages are
452 forwarded to) which still remains the same as was active when wxLogChain
455 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% wxLogGui %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
457 \section{\class{wxLogGui
}}\label{wxloggui
}
459 This is the default log target for the GUI wxWidgets applications. It is passed
460 to
\helpref{wxLog::SetActiveTarget
}{wxlogsetactivetarget
} at the program
461 startup and is deleted by wxWidgets during the program shut down.
463 \wxheading{Derived from
}
465 \helpref{wxLog
}{wxlog
}
467 \wxheading{Include files
}
471 \latexignore{\rtfignore{\wxheading{Members
}}}
473 \membersection{wxLogGui::wxLogGui
}
475 \func{}{wxLogGui
}{\void}
479 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% wxLogNull %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
481 \section{\class{wxLogNull
}}\label{wxlognull
}
483 This class allows to temporarily suspend logging. All calls to the log
484 functions during the life time of an object of this class are just ignored.
486 In particular, it can be used to suppress the log messages given by wxWidgets
487 itself but it should be noted that it is rarely the best way to cope with this
488 problem as
{\bf all
} log messages are suppressed, even if they indicate a
489 completely different error than the one the programmer wanted to suppress.
491 For instance, the example of the overview:
497 // wxFile.Open() normally complains if file can't be opened, we don't want it
500 if ( !file.Open("bar") )
501 ... process error ourselves ...
502 } // ~wxLogNull called, old log sink restored
504 wxLogMessage("..."); // ok
508 would be better written as:
514 // don't try to open file if it doesn't exist, we are prepared to deal with
515 // this ourselves - but all other errors are not expected
516 if ( wxFile::Exists("bar") )
518 // gives an error message if the file couldn't be opened
528 \wxheading{Derived from
}
530 \helpref{wxLog
}{wxlog
}
532 \wxheading{Include files
}
536 \latexignore{\rtfignore{\wxheading{Members
}}}
538 \membersection{wxLogNull::wxLogNull
}
540 \func{}{wxLogNull
}{\void}
544 \membersection{wxLogNull::
\destruct{wxLogNull
}}
548 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%% wxLogPassThrough %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
550 \section{\class{wxLogPassThrough
}}\label{wxlogpassthrough
}
552 A special version of
\helpref{wxLogChain
}{wxlogchain
} which uses itself as the
553 new log target. Maybe more clearly, it means that this is a log target which
554 forwards the log messages to the previously installed one in addition to
555 processing them itself.
557 Unlike
\helpref{wxLogChain
}{wxlogchain
} which is usually used directly as is,
558 this class must be derived from to implement
\helpref{DoLog
}{wxlogdolog
}
559 and/or
\helpref{DoLogString
}{wxlogdologstring
} methods.
561 \wxheading{Derived from
}
563 \helpref{wxLogChain
}{wxlogchain
}
565 \wxheading{Include files
}
569 \latexignore{\rtfignore{\wxheading{Members
}}}
571 \membersection{wxLogPassThrough::wxLogPassThrough
}\label{wxlogpassthroughctor
}
573 Default ctor installs this object as the current active log target.
575 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% wxLogStderr %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
577 \section{\class{wxLogStderr
}}\label{wxlogstderr
}
579 This class can be used to redirect the log messages to a C file stream (not to
580 be confused with C++ streams). It is the default log target for the non-GUI
581 wxWidgets applications which send all the output to
{\tt stderr
}.
583 \wxheading{Derived from
}
585 \helpref{wxLog
}{wxlog
}
587 \wxheading{Include files
}
593 \helpref{wxLogStream
}{wxlogstream
}
595 \latexignore{\rtfignore{\wxheading{Members
}}}
597 \membersection{wxLogStderr::wxLogStderr
}
599 \func{}{wxLogStderr
}{\param{FILE
}{*fp = NULL
}}
601 Constructs a log target which sends all the log messages to the given
602 {\tt FILE
}. If it is
{\tt NULL
}, the messages are sent to
{\tt stderr
}.
604 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% wxLogStream %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
606 \section{\class{wxLogStream
}}\label{wxlogstream
}
608 This class can be used to redirect the log messages to a C++ stream.
610 Please note that this class is only available if wxWidgets was compiled with
611 the standard iostream library support (
{\tt wxUSE
\_STD\_IOSTREAM} must be on).
613 \wxheading{Derived from
}
615 \helpref{wxLog
}{wxlog
}
617 \wxheading{Include files
}
623 \helpref{wxLogStderr
}{wxlogstderr
},\\
624 \helpref{wxStreamToTextRedirector
}{wxstreamtotextredirector
}
626 \latexignore{\rtfignore{\wxheading{Members
}}}
628 \membersection{wxLogStream::wxLogStream
}
630 \func{}{wxLogStream
}{\param{std::ostream
}{*ostr = NULL
}}
632 Constructs a log target which sends all the log messages to the given
633 output stream. If it is
{\tt NULL
}, the messages are sent to
{\tt cerr
}.
635 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% wxLogTextCtrl %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
637 \section{\class{wxLogTextCtrl
}}\label{wxlogtextctrl
}
639 Using these target all the log messages can be redirected to a text control.
640 The text control must have been created with
{\tt wxTE
\_MULTILINE} style by the
643 \wxheading{Derived from
}
645 \helpref{wxLog
}{wxlog
}
647 \wxheading{Include files
}
653 \helpref{wxLogTextCtrl
}{wxlogtextctrl
},\\
654 \helpref{wxStreamToTextRedirector
}{wxstreamtotextredirector
}
656 \latexignore{\rtfignore{\wxheading{Members
}}}
658 \membersection{wxLogTextCtrl::wxLogTextCtrl
}
660 \func{}{wxLogTextCtrl
}{\param{wxTextCtrl
}{*textctrl
}}
662 Constructs a log target which sends all the log messages to the given text
663 control. The
{\it textctrl
} parameter cannot be
{\tt NULL
}.
665 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% wxLogWindow %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
667 \section{\class{wxLogWindow
}}\label{wxlogwindow
}
669 This class represents a background log window: to be precise, it collects all
670 log messages in the log frame which it manages but also passes them on to the
671 log target which was active at the moment of its creation. This allows, for
672 example, to show all the log messages in a frame but still continue to process
673 them normally by showing the standard log dialog.
675 \wxheading{Derived from
}
677 \helpref{wxLogPassThrough
}{wxlogpassthrough
}
679 \wxheading{Include files
}
685 \helpref{wxLogTextCtrl
}{wxlogtextctrl
}
687 \latexignore{\rtfignore{\wxheading{Members
}}}
689 \membersection{wxLogWindow::wxLogWindow
}
691 \func{}{wxLogWindow
}{\param{wxFrame
}{*parent
},
\param{const wxChar
}{*title
},
\param{bool
}{show =
{\tt true
}},
\param{bool
}{passToOld =
{\tt true
}}}
693 Creates the log frame window and starts collecting the messages in it.
695 \wxheading{Parameters
}
697 \docparam{parent
}{The parent window for the log frame, may be
{\tt NULL
}}
699 \docparam{title
}{The title for the log frame
}
701 \docparam{show
}{{\tt true
} to show the frame initially (default), otherwise
702 \helpref{wxLogWindow::Show
}{wxlogwindowshow
} must be called later.
}
704 \docparam{passToOld
}{{\tt true
} to process the log messages normally in addition to
705 logging them in the log frame (default),
{\tt false
} to only log them in the
708 \membersection{wxLogWindow::Show
}\label{wxlogwindowshow
}
710 \func{void
}{Show
}{\param{bool
}{show =
{\tt true
}}}
712 Shows or hides the frame.
714 \membersection{wxLogWindow::GetFrame
}
716 \constfunc{wxFrame *
}{GetFrame
}{\void}
718 Returns the associated log frame window. This may be used to position or resize
719 it but use
\helpref{wxLogWindow::Show
}{wxlogwindowshow
} to show or hide it.
721 \membersection{wxLogWindow::OnFrameCreate
}
723 \func{virtual void
}{OnFrameCreate
}{\param{wxFrame
}{*frame
}}
725 Called immediately after the log frame creation allowing for
726 any extra initializations.
728 \membersection{wxLogWindow::OnFrameClose
}\label{wxlogwindowonframeclose
}
730 \func{virtual bool
}{OnFrameClose
}{\param{wxFrame
}{*frame
}}
732 Called if the user closes the window interactively, will not be
733 called if it is destroyed for another reason (such as when program
736 Return
{\tt true
} from here to allow the frame to close,
{\tt false
} to
737 prevent this from happening.
741 \helpref{wxLogWindow::OnFrameDelete
}{wxlogwindowonframedelete
}
743 \membersection{wxLogWindow::OnFrameDelete
}\label{wxlogwindowonframedelete
}
745 \func{virtual void
}{OnFrameDelete
}{\param{wxFrame
}{*frame
}}
747 Called right before the log frame is going to be deleted: will
748 always be called unlike
\helpref{OnFrameClose()
}{wxlogwindowonframeclose
}.
projects / wxWidgets.git / blob