character-format

A class of objects that contains a set of character format parameters. A character-format instance has these slots:

face, point-size, bold, italic, underline, color, same-face, same-point-size, same-bold, same-italic, same-underline, same-color.

These properties correspond to the multiple values returned by get-character-format. The first six properties take the same kinds of values as the same arguments to set-character-format, while the remaining same-foo properties are boolean values.

A character-format instance may be used to copy character-formatting from one place to another. Alternately, a set of several character formats may be managed in order to apply particular styles to various places in a rich-edit-pane.

When applying a character-format, the face of the text will be changed only if same-face is non-nil, and likewise for the other corresponding properties. Therefore, if a character-format retrieved from a section of text by calling character-format is applied to another section of text by calling (setf character-format), only those attributes that were uniform over the entire copied text will be changed in the target text. For example, if the copied text includes some bold text as well as some non-bold text, then the boldness of the target text will not change.

See cg-rich-text.htm for information about rich text editing in Common Graphics.

Copyright (c) 1998-2016, Franz Inc. Oakland, CA., USA. All rights reserved.
This page was not revised from the 8.1 page.
Created 2010.1.21.