Product Documentation
Virtuoso Layout Suite SKILL Reference
Product Version IC23.1, November 2023

pteSetOptionString

pteSetOptionString(
t_envName
t_envValue
[ w_windowId ]
)
=> t / nil

Description

Changes the state of a Palette environment variable during a Virtuoso session.

Arguments

t_envName

Name of the Palette environment variable.
Valid values: pteFindModeOn, pteMultiSelectionMode, pteAutoRedrawMode, pteWindowSynchronizationMode, pteAllLayersScope, pteCheckableColumnClickMode, pteLayerSetManagerLeftClickMode, pteLayerSetActivationMode, pteUsedLayersEipScope, pteInverseColorScheme, pteMovableTools, pteApplyParentState, pteRoutingOnlyScope, pteUsedOnlyScope, pteValidOnlyScope, pteLayersVisibilityDepth, pteLayersSelectabilityDepth, pteLinkColorVisibilityToShapeVisibility, pteColorMixedSort, and pteCompactMPT

A change to the following environment variables is propagated to open windows in real time: pteMultiSelectionMode, pteCheckableColumnClickMode, pteLayerSetManagerLeftclickMode, pteAllLayersScope, pteUsedLayersEipScope, pteInverseColorScheme, pteMovableTools, pteApplyParentState, pteLayersVisibilityDepth, pteLayersSelectabilityDepth, pteLinkColorVisibilityToShapeVisibility, pteColorMixedSort, and pteCompactMPT. Other environment variables are evaluated only when a new window is opened.

t_envValue

Value of the Palette environment variable to be set.

w_windowId

ID of the window containing the Palette that you want to update.
Valid values: ID of any open window

Value Returned

t

The specified value was assigned to the Palette environment variable.

nil

The command was unsuccessful.

Examples

pteSetOptionString("pteFindModeOn" "t")
pteSetOptionString("pteFindModeOn" "nil")
pteSetOptionString("pteMultiSelectionMode" "t")
pteSetOptionString("pteMultiSelectionMode" "nil")
pteSetOptionString("pteAutoRedrawMode" "noWindow")
pteSetOptionString("pteAutoRedrawMode" "allWindows")
pteSetOptionString("pteAutoRedrawMode" "currentWindow")
pteSetOptionString("pteWindowSynchronizationMode" "independent")
pteSetOptionString("pteWindowSynchronizationMode" "synchronized")
pteSetOptionString("pteAllLayersScope" "techfileLayers")
pteSetOptionString("pteAllLayersScope" "lswLayers")
pteSetOptionString("pteCheckableColumnClickMode" "sort")
pteSetOptionString("pteCheckableColumnClickMode" "turnOnOff")
pteSetOptionString("pteLayerSetManagerLeftClickMode" "forceVisibilityAndSelectabilityOnly")
pteSetOptionString("pteLayerSetManagerLeftClickMode" "activateLayerSet")
pteSetOptionString("pteLayerSetActivationMode" "filterAndApply")
pteSetOptionString("pteLayerSetActivationMode" "filterOnly")
pteSetOptionString("pteUsedLayersEipScope" "topToBottom")
pteSetOptionString("pteUsedLayersEipScope" "currentToBottom")
pteSetOptionString("pteInverseColorScheme" "t")
pteSetOptionString("pteInverseColorScheme" "nil")
pteSetOptionString("pteMovableTools" "t")
pteSetOptionString("pteMovableTools" "nil")
pteSetOptionString("pteApplyParentState" "t")
pteSetOptionString("pteApplyParentState" "nil")
pteSetOptionString("pteRoutingOnlyScope" "t")
pteSetOptionString("pteRoutingOnlyScope" "nil")
pteSetOptionString("pteUsedOnlyScope" "t")
pteSetOptionString("pteUsedOnlyScope" "nil")
pteSetOptionString("pteValidOnlyScope" "t")
pteSetOptionString("pteValidOnlyScope" "nil")
pteSetOptionString("pteLayersVisibilityDepth" "5")
pteSetOptionString("pteLayersSelectabilityDepth" "4")
pteSetOptionString("pteLinkColorVisibilityToShapeVisibility" "t")
pteSetOptionString("pteLinkColorVisibilityToShapeVisibility" "nil")
pteSetOptionString("pteColorMixedSort" "t")
pteSetOptionString("pteColorMixedSort" "nil")
pteSetOptionString("pteCompactMPT" "t")
pteSetOptionString("pteCompactMPT" "nil")

Return to top
 ⠀
X