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

pteSetNoneSelectable

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

Description

Turns off the selectability of the specified items in the specified Palette panel.

Arguments

?mode

Scope of execution of the command.

Valid values:

  • Display: The selectability of all the items displayed in the specified Palette panel is turned off. If the parent and child objects in the Objects panel are in a desynchronized state, the selectability of only the parent items is turned off.
  • Selection: The selectability of only the items selected in the specified Palette panel is turned off.
    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: The selectability of both parent and child items in the specified Palette panel is turned off. Use this mode only if the parent and child objects in the Objects panel are in a desynchronized state.

?only

If set to t, the selectability of only the items corresponding to the specified mode is turned off.

?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 selectability of the specified items was turned off.

nil

The command was unsuccessful.

Examples

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

Return to top
 ⠀
X