set_iconset_iconset_iconSetIconSetIcon (Operator)

Name

set_iconset_iconset_iconSetIconSetIcon — Icon definition for region output.

Signature

Description

set_iconset_iconset_iconSetIconSetIcon defines an icon for region output (disp_regiondisp_regiondisp_regionDispRegionDispRegion). It is displayed in the regions center of gravity. The use of this icon is activated with set_shapeset_shapeset_shapeSetShapeSetShape.

Parallelization

• Multithreading type: reentrant (runs in parallel with non-exclusive operators).
• Multithreading scope: global (may be called from any thread).
• Processed without parallelization.

Parameters

Example (C)

/* draw a region and an icon */
draw_region(&Region,WindowHandle) ;
draw_region(&Icon,WindowHandle) ;
set_icon(Icon) ;
set_shape(WindowHandle,"icon") ;
disp_region(Region,WindowHandle) ;

Result

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

Possible Predecessors

gen_circlegen_circlegen_circleGenCircleGenCircle, gen_ellipsegen_ellipsegen_ellipseGenEllipseGenEllipse, gen_rectangle1gen_rectangle1gen_rectangle1GenRectangle1GenRectangle1, gen_rectangle2gen_rectangle2gen_rectangle2GenRectangle2GenRectangle2, draw_regiondraw_regiondraw_regionDrawRegionDrawRegion

Possible Successors

set_shapeset_shapeset_shapeSetShapeSetShape, disp_regiondisp_regiondisp_regionDispRegionDispRegion

Module

Foundation