Phoenix Logo

phoenix_title wx.LogWindow

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 you, for example, to show all the log messages in a frame but still continue to process them normally by showing the standard log dialog.

See also

wx.LogTextCtrl


class_hierarchy Class Hierarchy

Inheritance diagram for class LogWindow:

method_summary Methods Summary

__init__ Creates the log frame window and starts collecting the messages in it.
GetFrame Returns the associated log frame window.
OnFrameClose Called if the user closes the window interactively, will not be called if it is destroyed for another reason (such as when program exits).
OnFrameDelete Called right before the log frame is going to be deleted: will always be called unlike OnFrameClose .
Show Shows or hides the frame.

property_summary Properties Summary

Frame See GetFrame

api Class API



class wx.LogWindow(LogInterposer)

Possible constructors:

LogWindow(pParent, szTitle, show=True, passToOld=True)

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.


Methods



__init__(self, pParent, szTitle, show=True, passToOld=True)

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

Parameters:
  • pParent (wx.Window) – The parent window for the log frame, may be None
  • szTitle (string) – The title for the log frame
  • show (bool) – True to show the frame initially (default), otherwise Show must be called later.
  • passToOld (bool) – 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. Note that if no targets were set using wx.Log.SetActiveTarget then wx.LogWindow simply becomes the active one and messages won’t be passed to other targets.


GetFrame(self)

Returns the associated log frame window.

This may be used to position or resize it but use Show to show or hide it.

Return type: wx.Frame


OnFrameClose(self, 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.

Parameters:frame (wx.Frame) –
Return type:bool

See also

OnFrameDelete



OnFrameDelete(self, frame)

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

Parameters:frame (wx.Frame) –


Show(self, show=True)

Shows or hides the frame.

Parameters:show (bool) –

Properties



Frame

See GetFrame