Herror ::set_line_width (
    const HTuple &WindowHandle,
    const HTuple &Width
)
void HWindow::SetLineWidth (
    const HTuple &Width
) const

Define the line width for region contour output.

::set_line_width defines the line width (in pixel) in which a region contour is displayed (e.g. with ::disp_region, ::disp_line, ::disp_polygon, etc.) The procedure ::get_line_width returns the current value for the window. Some output devices may not allow to change the contour width. If it is possible for the current device, it can be queried with ::query_line_width.


Attention

The line width is important if the output mode was set to 'margin' (see ::set_draw). If the line width is greater than one, regions may not always be displayed correctly.


Parameters

WindowHandle (input_control)
window -> HTuple.long
Window_id.

Width (input_control)
integer -> HTuple.long
Line width for region output in contour mode.
Default value: 1
Restriction: (Width >= 1) && (Width <= 2000)


Result

::set_line_width returns H_MSG_TRUE if the parameter is correct and the window is valid. Otherwise an exception handling is raised.


Possible Predecessors

::query_line_width, ::get_line_width


Possible Successors

::disp_region


See also

::get_line_width, ::query_line_width, ::set_draw, ::disp_region


Module

System



Copyright © 1996-2002 MVTec Software GmbH