All Manuals > CAPI User Guide and Reference Manual > 21 CAPI Reference Entries

editor-pane-in-place-style

editor-pane-arglist-displayer-style

text-input-pane-in-place-style Generic Functions

Summary

Specifies appearance of in-place completers and arglist displayer.

Package

capi

Signatures

editor-pane-in-place-style editor-pane => foreground, background, font

editor-pane-arglist-displayer-style editor-pane => foreground, background, font

text-input-pane-in-place-style text-input-pane => foreground, background, font

Arguments
editor-pane
text-input-pane
Values
foreground, background
Color specifiers or nil.
font
A font specifier or nil.
Description

The generic functions editor-pane-in-place-style, editor-pane-arglist-displayer-style and text-input-pane-in-place-style give you a way to control the appearance of in-place completers and the arglist displayer in instances of subclasses of editor-pane and text-input-pane. In-place completion is described in 10.6 In-place completion. The arglist displayer is raised the editor command Function Arglist Displayer.

Each of the return values may be nil, meaning use the default. There are methods specialized on editor-pane and text-input-pane which return 3 nils.

In the description below, pane means editor-pane or text-input-pane as appropriate.

background and foreground specify the colors of the background and foreground of the in-place completion window or arglist displayer, using 15 The Color System. In addition, they can also be one of the following keywords:

:inherit
Inherit the respective color from pane.
:background, :foreground
Use the background or the foreground of pane. This is useful for inverting the colors.
:tweak
Use a "tweak" of the corresponding color of pane, where "tweak" means a color that is close the corresponding color of pane in the RGB space, but is quite clearly different.
:tweak-light
Like :tweak, but with less "tweaking", that is the "tweaked" color is closer to the background/foreground.

font specifies the font to use for the text.

Notes

You will need to define your own subclass of editor-pane or text-input-pane to define methods for these generic functions.

See also

editor-pane
text-input-pane
Function Arglist Displayer
10.6 In-place completion
15 The Color System


CAPI User Guide and Reference Manual (Macintosh version) - 18 Feb 2025 15:33:09