property-editor-type

Arguments: object name

In releases prior to 7.0, this generic function was called property-editor-mode. The name has changed to remove a name conflict with editor-mode.

Returns one of the symbols listed below, indicating the style of extended editing that will be performed by the inspector for the property of object named by name. The extended editor is invoked by pressing the small button on the right side of the value when a property row is chosen in the inspector. This function returns one of the following values:

• :long-expression: edit in a separate window.
• :number: edit a number (typically an integer) in a separate window.
• :multiple-choice: display the choices in a combo-box or similar control.
• :toggle: switch between t and nil.
• :color: display a color choice dialog.
• :font: display a font choice dialog.
• :path: display a dialog for choosing a directory or file.
• :menu: display the menu editor. Applies only to the menu property of a frame window.
• :function: the value will be a symbol naming a function (as in the event-handler properties). If the symbol names a user-supplied function, display the code for that function if possible. Otherwise display a function definition template in an editor buffer associated with the form.

For example, when running the IDE, you will typically have a Form window named :form1 (or sometimes :formN for an N bigger than one). Make a variable have that form as its value, perhaps by evaluating

(setf myform (find-window :form1))

Or by choosing Tools | Get Component, then clicking on the form window (away from any control), and then evaluating (setf myform *) in the Debug Window.

Once the value of myform is the form, then here are the editor modes for several form properties:

(property-editor-type myform 'background-color) RETURNS :color
(property-editor-type myform 'border) RETURNS :multiple-choice
(property-editor-type myform 'child-p) RETURNS :toggle
(property-editor-type myform 'class) RETURNS :multiple-choice
(property-editor-type myform 'cursor) RETURNS :long-expression
(property-editor-type myform 'height) RETURNS :number

Copyright (c) 1998-2022, Franz Inc. Lafayette, CA., USA. All rights reserved.
This page was not revised from the 10.0 page.
Created 2019.8.20.