edit-in-place

Arguments: window &key string box font background-color foreground-color close justification draw-border single-line help-string lisp-form

Places a temporary edit-pane on window at box to allow the user to edit string. This is typically done in place, which means that box is positioned directly over a string that is already displayed as part of a larger interface.

The arguments are:

• window is the window on which the type-in will take place.
• string is the initial string to edit. Defaults to the null string.
• box is the subregion of the window where the type-in will take place. Defaults to the whole interior of the window.
• font is the font to use for editing the string. Defaults to the current font of the window.
• background-color is an rgb color for the background of the text. Defaults to the current background-color of the window.
• foreground-color is an rgb color for the foreground of the text. Defaults to the current foreground-color of the window.
• close is a boolean which if true, then the small edit pane is closed after the type-in is complete. Otherwise it is not closed and is reused the next time an edit-in-place is done on window. The latter may make the edit-in-place begin a bit faster, but results in more leftover edit-in-place panes hanging around. Defaults to t.
• justification is either :left, :center, or :right to indicate the horizontal justification of the edited text. Defaults to :left.
• draw-border is a boolean which if true, then a border is drawn around the text being edited during the type-in. The value may be either nil for no border, t for a default static border, or any of the border styles that may be passed to make-window. Defaults to nil.
• single-line is a boolean which if true then the edited text will always be a single line of text, and otherwise will wrap to multiple lines as needed in order to fit within the width of box. Defaults to nil.
• help-string is a string to display in the status bar at the beginning of the type-in.
• lisp-form is a boolean which if true causes the edit-pane to be a lisp-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.