rich-edit-ruler

Class

Package: common-graphics

The rich-edit-ruler control allows the end user to interactively specify paragraph indentation and tab positions of an attached rich-edit control. The control will affect the paragraph that currently contains the text cursor, or the set of paragraphs that are wholly or partly selected.

Two small triangular gadgets may be dragged along the lower half of the ruler to set the main left and right indentations, and a third small triangular gadget may be dragged along the upper half to set the left indentation of the first line of each paragraph. Clicking elsewhere on the ruler adds a tab marker at the clicked position. A tab marker may be removed by clicking it and dragging it off the ruler.

A rich-edit-ruler must be attached to a particular rich-edit control in order to have any functionality. When building a form interactively, a rich-edit-ruler may be attached by placing it or dragging it so that it partly overlaps a rich-edit control. The ruler will then be positioned and sized so that it runs along the entire top side of the rich-edit control, and the two controls will be internally associated. When creating the controls programmatically instead, the name of the rich-edit should be specified as the rich-edit property of the ruler, and the name of the ruler should be specified as the ruler property of the rich-edit. This may be done at creation time using the associated initargs, like this:

(make-instance 'rich-edit
  :name 'my-rich-edit
  :ruler 'my-rich-edit-ruler
  ...)
...
(make-instance 'rich-edit-ruler
  :name 'my-rich-edit-ruler
  :rich-edit 'my-rich-edit
  ...)

See About Rich Text Editing in Common Graphics in cgide.htm.

Common Graphics and IDE documentation is described in About Common Graphics and IDE documentation in cgide.htm.

The documentation is described in introduction.htm and the index is in index.htm.

Created 2000.10.5.