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: wxWindows license
10 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
12 \section{\class{wxLog
}}\label{wxlog
}
14 wxLog class defines the interface for the
{\it log targets
} used by wxWindows
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 wxWindows
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 Although this function doesn't do anything if the buffer is already empty,
78 \helpref{HasPendingMessages()
}{wxloghaspendingmessages
} is also provided which
79 allows to explicitly verify it.
81 \helpref{Flush
}{wxlogflush
}\\
82 \helpref{FlushActive
}{wxlogflushactive
}\\
83 \helpref{HasPendingMessages
}{wxloghaspendingmessages
}
85 \membersection{Customization
}\label{wxlogcustomization
}
87 The functions below allow some limited customization of wxLog behaviour
88 without writing a new log target class (which, aside of being a matter of
89 several minutes, allows you to do anything you want).
91 The verbose messages are the trace messages which are not disabled in the
92 release mode and are generated by
\helpref{wxLogVerbose
}{wxlogverbose
}. They
93 are not normally shown to the user because they present little interest, but
94 may be activated, for example, in order to help the user find some program
97 As for the (real) trace messages, their handling depends on the settings of
98 the (application global)
{\it trace mask
}. There are two ways to specify it:
99 either by using
\helpref{SetTraceMask
}{wxlogsettracemask
} and
100 \helpref{GetTraceMask
}{wxloggettracemask
} and using
101 \helpref{wxLogTrace
}{wxlogtrace
} which takes an integer mask or by using
102 \helpref{AddTraceMask
}{wxlogaddtracemask
} for string trace masks.
104 The difference between bit-wise and string trace masks is that a message using
105 integer trace mask will only be logged if all bits of the mask are set in the
106 current mask while a message using string mask will be logged simply if the
107 mask had been added before to the list of allowed ones.
112 // wxTraceOleCalls is one of standard bit masks
113 wxLogTrace(wxTraceRefCount | wxTraceOleCalls, "Active object ref count:
%d", nRef);
115 will do something only if the current trace mask contains both
116 {\tt wxTraceRefCount
} and
{\tt wxTraceOle
}, but
119 // wxTRACE_OleCalls is one of standard string masks
120 wxLogTrace(wxTRACE_OleCalls, "IFoo::Bar() called");
123 will log the message if it was preceded by
126 wxLog::AddTraceMask(wxTRACE_OleCalls);
129 Using string masks is simpler and allows to easily add custom ones, so this is
130 the preferred way of working with trace messages. The integer trace mask is
131 kept for compatibility and for additional (but very rarely needed) flexibility
134 The standard trace masks are given in
\helpref{wxLogTrace
}{wxlogtrace
}
137 Finally, the
{\it wxLog::DoLog()
} function automatically prepends a time stamp
138 to all the messages. The format of the time stamp may be changed: it can be
139 any string with \% specifications fully described in the documentation of the
140 standard
{\it strftime()
} function. For example, the default format is
141 "
[\%d/\%b/\%y \%H:\%M:\%S
] " which gives something like "
[17/Sep/
98 22:
10:
16] "
142 (without quotes) for the current date. Setting an empty string as the time
143 format disables timestamping of the messages completely.
145 {\bf NB:
} Timestamping is disabled for Visual C++ users in debug builds by
146 default because otherwise it would be impossible to directly go to the line
147 from which the log message was generated by simply clicking in the debugger
148 window on the corresponding error message. If you wish to enable it, please use
149 \helpref{SetTimestamp
}{wxlogsettimestamp
} explicitly.
151 \helpref{AddTraceMask
}{wxlogaddtracemask
}\\
152 \helpref{RemoveTraceMask
}{wxlogremovetracemask
}\\
153 \helpref{ClearTraceMasks
}{wxlogcleartracemasks
}\\
154 \helpref{GetTraceMasks
}{wxloggettracemasks
}\\
155 \helpref{IsAllowedTraceMask
}{wxlogisallowedtracemask
}\\
156 \helpref{SetVerbose
}{wxlogsetverbose
}\\
157 \helpref{GetVerbose
}{wxloggetverbose
}\\
158 \helpref{SetTimestamp
}{wxlogsettimestamp
}\\
159 \helpref{GetTimestamp
}{wxloggettimestamp
}\\
160 \helpref{SetTraceMask
}{wxlogsettracemask
}\\
161 \helpref{GetTraceMask
}{wxloggettracemask
}
163 %%%%% MEMBERS HERE %%%%%
164 \helponly{\insertatlevel{2}{
170 \membersection{wxLog::AddTraceMask
}\label{wxlogaddtracemask
}
172 \func{static void
}{AddTraceMask
}{\param{const wxString\&
}{mask
}}
174 Add the
{\it mask
} to the list of allowed masks for
175 \helpref{wxLogTrace
}{wxlogtrace
}.
178 \helpref{RemoveTraceMask
}{wxlogremovetracemask
}
179 \helpref{GetTraceMasks
}{wxloggettracemasks
}
181 \membersection{wxLog::ClearTraceMasks
}\label{wxlogcleartracemasks
}
183 \func{static void
}{ClearTraceMasks
}{\void}
185 Removes all trace masks previously set with
186 \helpref{AddTraceMask
}{wxlogaddtracemask
}.
189 \helpref{RemoveTraceMask
}{wxlogremovetracemask
}
191 \membersection{wxLog::GetTraceMasks
}\label{wxloggettracemasks
}
193 \func{static const wxArrayString &
}{GetTraceMasks
}{\void}
195 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).
234 \wxheading{See also:
}
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::HasPendingMessages
}\label{wxloghaspendingmessages
}
299 \constfunc{bool
}{HasPendingMessages
}{\void}
301 Returns true if there are any messages in the buffer (not yet shown to the
302 user). (Almost) for internal use only.
304 \membersection{wxLog::SetVerbose
}\label{wxlogsetverbose
}
306 \func{static void
}{SetVerbose
}{\param{bool
}{ verbose = TRUE
}}
308 Activates or deactivates verbose mode in which the verbose messages are
309 logged as the normal ones instead of being silently dropped.
311 \membersection{wxLog::GetVerbose
}\label{wxloggetverbose
}
313 \func{static bool
}{GetVerbose
}{\void}
315 Returns whether the verbose mode is currently active.
317 \membersection{wxLog::SetTimestamp
}\label{wxlogsettimestamp
}
319 \func{void
}{SetTimestamp
}{\param{const char *
}{ format
}}
321 Sets the timestamp format prepended by the default log targets to all
322 messages. The string may contain any normal characters as well as \%
323 prefixed format specificators, see
{\it strftime()
} manual for details.
324 Passing a NULL value (not empty string) to this function disables message timestamping.
326 \membersection{wxLog::GetTimestamp
}\label{wxloggettimestamp
}
328 \constfunc{const char *
}{GetTimestamp
}{\void}
330 Returns the current timestamp format string.
332 \membersection{wxLog::SetTraceMask
}\label{wxlogsettracemask
}
334 \func{static void
}{SetTraceMask
}{\param{wxTraceMask
}{ mask
}}
336 Sets the trace mask, see
\helpref{Customization
}{wxlogcustomization
}
339 \membersection{wxLog::GetTraceMask
}\label{wxloggettracemask
}
341 Returns the current trace mask, see
\helpref{Customization
}{wxlogcustomization
} section
344 \membersection{wxLog::IsAllowedTraceMask
}\label{wxlogisallowedtracemask
}
346 \func{static bool
}{IsAllowedTraceMask
}{\param{const wxChar *
}{mask
}}
348 Returns TRUE if the
{\it mask
} is one of allowed masks for
349 \helpref{wxLogTrace
}{wxlogtrace
}.
351 See also:
\helpref{AddTraceMask
}{wxlogaddtracemask
},
352 \helpref{RemoveTraceMask
}{wxlogremovetracemask
}
354 \membersection{wxLog::RemoveTraceMask
}\label{wxlogremovetracemask
}
356 \func{static void
}{RemoveTraceMask
}{\param{const wxString\&
}{mask
}}
358 Remove the
{\it mask
} from the list of allowed masks for
359 \helpref{wxLogTrace
}{wxlogtrace
}.
361 See also:
\helpref{AddTraceMask
}{wxlogaddtracemask
}
363 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% wxLogChain %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
365 \section{\class{wxLogChain
}}\label{wxlogchain
}
367 This simple class allows to chain log sinks, that is to install a new sink but
368 keep passing log messages to the old one instead of replacing it completely as
369 \helpref{SetActiveTarget
}{wxlogsetactivetarget
} does.
371 It is especially useful when you want to divert the logs somewhere (for
372 example to a file or a log window) but also keep showing the error messages
373 using the standard dialogs as
\helpref{wxLogGui
}{wxlogoverview
} does by default.
378 wxLogChain *logChain = new wxLogChain(new wxLogStderr);
380 // all the log messages are sent to stderr and also processed as usually
387 \wxheading{Derived from
}
389 \helpref{wxLog
}{wxlog
}
391 \wxheading{Include files
}
395 \latexignore{\rtfignore{\wxheading{Members
}}}
397 \membersection{wxLogChain::wxLogChain
}\label{wxlogchainwxlogchain
}
399 \func{}{wxLogChain
}{\param{wxLog *
}{logger
}}
401 Sets the specified
{\tt logger
} (which may be
{\tt NULL
}) as the default log
402 target but the log messages are also passed to the previous log target if any.
404 \membersection{wxLogChain::
\destruct{wxLogChain
}}
406 \func{}{\destruct{wxLogChain
}}{\void}
408 Destroys the previous log target.
410 \membersection{wxLogChain::GetOldLog
}\label{wxlogchaingetoldlog
}
412 \constfunc{wxLog *
}{GetOldLog
}{\void}
414 Returns the pointer to the previously active log target (which may be
{\tt
417 \membersection{wxLogChain::IsPassingMessages
}\label{wxlogchainispassingmessages
}
419 \constfunc{bool
}{IsPassingMessages
}{\void}
421 Returns
{\tt TRUE
} if the messages are passed to the previously active log
422 target (default) or
{\tt FALSE
} if
\helpref{PassMessages
}{wxlogchainpassmessages
}
425 \membersection{wxLogChain::PassMessages
}\label{wxlogchainpassmessages
}
427 \func{void
}{PassMessages
}{\param{bool
}{passMessages
}}
429 By default, the log messages are passed to the previously active log target.
430 Calling this function with
{\tt FALSE
} parameter disables this behaviour
431 (presumably temporarily, as you shouldn't use wxLogChain at all otherwise) and
432 it can be reenabled by calling it again with
{\it passMessages
} set to
{\tt
435 \membersection{wxLogChain::SetLog
}\label{wxlogchainsetlog
}
437 \func{void
}{SetLog
}{\param{wxLog *
}{logger
}}
439 Sets another log target to use (may be
{\tt NULL
}). The log target specified
440 in the
\helpref{constructor
}{wxlogchainwxlogchain
} or in a previous call to
441 this function is deleted.
443 This doesn't change the old log target value (the one the messages are
444 forwarded to) which still remains the same as was active when wxLogChain
447 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% wxLogGui %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
449 \section{\class{wxLogGui
}}\label{wxloggui
}
451 This is the default log target for the GUI wxWindows applications. It is passed
452 to
\helpref{wxLog::SetActiveTarget
}{wxlogsetactivetarget
} at the program
453 startup and is deleted by wxWindows during the program shut down.
455 \wxheading{Derived from
}
457 \helpref{wxLog
}{wxlog
}
459 \wxheading{Include files
}
463 \latexignore{\rtfignore{\wxheading{Members
}}}
465 \membersection{wxLogGui::wxLogGui
}
467 \func{}{wxLogGui
}{\void}
471 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% wxLogNull %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
473 \section{\class{wxLogNull
}}\label{wxlognull
}
475 This class allows to temporarily suspend logging. All calls to the log
476 functions during the life time of an object of this class are just ignored.
478 In particular, it can be used to suppress the log messages given by wxWindows
479 itself but it should be noted that it is rarely the best way to cope with this
480 problem as
{\bf all
} log messages are suppressed, even if they indicate a
481 completely different error than the one the programmer wanted to suppress.
483 For instance, the example of the overview:
489 // wxFile.Open() normally complains if file can't be opened, we don't want it
492 if ( !file.Open("bar") )
493 ... process error ourselves ...
494 } // ~wxLogNull called, old log sink restored
496 wxLogMessage("..."); // ok
500 would be better written as:
506 // don't try to open file if it doesn't exist, we are prepared to deal with
507 // this ourselves - but all other errors are not expected
508 if ( wxFile::Exists("bar") )
510 // gives an error message if the file couldn't be opened
520 \wxheading{Derived from
}
522 \helpref{wxLog
}{wxlog
}
524 \wxheading{Include files
}
528 \latexignore{\rtfignore{\wxheading{Members
}}}
530 \membersection{wxLogNull::wxLogNull
}
532 \func{}{wxLogNull
}{\void}
536 \membersection{wxLogNull::
\destruct{wxLogNull
}}
540 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%% wxLogPassThrough %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
542 \section{\class{wxLogPassThrough
}}\label{wxlogpassthrough
}
544 A special version of
\helpref{wxLogChain
}{wxlogchain
} which uses itself as the
545 new log target. Maybe more clearly, it means that this is a log target which
546 forwards the log messages to the previously installed one in addition to
547 processing them itself.
549 Unlike
\helpref{wxLogChain
}{wxlogchain
} which is usually used directly as is,
550 this class must be derived from to implement
\helpref{DoLog
}{wxlogdolog
}
551 and/or
\helpref{DoLogString
}{wxlogdologstring
} methods.
553 \wxheading{Derived from
}
555 \helpref{wxLogChain
}{wxlogchain
}
557 \wxheading{Include files
}
561 \latexignore{\rtfignore{\wxheading{Members
}}}
563 \membersection{wxLogPassThrough::wxLogPassThrough
}\label{wxlogpassthroughctor
}
565 Default ctor installs this object as the current active log target.
567 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% wxLogStderr %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
569 \section{\class{wxLogStderr
}}\label{wxlogstderr
}
571 This class can be used to redirect the log messages to a C file stream (not to
572 be confused with C++ streams). It is the default log target for the non-GUI
573 wxWindows applications which send all the output to
{\tt stderr
}.
575 \wxheading{Derived from
}
577 \helpref{wxLog
}{wxlog
}
579 \wxheading{Include files
}
585 \helpref{wxLogStream
}{wxlogstream
}
587 \latexignore{\rtfignore{\wxheading{Members
}}}
589 \membersection{wxLogStderr::wxLogStderr
}
591 \func{}{wxLogStderr
}{\param{FILE
}{*fp = NULL
}}
593 Constructs a log target which sends all the log messages to the given
594 {\tt FILE
}. If it is
{\tt NULL
}, the messages are sent to
{\tt stderr
}.
596 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% wxLogStream %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
598 \section{\class{wxLogStream
}}\label{wxlogstream
}
600 This class can be used to redirect the log messages to a C++ stream.
602 Please note that this class is only available if wxWindows was compiled with
603 the standard iostream library support (
{\tt wxUSE
\_STD\_IOSTREAM} must be on).
605 \wxheading{Derived from
}
607 \helpref{wxLog
}{wxlog
}
609 \wxheading{Include files
}
615 \helpref{wxLogStderr
}{wxlogstderr
},\\
616 \helpref{wxStreamToTextRedirector
}{wxstreamtotextredirector
}
618 \latexignore{\rtfignore{\wxheading{Members
}}}
620 \membersection{wxLogStream::wxLogStream
}
622 \func{}{wxLogStream
}{\param{std::ostream
}{*ostr = NULL
}}
624 Constructs a log target which sends all the log messages to the given
625 output stream. If it is
{\tt NULL
}, the messages are sent to
{\tt cerr
}.
627 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% wxLogTextCtrl %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
629 \section{\class{wxLogTextCtrl
}}\label{wxlogtextctrl
}
631 Using these target all the log messages can be redirected to a text control.
632 The text control must have been created with
{\tt wxTE
\_MULTILINE} style by the
635 \wxheading{Derived from
}
637 \helpref{wxLog
}{wxlog
}
639 \wxheading{Include files
}
645 \helpref{wxLogTextCtrl
}{wxlogtextctrl
},\\
646 \helpref{wxStreamToTextRedirector
}{wxstreamtotextredirector
}
648 \latexignore{\rtfignore{\wxheading{Members
}}}
650 \membersection{wxLogTextCtrl::wxLogTextCtrl
}
652 \func{}{wxLogTextCtrl
}{\param{wxTextCtrl
}{*textctrl
}}
654 Constructs a log target which sends all the log messages to the given text
655 control. The
{\it textctrl
} parameter cannot be
{\tt NULL
}.
657 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% wxLogWindow %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
659 \section{\class{wxLogWindow
}}\label{wxlogwindow
}
661 This class represents a background log window: to be precise, it collects all
662 log messages in the log frame which it manages but also passes them on to the
663 log target which was active at the moment of its creation. This allows, for
664 example, to show all the log messages in a frame but still continue to process
665 them normally by showing the standard log dialog.
667 \wxheading{Derived from
}
669 \helpref{wxLogPassThrough
}{wxlogpassthrough
}
671 \wxheading{Include files
}
677 \helpref{wxLogTextCtrl
}{wxlogtextctrl
}
679 \latexignore{\rtfignore{\wxheading{Members
}}}
681 \membersection{wxLogWindow::wxLogWindow
}
683 \func{}{wxLogWindow
}{\param{wxFrame
}{*parent
},
\param{const wxChar
}{*title
},
\param{bool
}{show =
{\tt TRUE
}},
\param{bool
}{passToOld =
{\tt TRUE
}}}
685 Creates the log frame window and starts collecting the messages in it.
687 \wxheading{Parameters
}
689 \docparam{parent
}{The parent window for the log frame, may be
{\tt NULL
}}
691 \docparam{title
}{The title for the log frame
}
693 \docparam{show
}{{\tt TRUE
} to show the frame initially (default), otherwise
694 \helpref{wxLogWindow::Show
}{wxlogwindowshow
} must be called later.
}
696 \docparam{passToOld
}{{\tt TRUE
} to process the log messages normally in addition to
697 logging them in the log frame (default),
{\tt FALSE
} to only log them in the
700 \membersection{wxLogWindow::Show
}\label{wxlogwindowshow
}
702 \func{void
}{Show
}{\param{bool
}{show =
{\tt TRUE
}}}
704 Shows or hides the frame.
706 \membersection{wxLogWindow::GetFrame
}
708 \constfunc{wxFrame *
}{GetFrame
}{\void}
710 Returns the associated log frame window. This may be used to position or resize
711 it but use
\helpref{wxLogWindow::Show
}{wxlogwindowshow
} to show or hide it.
713 \membersection{wxLogWindow::OnFrameCreate
}
715 \func{virtual void
}{OnFrameCreate
}{\param{wxFrame
}{*frame
}}
717 Called immediately after the log frame creation allowing for
718 any extra initializations.
720 \membersection{wxLogWindow::OnFrameClose
}\label{wxlogwindowonframeclose
}
722 \func{virtual void
}{OnFrameClose
}{\param{wxFrame
}{*frame
}}
724 Called if the user closes the window interactively, will not be
725 called if it is destroyed for another reason (such as when program
728 Return
{\tt TRUE
} from here to allow the frame to close,
{\tt FALSE
} to
729 prevent this from happening.
733 \helpref{wxLogWindow::OnFrameDelete
}{wxlogwindowonframedelete
}
735 \membersection{wxLogWindow::OnFrameDelete
}\label{wxlogwindowonframedelete
}
737 \func{virtual void
}{OnFrameDelete
}{\param{wxFrame
}{*frame
}}
739 Called right before the log frame is going to be deleted: will
740 always be called unlike
\helpref{OnFrameClose()
}{wxlogwindowonframeclose
}.
projects / wxWidgets.git / blob