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

hiSetDrawThruDelta

hiSetDrawThruDelta(
x_defaultDelta
[ x_highDelta [ x_mouseButton ] ]
) 
=> t

Description

Sets the default draw-thru delta and, optionally, the high draw-thru delta for mouse buttons 1, 2 or 3.

Arguments

x_defaultDelta

The default draw-thru delta. The default number of pixels that a mouse cursor must travel, with a mouse button held down, to be interpreted as a draw-thru command; if the mouse button is released after the double-click time expires.

The default draw-thru delta cannot be less than 3. If the value passed is less than 3, it automatically resets to 3.

If a default draw-thru value is set that is larger than the current default draw-thru delta and it is larger than any of the high draw-thru deltas current set any high draw-thru delta smaller than the new default delta value gets changed to equal to the new default delta value.

x_highDelta

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

To change a x_highDelta, without changing the x_defaultDelta value, specify 0 for x_defaultDelta.

If x_highDelta is specified, it cannot be less than x_defaultDelta, and resets to the value of the default delta if a lower value is specified.

x_mouseButton

Specifies the mouse button (1, 2, or 3) that x_highDelta is to be applied to.

If this argument is not specified, then x_highDelta is applied to mouse button 1.

If a number other than 1, 2, or 3 is specified, a warning is displayed.

Value Returned

t

Always returns t. If the argument specified is invalid, a warning is also displayed.

Examples

Related Topics

Window Functions

hiGetDrawThruDelta

hiGetDbuPoint

hiOpenWindow


Return to top
 ⠀
X