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

pteSetAllSelectable

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

Description

Sets as selectable the specified items in the specified Palette panel.

Arguments

?mode

Scope of execution of the command.

Valid values:

  • Display: All items displayed in the specified Palette panel are set as selectable. If the parent and child objects in the Objects panel are in a desynchronized state, only the parent items are set as selectable.
  • Selection: Only the items selected in the specified Palette panel are set as selectable.
    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: Both parent and child items in the specified Palette panel are set as selectable. Use this mode only if the parent and child objects in the Objects panel are in a desynchronized state.

?only

If set to t, only the items corresponding to the specified mode are set as selectable.

?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.

?window 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

The specified items were set as selectable.

nil

The command was unsuccessful.

Examples

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

Return to top
 ⠀
X