set_line_styleT_set_line_styleSetLineStyleSetLineStyle (Operator)

Name

set_line_styleT_set_line_styleSetLineStyleSetLineStyle — Define a contour output pattern.

Signature

set_line_style( : : WindowHandle, Style : )

Description

set_line_styleset_line_styleSetLineStyleSetLineStyleSetLineStyle defines the output pattern of the margin of regions and of XLD contours. The information is used by operators like disp_regiondisp_regionDispRegionDispRegionDispRegion, disp_linedisp_lineDispLineDispLineDispLine, disp_polygondisp_polygonDispPolygonDispPolygonDispPolygon etc. The current value can be queried with get_line_styleget_line_styleGetLineStyleGetLineStyleGetLineStyle. StyleStyleStyleStylestyle contains up to five pairs of values. The first value is the length of the visible contour part, the second is the length of the invisible part. The value pairs are used cyclical for contour output.

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

WindowHandleWindowHandleWindowHandleWindowHandlewindowHandle (input_control) window → (handle)

Window handle.

StyleStyleStyleStylestyle (input_control) integer-array → (integer)

Contour pattern.

Default value: []

Typical range of values: 1 ≤ Style Style Style Style style ≤ 120

Example (HDevelop)

* stroke line: X-Windows
set_line_style(WindowHandle,[20,7])
* point-stroke line: X-Windows
set_line_style(WindowHandle,[20,7,3,7])
* passing line (standard)
set_line_style(WindowHandle,[])

Example (C)

Htuple LineStyle ;

/* stroke line: X-Windows */
create_tuple(&LineStyle,2) ;
set_i(LineStyle,20,0) ;
set_i(LineStyle,7,1) ;
T_set_line_style(WindowHandle,LineStyle) ;
destroy_tuple(LineStyle) ;

/* point-stroke line: X-Windows */
create_tuple(&LineStyle,4) ;
set_i(LineStyle,20,0) ;
set_i(LineStyle,7,1) ;
set_i(LineStyle,3,2) ;
set_i(LineStyle,7,3) ;
T_set_line_style(WindowHandle,LineStyle) ;
destroy_tuple(LineStyle) ;

/* passing line (standard) */
create_tuple(&LineStyle,0) ;
T_set_line_style(WindowHandle,LineStyle) ;
destroy_tuple(LineStyle) ;

Example (HDevelop)

* stroke line: X-Windows
set_line_style(WindowHandle,[20,7])
* point-stroke line: X-Windows
set_line_style(WindowHandle,[20,7,3,7])
* passing line (standard)
set_line_style(WindowHandle,[])

Example (HDevelop)

* stroke line: X-Windows
set_line_style(WindowHandle,[20,7])
* point-stroke line: X-Windows
set_line_style(WindowHandle,[20,7,3,7])
* passing line (standard)
set_line_style(WindowHandle,[])

Example (HDevelop)

* stroke line: X-Windows
set_line_style(WindowHandle,[20,7])
* point-stroke line: X-Windows
set_line_style(WindowHandle,[20,7,3,7])
* passing line (standard)
set_line_style(WindowHandle,[])

Result

set_line_styleset_line_styleSetLineStyleSetLineStyleSetLineStyle returns 2 (H_MSG_TRUE) if the parameter is correct and the window is valid. Otherwise an exception is raised.

Possible Predecessors

get_line_styleget_line_styleGetLineStyleGetLineStyleGetLineStyle

Possible Successors

disp_regiondisp_regionDispRegionDispRegionDispRegion

Module

Foundation

Operators