set-default-interface-prefix-suffix

set-default-interface-prefix-suffix Function

Summary

Sets the default suffix and prefix that are added to each interface title.

Package

capi

Signature

set-default-interface-prefix-suffix &key prefix suffix child-prefix child-suffix => prefix, suffix, child-prefix, child-suffix

Arguments

`prefix`⇩	A string or `nil`.
`suffix`⇩	A string or `nil`.
`child-prefix`⇩	A string or `nil`.
`child-suffix`⇩	A string or `nil`.

Values

`prefix`	A string or `nil`.
`suffix`	A string or `nil`.
`child-prefix`	A string or `nil`.
`child-suffix`	A string or `nil`.

Description

The function set-default-interface-prefix-suffix sets the global default suffix and prefix that are added to each interface title. The prefix and suffix are added by the default method of interface-extend-title.

If prefix, suffix, child-prefix or child-suffix are supplied, their value must be either a string or nil. If any of them is not passed, the corresponding previously set value is not changed.

prefix and suffix specify the prefix and suffix to use for interfaces that are children of a screen object. These values do not affect child-prefix and child-suffix.

child-prefix and child-suffix specify the prefix and suffix to use for interfaces that are not children of a screen object, such as an interface inside a Multiple Document Interface (MDI) window. These values do not affect prefix and suffix.

The return values are the settings of the prefix, suffix, child prefix and child suffix after the call.

To check the current settings, call set-default-interface-prefix-suffix with no arguments. This does not change the current settings.

Before setting the title on a window on the screen, the system calls interface-extend-title with the interface and the title of the interface, and uses the result for the actual title. The default method of interface-extend-title checks prefix and suffix (or child-prefix and child-suffix for MDI) as were set by set-default-interface-prefix-suffix, and if they are non-nil adds the value to the title.

set-default-interface-prefix-suffix can be called after some windows are displayed. It automatically updates all current interface windows as if by calling update-all-interface-titles.

Examples

If you work in an environment when it is not always obvious on which machine your image is running, you can add the name of the machine to all windows by:

(capi:set-default-interface-prefix-suffix
        :suffix (format nil "-- ~a" (machine-instance)))