wxLogWindow

This class represents a background log window: to be precise, it collects all log messages in the log frame which it manages but also passes them on to the log target which was active at the moment of its creation. This allows, for example, to show all the log messages in a frame but still continue to process them normally by showing the standard log dialog.

Derived from

wxLogPassThrough

Include files

<wx/log.h>

See also

wxLogTextCtrl

Members

wxLogWindow::wxLogWindow
wxLogWindow::Show
wxLogWindow::GetFrame
wxLogWindow::OnFrameCreate
wxLogWindow::OnFrameClose
wxLogWindow::OnFrameDelete

wxLogWindow::wxLogWindow

wxLogWindow(wxFrame *parent, const wxChar *title, bool show = true, bool passToOld = true)

Creates the log frame window and starts collecting the messages in it.

Parameters

parent

The parent window for the log frame, may be NULL

title

The title for the log frame

show

true to show the frame initially (default), otherwise wxLogWindow::Show must be called later.

passToOld

true to process the log messages normally in addition to logging them in the log frame (default), false to only log them in the log frame.

wxLogWindow::Show

void Show(bool show = true)

Shows or hides the frame.

wxLogWindow::GetFrame

wxFrame * GetFrame() const

Returns the associated log frame window. This may be used to position or resize it but use wxLogWindow::Show to show or hide it.

wxLogWindow::OnFrameCreate

virtual void OnFrameCreate(wxFrame *frame)

Called immediately after the log frame creation allowing for any extra initializations.

wxLogWindow::OnFrameClose

virtual bool OnFrameClose(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 true from here to allow the frame to close, false to prevent this from happening.

See also

wxLogWindow::OnFrameDelete

wxLogWindow::OnFrameDelete

virtual void OnFrameDelete(wxFrame *frame)

Called right before the log frame is going to be deleted: will always be called unlike OnFrameClose().