Skip to content

set_line_styleSetLineStyleSetLineStyleset_line_styleT_set_line_style🔗

Short description🔗

set_line_styleSetLineStyleSetLineStyleset_line_styleT_set_line_style — Define a contour output pattern.

Signature🔗

set_line_style( window WindowHandle, integer Style )void SetLineStyle( const HTuple& WindowHandle, const HTuple& Style )static void HOperatorSet.SetLineStyle( HTuple windowHandle, HTuple style )def set_line_style( window_handle: HHandle, style: Sequence[int] ) -> None

Herror T_set_line_style( const Htuple WindowHandle, const Htuple Style )

void HWindow::SetLineStyle( const HTuple& Style ) const

void HWindow.SetLineStyle( HTuple style )

Description🔗

set_line_styleSetLineStyle defines the output pattern of the margin of regions and of XLD contours. The information is used by operators like disp_regionDispRegion, disp_lineDispLine, disp_polygonDispPolygon etc. The current value can be queried with get_line_styleGetLineStyle. Stylestylestyle 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🔗

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🔗

WindowHandlewindowHandlewindow_handle (input_control) window → (handle)HTuple (HHandle)HWindow, HTuple (IntPtr)HHandleHtuple (handle)

Window handle.

Stylestylestyle (input_control) integer-array → (integer)HTuple (Hlong)HTuple (int / long)Sequence[int]Htuple (Hlong)

Contour pattern.

Default: [][]
Value range: 1 ≤ 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,[])
(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)\;

Result🔗

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

Combinations with other operators🔗

Combinations

Possible predecessors

get_line_styleGetLineStyle

Possible successors

disp_regionDispRegion

See also

get_line_styleGetLineStyle, set_line_approxSetLineApprox, disp_regionDispRegion

Module🔗

Foundation