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

A boolean.

Values

result

A plist.

Description

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

selection determines the range for which the attributes are returned. If selection is nil , then the range is all the text in pane , otherwise the range is the current selection. 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.

See also

rich-text-pane
set-rich-text-pane-character-format