Product Documentation
Virtuoso Schematic Editor SKILL Functions Reference
Product Version IC23.1, November 2023

schSetCmdOption 

schSetCmdOption( 
g_form 
s_field 
l_fieldValues 
x_key 
t_mousePrompt 
)
=> t / nil

Description

Customizes which form fields are modified by calls to schCmdOption, middle mouse button, and schShiftCmdOption, Shift-middle mouse button, when the command is active.

Arguments

g_form

Form to customize.

s_field

Symbol of the form field to modify.

l_fieldValues

List of valid values that the field cycles through.

x_key

Specifies whether this form field is changed during schCmdOption or schShiftCmdOption.
Valid Values: 1 for normal, 2 for shift

t_mousePrompt

Description of the command that will be displayed on the status line to explain the effect of clicking on the mouse button; must be enclosed in quotation marks.

Value Returned

t

Customized which form fields are modified by calls to schCmdOption, middle mouse button, and schShiftCmdOption, Shift-middle mouse button, when the command is active.

nil

Customization was unsuccessful.

Examples

Sets the direction field to toggle between input and output when the createPin command is active and you click the right mouse button.

schSetCmdOption( schCreatePinForm 'direction list( "input" "output" ) 1 "toggle Direction" )

Return to top
 ⠀
X