set_icon (Operator)

Name

set_icon — Icon definition for region output.

Synopsis

set_icon(Icon : : WindowHandle : )

Description

set_icon defines an icon for region output (disp_region). It is displayed in the regions center of gravity. The use of this icon is activated with set_shape.

Parameters

Icon (input_object)	region → object
Icon for center of gravity.

WindowHandle (input_control)	window → (integer)
Window_id.

Example (Syntax: 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_icon returns 2 (H_MSG_TRUE) if exactly one region is passed. Otherwise an exception is raised.

Parallelization Information

set_icon is reentrant and processed without parallelization.

Possible Predecessors

gen_circle, gen_ellipse, gen_rectangle1, gen_rectangle2, draw_region

Possible Successors

set_shape, disp_region

Module

Foundation