get_drawT_get_drawGetDrawGetDrawget_draw (Operator)

Name

get_drawT_get_drawGetDrawGetDrawget_draw — Get the current region fill mode.

Signature

get_draw( : : WindowHandle : Mode)

Description

get_drawget_drawGetDrawGetDrawGetDrawget_draw returns the region fill mode of the output window. It is used by operators as disp_regiondisp_regionDispRegionDispRegionDispRegiondisp_region, disp_circledisp_circleDispCircleDispCircleDispCircledisp_circle, disp_arrowdisp_arrowDispArrowDispArrowDispArrowdisp_arrow, disp_rectangle1disp_rectangle1DispRectangle1DispRectangle1DispRectangle1disp_rectangle1, disp_rectangle2disp_rectangle2DispRectangle2DispRectangle2DispRectangle2disp_rectangle2 etc. The region fill mode is set with set_drawset_drawSetDrawSetDrawSetDrawset_draw.

Execution Information

Multithreading type: reentrant (runs in parallel with non-exclusive operators).
Multithreading scope: global (may be called from any thread).
Processed without parallelization.

Parameters

WindowHandleWindowHandleWindowHandleWindowHandlewindowHandlewindow_handle (input_control) window → (handle)

Window handle.

ModeModeModeModemodemode (output_control) string → (string)

Current region fill mode.

Result

get_drawget_drawGetDrawGetDrawGetDrawget_draw returns 2 (H_MSG_TRUE), if the window is valid. Otherwise an exception is raised.

Possible Successors

set_drawset_drawSetDrawSetDrawSetDrawset_draw, disp_regiondisp_regionDispRegionDispRegionDispRegiondisp_region

See also

set_drawset_drawSetDrawSetDrawSetDrawset_draw, disp_regiondisp_regionDispRegionDispRegionDispRegiondisp_region, set_paintset_paintSetPaintSetPaintSetPaintset_paint

Module

Foundation