top-left-indentation

Arguments: text-edit-pane

Returns the current indentation of the first line of a paragraph of text in a text-edit-pane, or the indentation indicated by the corresponding upper-left slider of a rich-edit-ruler.

This generic function may be called either on a text-edit-pane (typically a rich-edit-pane) or on a rich-edit-ruler. The methods behave somewhat differently: for a text-edit-pane, body-left-indentation is relative to top-left-indentation to match the rich text specification and the Microsoft rich edit control; for a rich-edit-ruler, top-left-indentation is instead relative to body-left-indentation to match the intuitive practice of moving the overall indentation of one or more paragraphs without changing the relative indentation of the first line of each paragraph.

The text-edit-pane method returns the left indentation of the first line of the paragraph that contains the text-edit-pane's text cursor (or the first paragraph partly or wholly contained in the selected text, if any). This value is measured in points, and is measured rightward from the interior left of the text-edit-pane. A point is one seventy-second of an inch.

The setf method for text-edit-pane sets the indentation of the first line of the paragraph that contains the text cursor (or all paragraphs that are partly or wholly selected, if any). Since the body-left-indentation of a text-edit-control is relative to this position, the body indentation will change by the same amount. If there is a rich-edit-ruler associated with the text-edit-pane (see the function ruler), then the rich-edit-ruler's indentation will be automatically modified to match.

The rich-edit-ruler method returns the position of the slider at the upper left of the ruler, measured rightward in points from the position of the lower-left slider for body-left-indentation.

The setf method for rich-edit-ruler moves the upper-left slider of the ruler to the specified position relative to the lower-left slider. The slider will be constrained at position 0 (the leftmost position) if an attempt is made to move it to a negative position. If there is a text-edit-pane associated with the ruler (see the function rich-edit), then the paragraph in the text-edit-pane that contains the text cursor (or all paragraphs that are partly or contained in the selected text, if any) will be automatically modified to match (by modifying indentation of only the first line of each selected paragraph).

To apply this function to a rich-edit control, first apply window to the control to obtain a rich-edit-pane to pass to this function.

To read or modify multiple paragraph attributes of a text-edit-pane at once, see get-paragraph-format or set-paragraph-format.

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

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