set-paragraph-format

Arguments: window &rest args

Sets the paragraph format of window, which must be an instance of text-edit-pane. Note that a rich-edit-pane is an instance of text-edit-pane. Note further that neither a text-edit-window nor a rich-edit control are accepted as arguments. (A text-edit-window is usually the parent of a text-edit-pane. Applying window to a rich-edit control typically returns the rich-edit-pane suitable as an argument to this function.)

The other arguments set paragraph formatting characteristics. They are keyword arguments (and so should be specified in keyword/value pairs). They are as follows:

• :justification: :justification should be is one of :left, :center, :right, or nil for no change.
• :numbering-style: numbering-style is one of :bullets, :plain, or nil for no change.
• :top-left-indentation, :body-left-indentation, :right-indentation, :top-left-indentation-is-relative: top-left-indentation, body-left-indentation, and right-indentation are each a number in points, or nil for no change.

  top-left-indentation is the indentation of the first line of text. If top-left-indentation-is-relative is true, then top-left-indentation is relative to the current indentation of each affected paragraph.

  body-left-indentation is the indentation of the second and following lines of text, relative to the first line of text.

  right-indentation is the indentation of the right side of the text.

• :tabs: tabs is a list of tab positions from left to right, specified in points, or t for no change. t is the default. nil would remove any tabs that are currently set. The Microsoft control allows up to 32 tab positions, and Common Graphics will simply ignore any beyond the first 32 in the list.

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

GTK note

Formated editable text is not yet implemented on the GTK platform. It appears feasible to implement functions such as set-character-format and set-paragraph-format that modify the text formatting of an edit control, but not to implement functions such as rich-text and rich-edit-range that handle actual rich text strings.

Attempting to create a rich-edit widget or a rich-edit-pane window currently will error on GTK.

Copyright (c) 1998-2019, Franz Inc. Oakland, CA., USA. All rights reserved.
This page has had moderate revisions compared to the 8.2 page.
Created 2019.8.20.