enterPoint
enterPoint(
[ ?prompts l_promptList ]
[ ?points l_pointList ]
[ ?form s_form ]
[ ?addPointProc t_addProcName ]
[ ?delPointProc t_delProcName ]
[ ?initProc t_initProcName ]
[ ?doneProc t_doneProcName ]
[ ?formProc t_formProcName ]
[ ?alwaysMap g_alwaysMap ]
[ ?acceptString g_acceptString ]
[ ?acceptNumber g_acceptNumber ]
[ ?noInfix g_noInfix ]
[ ?cmdName t_cmdName ]
[ ?cursor x_cursor ]
)
=> l_coord_pair
Description
Prompts you to enter a single point.
Arguments
|
?prompts l_promptList
|
|
|
List of prompt strings to be displayed. The first string in the list is displayed until you enter a point. Any other strings are ignored.
|
|
?points l_pointList
|
|
|
List with no more than one point in it. If supplied, the point is adjusted and returned with no further interaction. If not supplied, the first string in l_promptList is displayed on the CIW prompt line asking you to enter the point.
|
|
?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.
|
|
?addPointProc t_addProcName
|
|
|
Name of the SKILL function to be called when a point is entered.
|
|
?delPointProc t_delProcName
|
|
|
Name of the SKILL function to be called when a point is deleted. Since entering the first point terminates the function, this procedure is effectively never called.
|
|
?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.
|
|
?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.
|
|
?acceptString g_acceptString
|
|
|
Determines whether or not to accept string input without terminating the enterfunction.
|
|
?acceptNumber g_acceptNumber
|
|
|
Determines whether or not to accept numeric input without terminating the enterfunction.
|
|
?noInfix g_noInfix
|
|
|
Determines whether or not to disable infix mode.
|
|
?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.
|
Value Returned
|
l_coord_pair
|
The adjusted point you specified.
|
Retrieve data through the callback procedure t_doneProcName instead of using the return value for this enterfunction.
Examples
Displays the prompt Enter a point is displayed on the prompt line.
procedure( pointDone( w done pts )
if( done then
printf("Point entered was %L.\n" car(pts))
else
println("Point entry aborted.")
)
)
enterPoint( ?prompts
list( "Enter a point.")
?doneProc "pointDone"
)
The prompt Enter a point is displayed on the prompt line. Type the following into the CIW:
2:6
The enterfunction terminates, and doneProc prints out the point:
Point entered was (2.000 6.000).
The enterfunction returns the point:
(2.000 6.000)
Related Topics
User Entry Functions
hiCreateOptionsForm
undrawEnterFun
hiGetCurrentCmd
Return to top
