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

hiGetDrawThruDelta

hiGetDrawThruDelta( 
[ g_detail ]
) 
=> x_defaultDelta / ( x_defaultDelta ( x_highButton1Delta x_highButton2Delta x_highButton3Delta ) )

Description

When no argument is presented, or if the g_detail argument is nil, returns the default draw-thru delta.

The draw-thru delta being the number of pixels that a mouse cursor must travel, with the mouse-button pressed, in order to be interpreted as a draw-thru command; if the mouse is released after double-click time expires. If the g_detail argument is non-nil, then the return value is a list, where the first member is the default draw-thru delta, and the second member is the list of high draw-thru deltas for mouse buttons 1, 2, and 3, respectively.

A high draw-thru delta is the distance that the mouse cursor must move, in pixels, to be interpreted as a draw-thru command, if the times between the mouse-button press and the mouse-button release, is less than the double-click time.

Argument

g_detail

Optional argument which creates a list to be returned if results are non-nil. This list consists of the old delta value first, followed by the pre-timeout delta value second.

Values Returned

x_defaultDelta

The default draw-thru delta value.

x_highButton1Delta

The draw-thru delta value for mouse button 1.

x_highButton2Delta

The draw-thru delta value for mouse button 2.

x_highButton3Delta

The draw-thru delta value for mouse button 3.

Related Topics

Related Topics

Window Functions

hiOpenWindow

hiGetDbuPoint


Return to top
 ⠀
X