Panel: log

Syntax

{<name>:} log {<file>}

Description

Text log sub-panel. An output-only sub-panel used for text listing. Its contents can be directed to a log file.

Membership

• Panel window

• Tab window

Parameters

• <name>
  A name to be given to the sub-panel for reference purposes.

• <file>
  The name of a log file in which to record all output directed to the log. This can be omitted in which case no file is created. The default file extension is .log.

Switches

• -bc=<color>
  The background color for the log. If omitted, the background color of the parent window is used.

• -c=<num>
  The width of the log in characters. If omitted, a suitable default is used.

• -dim=<screen_xy>
  Define the dimensions of the sub-panel in pixels. This is usually redundant because log sub-panels are by default created sized-to-fit, but is useful when the size needs to be overridden. This is a two-element numeric array providing width and height. If only one is required, the other can be set to -1 and will be ignored.

• -er
  Extend the width of the sub-panel to the right of its parent row or column.

• -fo=<font>
  The font to be used for text in the log. This must be a fixed font. If omitted the log inherits the font of its parent row or column.

• -gh
  The sub-panel should be initially ghosted, i.e. insensitive to user-interaction.

• -inv
  Make the sub-panel invisible on creation.

• -j=<just>
  The justification of the sub-panel within its parent row or column. Within a parent row the value should be one of L, M, R. Within a parent column the value should be one of T, M or B. The default in both cases is M.

• -keep
  Retain the log file at the end of the session. This is the default behavior. Use -no_keep to destroy the file at the end of the session.

• -link=<text>
  The resize linkage for the panel. This ties panel edges to one or more edges of the parent window, with the result that when the parent window gets resized, the panel gets automatically resized as well. <text> is a combination of the characters L, R, T, B and M. A value of "LRTB" means that the left, right, top and bottom edges of a sub-panel are linked to its parent. The default value is "TL", which links the left and top edges to the parent window but does no resizing because its right and bottom edges are not linked. Note that the linkage is to edges of the parent window, not to column/row extremities. More complicated linkage requirements should be done via the window.resize callback on the parent window.

• -max=<num>
  The maximum number of text lines which are retained for scrolling purposes. If omitted, the default is 128.

• -n=<num>
  The maximum size in bytes of the log file (if specified). The default is 16384.

• -pj=<just>
  The position justification of the sub-panel within the panel window. This combined with the -x and -y switches can be used to position the sub-panel by one of its corners. The default is ’TL’. It also defines the control point to be used when repositioning the sub-panel after creation.

• -r=<num>
  The number of visible rows in the log. If this omitted the default is 10.

• -tc=<color>
  The color for log text. If omitted the parent window "other color" is used.

• -tit=<string>
  A title to be written to the log file (if specified). There is no default.

• -w=<num>
  The width of the log in pixels. If omitted, a suitable default is used.

• -x=<num>
  The x position of the sub-panel relative to the top-left corner of its parent row or column. If omitted, the sub-panel is placed adjacent to the previously defined sub-panel.

• -y=<num>
  The y position of the sub-panel relative to the top-left corner of its parent row or column. If omitted, the sub-panel is placed below the previously defined sub-panel.

Callbacks

None

Examples

Create a panel window containing a text log of 10 rows with a white background.

window w = wpanel {
    log: log -r=10,-bc=white
}

Create a panel window containing a text log of 80 characters wide, and default height.

window w = wpanel {
    log: log /tmp/window.log,-tit='Window Log',-c=80
}
# Write a line of text to the log
tell -log=w.log,<'Start time:',now>

See Also