Skip to content

clear_drawing_objectClearDrawingObjectClearDrawingObjectclear_drawing_objectT_clear_drawing_object🔗

Short description🔗

clear_drawing_objectClearDrawingObjectClearDrawingObjectclear_drawing_objectT_clear_drawing_object — Delete drawing object.

Signature🔗

clear_drawing_object( drawing_object DrawID )void ClearDrawingObject( const HTuple& DrawID )static void HOperatorSet.ClearDrawingObject( HTuple drawID )def clear_drawing_object( draw_id: HHandle ) -> None

Herror T_clear_drawing_object( const Htuple DrawID )

void HDrawingObject::ClearDrawingObject( ) const

void HDrawingObject.ClearDrawingObject( )

Description🔗

This operator deletes the drawing object DrawIDdrawIDdraw_id. The object is automatically detached from the windows to which it had been previously attached. After calling clear_drawing_objectClearDrawingObject the draw object can no longer be used.

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.

This operator modifies the state of the following input parameter:

During execution of this operator, access to the value of this parameter must be synchronized if it is used across multiple threads.

Parameters🔗

DrawIDdrawIDdraw_id (input_control, state is modified) drawing_object → (handle)HTuple (HHandle)HDrawingObject, HTuple (IntPtr)HHandleHtuple (handle)

Handle of the drawing object.

Result🔗

clear_drawing_objectClearDrawingObject returns 2 (H_MSG_TRUE) if the DrawIDdrawIDdraw_id is valid. Otherwise an exception is raised.

Combinations with other operators🔗

Combinations

Possible predecessors

create_drawing_object_rectangle1CreateDrawingObjectRectangle1, create_drawing_object_rectangle2CreateDrawingObjectRectangle2, create_drawing_object_ellipseCreateDrawingObjectEllipse, create_drawing_object_circle_sectorCreateDrawingObjectCircleSector, create_drawing_object_ellipse_sectorCreateDrawingObjectEllipseSector, create_drawing_object_xldCreateDrawingObjectXld, create_drawing_object_lineCreateDrawingObjectLine, create_drawing_object_circleCreateDrawingObjectCircle, create_drawing_object_textCreateDrawingObjectText, detach_drawing_object_from_windowDetachDrawingObjectFromWindow, attach_drawing_object_to_windowAttachDrawingObjectToWindow

Possible successors

clear_windowClearWindow, close_windowCloseWindow

See also

create_drawing_object_rectangle1CreateDrawingObjectRectangle1, create_drawing_object_rectangle2CreateDrawingObjectRectangle2, create_drawing_object_ellipseCreateDrawingObjectEllipse, create_drawing_object_circle_sectorCreateDrawingObjectCircleSector, create_drawing_object_ellipse_sectorCreateDrawingObjectEllipseSector, create_drawing_object_xldCreateDrawingObjectXld, create_drawing_object_lineCreateDrawingObjectLine, create_drawing_object_circleCreateDrawingObjectCircle, create_drawing_object_textCreateDrawingObjectText

Module🔗

Foundation