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

pteSetAllLayerSetMember

pteSetAllLayerSetMember(
[ ?mode { Display | Selection | Propagate } ]
[ ?only { t | nil } ]
[ ?panel { Layers | Objects | Grids } ]
[ ?window w_windowId ]
)
=> t / nil

Description

Sets all specified layer-purpose pairs as members of the layer set that is currently in use.

Arguments

?mode

Scope of execution of the command.

Valid values:

  • Display: Items displayed in the specified Palette panel are set as members of the current layer set. If the parent and child items in the Objects and Grids panels are in the desynchronized state, the membership state is set only for the parent items.
  • Selection: Only the items that are selected in the specified Palette panel are set as members of the current layer set.
    The Selection option is applicable when multi-select mode is selected in Palette Options form or it is enabled using the environment variable pteMultiSelectionMode. This lets you select multiple LPPs in the Layers panel using the CTRL + LMB or Shift + LMB after an initial LMB click on an LPP. The Selection mode in the active command applies to the selected LPPs Layers panel.
  • Propagate: Membership state of both parent and child items is set. Use this mode only if the parent and child items in the Objects and Grids panels are in the desynchronized state.

?only

If set to t, only the items corresponding to the specified mode are set as members of the current layer set.

?panel

Name of the Palette panel.
Valid values: Layers and Objects
Default: The panel that is currently active. If none of the panels is active, the command is run on the Layers panel.

w_windowId

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

Value Returned

t

All specified items were added as members to the layer set currently in use.

nil

The command was unsuccessful.

Examples

pteSetAllLayerSetMember(?panel "Layers")
pteSetAllLayerSetMember(?only t)
pteSetAllLayerSetMember(?mode "Display")
pteSetAllLayerSetMember(?window window(2))
pteSetAllLayerSetMember(?mode "Display" ?only t ?panel "Layers" ?window window(2))

Return to top
 ⠀
X