clear_rectangle

Herror ::clear_rectangle ( const HTuple &WindowHandle, const HTuple &Row1, const HTuple &Column1, const HTuple &Row2, const HTuple &Column2 ) void HWindow::ClearRectangle ( const HTuple &Row1, const HTuple &Column1, const HTuple &Row2, const HTuple &Column2 ) const

Delete a rectangle on the output window.

::clear_rectangle deletes all entries in the rectangle which is defined through the upper left corner (Row1,Column1) and the lower right corner (Row2,Column2). Deletion significates that the specified rectangle is set to the background color (see ::open_window, ::open_textwindow).

If you want to delete more than one rectangle, you may pass several rectangles, i.e. the parameters Row1, Column1, Row2 and Column2 are tupel.

Parameters

`WindowHandle` (input_control)	window `->` HTuple.long
Window identifier.

`Row1` (input_control)	rectangle.origin.y(-array) `->` HTuple.long
Line index of upper left corner.
Default value: 10
Typical range of values: `0 <= Row1 <= 511` (lin)
Minimum increment: 1
Recommended increment: 1

`Column1` (input_control)	rectangle.origin.x(-array) `->` HTuple.long
Column index of upper left corner.
Default value: 10
Typical range of values: `0 <= Column1 <= 511` (lin)
Minimum increment: 1
Recommended increment: 1

`Row2` (input_control)	rectangle.corner.y(-array) `->` HTuple.long
Row index of lower right corner.
Default value: 118
Typical range of values: `0 <= Row2 <= 511` (lin)
Minimum increment: 1
Recommended increment: 1
Restriction: `Row2 > Row1`

`Column2` (input_control)	rectangle.corner.x(-array) `->` HTuple.long
Column index of lower right corner.
Default value: 118
Typical range of values: `0 <= Column2 <= 511` (lin)
Minimum increment: 1
Recommended increment: 1
Restriction: `Column2 >= Column1`

Example

/* "Interactiv" erase of a rectangle in output window */
draw_rectangle1(WindowHandle,&L1,&C1,&L2,&C2) ;
clear_rectangle(WindowHandle,L1,C1,L2,C2) ;

Result

If an ouputwindow exists and the specified parameters are correct ::clear_rectangle returns H_MSG_TRUE. If necessary an exception handling is raised.

Possible Predecessors

::open_window, ::set_draw, ::set_color, ::set_colored, ::set_line_width, ::set_rgb, ::set_hsi, ::draw_rectangle1

Alternatives

::clear_window, ::disp_rectangle1

See also

::open_window, ::open_textwindow

Module

System