pteSetLSActive

pteSetLSActive(
?layerSets t_layerSets
?turnOnVis { t | nil }
?turnOnSel { t | nil }
?turnOffAllVis { t | nil }
?turnOffAllSel { t | nil }
?deactivateOthers { t | nil }
[ w_windowId ]
)
=> t / nil

Description

Activates one or more layer sets and can be used to force the visibility and selectability of the layer-purpose pairs contained in those layer sets. The visibility and selectability of layer-purpose pairs contained in layer sets previously set as active is affected only if the visibility or selectability of layer-purpose pairs contained in the layer set being set as active is forced.

This function is most useful when you want to activate a layer set without deactivating the layer sets previously set as active.

Arguments

?layerSets t_layerSets
	List of layer sets to be activated.
?turnOnVis	If set to t, forces the visibility of all layer-purpose pairs in the specified layer sets. If set to nil, visibility of layer-purpose pairs in the layer sets being set as active remains unchanged. Default: nil
?turnOnSel	If set to t, forces the selectability of all layer-purpose pairs in the specified layer sets. If set to nil, selectability of layer-purpose pairs in the layer sets being set as active remains unchanged. Default: nil
?turnOffAllVis	If set to t, turns off the visibility of all layer-purpose pairs contained in the layer sets previously set as active. If set to nil, the visibility of layer-purpose pairs contained in such layer sets remains unchanged. Default: nil
?turnOffAllSel	If set to t, turns off the selectability of all layer-purpose pairs contained in the layer sets previously set as active. If set to nil, the selectability of layer-purpose pairs contained in such layer sets remains unchanged. Default: nil
?deactivateOthers	If set to t, sets as inactive all layer sets previously set as active. If set to nil, the layer sets previously set as active do not become inactive. Default: nil
w_windowId	ID of the window containing the Palette in which you want to set a layer set as active. Default: Current window

Value Returned

t	The specified layer sets were activated.
nil	The command was unsuccessful.

Examples

The following example activates layer set LS1:

pteSetLSActive(?layerSets "LS1" ?turnOnVis nil ?turnOnSel nil ?turnOffAllVis nil ?turnOffAllSel nil ?deactivateOthers t)

The following example, adds layer set LS1 to the list of active layer sets, that is, the layer sets previously set as active do not become inactive, and forces the visibility and selectability of all layer-purpose pairs contained in it. The visibility of layer-purpose pairs contained in layer sets previously set as active remains unchanged; selectability is turned off.

pteSetLSActive(?layerSets "LS1" ?turnOnVis t ?turnOnSel t ?turnOffAllVis nil ?turnOffAllSel t ?deactivateOthers nil)

The following example, adds layer set LS1 to the list of active layer sets, that is, the layer sets previously set as active do not become inactive, and forces the visibility and selectability of all layer-purpose pairs contained in it. The visibility and selectability of layer-purpose pairs contained in layer sets previously set as active are turned off.

pteSetLSActive(?layerSets "LS1" ?turnOnVis t ?turnOnSel t ?turnOffAllVis t ?turnOffAllSel t ?deactivateOthers nil)

The following example, adds layer set LS1 to the list of active layer sets, that is, the layer sets previously set as active do not become inactive, and keeps the visibility and selectability of the layer-purpose pairs contained in LS1 unchanged. The visibility and selectability of layer-purpose pairs contained in layer sets previously set as active also remain unchanged.

pteSetLSActive(?layerSets "LS1" ?turnOnVis nil ?turnOnSel nil ?turnOffAllVis t ?turnOffAllSel t ?deactivateOthers nil)

The following example, adds layer set LS1 to the list of active layer sets, that is, the layer sets previously set as active do not become inactive, and forces the visibility of all layer-purpose pairs contained in it. The visibility of layer-purpose pairs contained in layer sets previously set as active is turned off; selectability remains unchanged.

pteSetLSActive(?layerSets "LS1" ?turnOnVis t ?turnOnSel nil ?turnOffAllVis t ?turnOffAllSel t ?deactivateOthers nil)

The following example, adds layer set LS1 to the list of active layer sets, that is, the layer sets previously set as active do not become inactive, and forces the selectability of all layer-purpose pairs contained in it. The selectability of layer-purpose pairs contained in layer sets previously set as active is turned off; visibility remains unchanged.

pteSetLSActive(?layerSets "LS1" ?turnOnVis nil ?turnOnSel t ?turnOffAllVis t ?turnOffAllSel t ?deactivateOthers nil)

Return to top