geCreateHilightSet

geCreateHilightSet( 
d_cellview 
l_layerPurposePair 
[ g_notGlobal ] 
)
=> g_hlSetId / nil 

Description

Creates a highlight set.

The cellview specified by d_cellview must be displayed in a window. The objects are drawn using the layer specified by l_layerPurposePair. The g_notGlobal argument is an optional Boolean argument; if it is not specified, the highlight set is added to the global list of the cellview. If the g_notGlobal argument is equal to t, the highlight is not added to the global list and it must be pushed into the cellview’s highlight stack in order for it be drawn. When the highlight set is first created, it is disabled. The application must enable the set and refresh the window to see the highlight objects.

Arguments

d_cellview	Database ID of the cellview in which to create the highlight set.
l_layerPurposePair
	Layer-purpose pair used to create the highlight objects.
g_notGlobal	Specifies whether the highlight set is added to the global list. Valid Values: t, nil

Value Returned

g_hlSetId	The highlight set is created.
nil	The highlight set is not created.

Examples

Creates a highlight set in cell3 on layer1 with purpose1 and adds the set to the global list.

geCreateHilightSet( cell3 list("layer1" "purpose1") nil )

Related Topics

Highlight Functions

Return to top