clear_rectangleT_clear_rectangleClearRectangleClearRectangle (Operator)
Name
clear_rectangleT_clear_rectangleClearRectangleClearRectangle — Delete a rectangle on the output window.
Warning
clear_rectangleclear_rectangleClearRectangleClearRectangleClearRectangle is obsolete and is only provided for
reasons of backward compatibility.
Signature
void ClearRectangle(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
void HWindow::ClearRectangle(Hlong Row1, Hlong Column1, Hlong Row2, Hlong Column2) const
static void HOperatorSet.ClearRectangle(HTuple windowHandle, HTuple row1, HTuple column1, HTuple row2, HTuple column2)
void HWindow.ClearRectangle(HTuple row1, HTuple column1, HTuple row2, HTuple column2)
void HWindow.ClearRectangle(int row1, int column1, int row2, int 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 → HWindow, HTupleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)
Window handle.
Row1Row1Row1Row1row1 (input_control) rectangle.origin.y(-array) → HTupleHTupleHtuple (integer) (int / long) (Hlong) (Hlong)
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) → HTupleHTupleHtuple (integer) (int / long) (Hlong) (Hlong)
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) → HTupleHTupleHtuple (integer) (int / long) (Hlong) (Hlong)
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) → HTupleHTupleHtuple (integer) (int / long) (Hlong) (Hlong)
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)
Example (C)
/* Erase a rectangle in the output window interactively: */
draw_rectangle1(WindowHandle,&L1,&C1,&L2,&C2);
Example (HDevelop)
* Erase a rectangle in the output window interactively:
draw_rectangle1(WindowHandle,L1,C1,L2,C2)
Example (HDevelop)
* Erase a rectangle in the output window interactively:
draw_rectangle1(WindowHandle,L1,C1,L2,C2)
Example (HDevelop)
* Erase a rectangle in the output window interactively:
draw_rectangle1(WindowHandle,L1,C1,L2,C2)
Result
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.
Possible Predecessors
open_windowopen_windowOpenWindowOpenWindowOpenWindow,
set_drawset_drawSetDrawSetDrawSetDraw,
set_colorset_colorSetColorSetColorSetColor,
set_coloredset_coloredSetColoredSetColoredSetColored,
set_line_widthset_line_widthSetLineWidthSetLineWidthSetLineWidth,
set_rgbset_rgbSetRgbSetRgbSetRgb,
set_hsiset_hsiSetHsiSetHsiSetHsi,
draw_rectangle1draw_rectangle1DrawRectangle1DrawRectangle1DrawRectangle1
Alternatives
clear_windowclear_windowClearWindowClearWindowClearWindow,
disp_rectangle1disp_rectangle1DispRectangle1DispRectangle1DispRectangle1
See also
open_windowopen_windowOpenWindowOpenWindowOpenWindow
Module
Foundation