Product Documentation
Cadence User Interface SKILL Reference
Product Version IC23.1, September 2023

enterNumber

enterNumber(
[ ?prompts l_promptList ]
[ ?form s_form ]
[ ?initProc t_initProcName ] 
[ ?doneProc t_doneProcName ]
[ ?formProc t_formProcName ]
[ ?alwaysMap g_alwaysMap ]
[ ?cmdName t_cmdName ]
[ ?cursor x_cursor ]
) 
=> f_number

Description

Prompts you to enter a number.

When you type a number and press Enter, any characters accumulated in the input line are returned as a number in floating-point format.

Arguments

?prompts l_promptList

  

List of prompt strings to be displayed in the CIW. Only the first prompt in the list is used.

?form s_form

Options form created with hiCreateOptionsForm. This form is displayed when you call hiToggleEnterForm. It contains options relevant to the enterfunction and its caller. The form can be displayed any time before you press Enter to terminate the enterfunction.

?initProc t_initProcName

  

Name of the SKILL function to be called immediately after the enterfunction is started and before any data entry.

?doneProc t_doneProcName

  

Name of the SKILL function to be called when the enterfunction is terminated. The number is passed as the third argument to the done proc.

?formProc t_formProcName

  

Name of the SKILL function to be called when the options form is displayed.

?alwaysMap g_alwaysMap

  

Determines whether or not to immediately display the options form.

?cmdName t_cmdName

  

Name you associate with the enterfunction. If the command name is set, it can be accessed with hiGetCurrentCmd.

?cursor x_cursor

An integer argument that will default to an appropriate cursor. For example, hicArrowRectangle for enterBox and hicArrowArc for enterArc. For more information on all available cursors see hiSetCursor.

Values Returned

f_number

The number you typed in floating-point format.

Retrieve data through the callback procedure t_doneProcName instead of using the return value for this enterfunction.

Examples

The prompt "Enter any number" is displayed on the CIW prompt line. When you type a number and press Enter, the enterfunction returns that number.

enterNumber( ?prompts
   list( "Enter any number." )
)

Related Topics

User Entry Functions

hiCreateOptionsForm

undrawEnterFun

hiGetCurrentCmd


Return to top
 ⠀
X