wxRuby Documentation Home

# 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, 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

LogPassThrough

## See also

LogTextCtrl

## Methods

- LogWindow.new
- LogWindow#show
- LogWindow#get_frame
- LogWindow#on_frame_create
- LogWindow#on_frame_close
- LogWindow#on_frame_delete

### LogWindow.new

LogWindow.new(%(arg-type)Frame% parent, Char title, Boolean show = `true`, Boolean 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
  LogWindow#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.

### LogWindow#show

show(%(arg-type)Boolean% show = `true`)

Shows or hides the frame.

### LogWindow#get_frame

Frame get_frame()

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

### LogWindow#on_frame_create

on_frame_create(%(arg-type)Frame% frame)

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

### LogWindow#on_frame_close

Boolean on_frame_close(%(arg-type)Frame% 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

LogWindow#on_frame_delete

### LogWindow#on_frame_delete

on_frame_delete(%(arg-type)Frame% frame)

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

[This page automatically generated from the Textile source at 2023-06-09 00:45:33 +0000]