restore-right-margin

Arguments: text-edit-pane

Sets the right-margin of a text-edit-pane to reflect the number of characters that will fit within the interior width of the window. Specifically, this is the interior-width of the window minus its text-edit-margins. This will be a useful value only if the window's font is a fixed-width font.

restore-right-margin is called automatically whenever a text-edit-pane is created or resized, and so an application probably has no need to call this function. An application should be able to evaluate the expression (right-margin text-edit-pane nil) at any time to find the number of characters that will fit onto one line of text. (If the window's horizontal scrollbar is enabled, then this is the amount of one line of text that can be scrolled into view at one time. See scrollbars.) The pretty-printer also uses the right-margin to format text within the visible interior width of a text edit pane.

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.