text-edit-margins

Arguments: text-edit-widget-or-window

Returns a value indicating the extra empty space that will appear in a text-editing control between its left and right borders and its text. The setf of this function may be called to change the margins at any time, and the margins may be specified initially as the value of the :text-edit-margins initarg when creating the control. The control will be redrawn as needed automatically whenever these margins are changed.

text-edit-widget-or-window may be either an editable-text or multi-line-editable-text widget or an editable-text-pane or text-edit-pane window. For the widgets, text-edit-margins appears as a property in the inspector when laying out widgets interactively on a form.

The value that is returned from text-edit-margins or passed to (setf text-edit-margins) may be either nil to indicate default margins, or a non-negative integer to specify the same margin for both sides, or a list of two non-negative integers to specify individual margins for the left and right sides (in that order). The values are measured in pixels, and are added to any default margins that are built into the control. nil and 0 and (0 0) are equivalent values that indicate default margins. The initial value is nil.

This function determines how a text-editing control lays out its interior, and so is distinct from other margin-related facilities that affect how stream output is printed, such as the Common Lisp variable *print-right-margin* and the Common Graphics functions left-margin, top-margin, right-margin, and bottom-margin.

GTK Note

Calling (setf text-edit-margins) will have an effect on GTK only on multi-line controls.

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.