rich-text-pane-character-format

rich-text-pane-character-format Function

Summary

Returns the character format.

Package

capi

Signature

rich-text-pane-character-format pane &key selection => result

Arguments

`pane`⇩	A rich-text-pane.
`selection`⇩	Must be `t`. This argument is deprecated.

Values

result⇩

A plist.

Description

The function rich-text-pane-character-format returns as a plist the current character attributes for pane.

If there is a current selection in the pane, then the attributes are those set for the selected text. If there is no selection, then it gets the "typing attributes", which are applied to characters that are typed by the user. Note that any cursor movement changes these attributes, so their values are ephemeral.

Supplying selection is deprecated. If selection is nil an error is signalled. The default value of selection is t.

An attribute appears in result only if its value is the same over all of the range. Therefore this form:

(getf 
 (capi:rich-text-pane-character-format pane) :bold 
 :unknown)

will return:

t if all the selection is bold.
nil if all the selection is not bold.
:unknown if the selection is only partially bold.

For the possible attributes, see set-rich-text-pane-character-format.

Compatibility note

The value nil for the keyword argument :selection is not supported in LispWorks 6.1 and later. See the description above for details of the current behavior with respect to the current selection in the rich-text-pane.