set_iconT_set_iconSetIconSetIcon (Operator)

Name

set_iconT_set_iconSetIconSetIcon — Icon definition for region output.

Signature

set_icon(Icon : : WindowHandle : )

Description

set_iconset_iconSetIconSetIconSetIcon defines an icon for region output (disp_regiondisp_regionDispRegionDispRegionDispRegion). It is displayed in the regions center of gravity. The use of this icon is activated with set_shapeset_shapeSetShapeSetShapeSetShape.

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

IconIconIconIconicon (input_object) region → object

Icon for center of gravity.

WindowHandleWindowHandleWindowHandleWindowHandlewindowHandle (input_control) window → (handle)

Window handle.

Example (C)

/* draw a region and an icon */
T_draw_region(&Region,WindowHandle);
T_draw_region(&Icon,WindowHandle);
set_icon(Icon);
create_tuple_s(&icon,"icon");
T_set_shape(WindowHandle,icon);
destroy_tuple(icon);
T_disp_region(Region,WindowHandle);

Result

set_iconset_iconSetIconSetIconSetIcon returns 2 (H_MSG_TRUE), if exactly one region is supplied. Otherwise an exception is raised.

Possible Predecessors

gen_circlegen_circleGenCircleGenCircleGenCircle, gen_ellipsegen_ellipseGenEllipseGenEllipseGenEllipse, gen_rectangle1gen_rectangle1GenRectangle1GenRectangle1GenRectangle1, gen_rectangle2gen_rectangle2GenRectangle2GenRectangle2GenRectangle2, draw_regiondraw_regionDrawRegionDrawRegionDrawRegion

Possible Successors

set_shapeset_shapeSetShapeSetShapeSetShape, disp_regiondisp_regionDispRegionDispRegionDispRegion

Module

Foundation

Operators