clear_rectangleclear_rectangleClearRectangleClearRectangle (Operator)

Name

clear_rectangleclear_rectangleClearRectangleClearRectangle — Delete a rectangle on the output window.

Warning

clear_rectangleclear_rectangleClearRectangleClearRectangleClearRectangle is obsolete and is only provided for reasons of backward compatibility.

Signature

clear_rectangle( : : WindowHandle, Row1, Column1, Row2, Column2 : )

Description

clear_rectangleclear_rectangleClearRectangleClearRectangleClearRectangle deletes all entries in the rectangle which is defined through the upper left corner (Row1Row1Row1Row1row1,Column1Column1Column1Column1column1) and the lower right corner (Row2Row2Row2Row2row2,Column2Column2Column2Column2column2). Deletion means that the specified rectangle is set to the background color (see open_windowopen_windowOpenWindowOpenWindowOpenWindow).

If you want to delete more than one rectangle, you may pass several rectangles, i.e., the parameters Row1Row1Row1Row1row1, Column1Column1Column1Column1column1, Row2Row2Row2Row2row2 and Column2Column2Column2Column2column2 are tuples.

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 → (integer)

Window handle.

Row1Row1Row1Row1row1 (input_control) rectangle.origin.y(-array) → (integer)

Line index of upper left corner.

Default value: 10

Typical range of values: 0 ≤ Row1 Row1 Row1 Row1 row1 ≤ 511 (lin)

Minimum increment: 1

Recommended increment: 1

Column1Column1Column1Column1column1 (input_control) rectangle.origin.x(-array) → (integer)

Column index of upper left corner.

Default value: 10

Typical range of values: 0 ≤ Column1 Column1 Column1 Column1 column1 ≤ 511 (lin)

Minimum increment: 1

Recommended increment: 1

Row2Row2Row2Row2row2 (input_control) rectangle.corner.y(-array) → (integer)

Row index of lower right corner.

Default value: 118

Typical range of values: 0 ≤ Row2 Row2 Row2 Row2 row2 ≤ 511 (lin)

Minimum increment: 1

Recommended increment: 1

Restriction: Row2 > Row1

Column2Column2Column2Column2column2 (input_control) rectangle.corner.x(-array) → (integer)

Column index of lower right corner.

Default value: 118

Typical range of values: 0 ≤ Column2 Column2 Column2 Column2 column2 ≤ 511 (lin)

Minimum increment: 1

Recommended increment: 1

Restriction: Column2 >= Column1

Example (HDevelop)

* Erase a rectangle in the output window interactively:
draw_rectangle1(WindowHandle,L1,C1,L2,C2)
clear_rectangle(WindowHandle,L1,C1,L2,C2)

Example (C)

/* Erase a rectangle in the output window interactively: */
draw_rectangle1(WindowHandle,&L1,&C1,&L2,&C2) ;
clear_rectangle(WindowHandle,L1,C1,L2,C2) ;

Example (HDevelop)

* Erase a rectangle in the output window interactively:
draw_rectangle1(WindowHandle,L1,C1,L2,C2)
clear_rectangle(WindowHandle,L1,C1,L2,C2)

Example (HDevelop)

* Erase a rectangle in the output window interactively:
draw_rectangle1(WindowHandle,L1,C1,L2,C2)
clear_rectangle(WindowHandle,L1,C1,L2,C2)

Example (HDevelop)

* Erase a rectangle in the output window interactively:
draw_rectangle1(WindowHandle,L1,C1,L2,C2)
clear_rectangle(WindowHandle,L1,C1,L2,C2)

If an output window exists and the specified parameters are correct clear_rectangleclear_rectangleClearRectangleClearRectangleClearRectangle returns 2 (H_MSG_TRUE). If necessary an exception is raised.