gpeGetGridSelection

gpeGetGridSelection(
u_sandbox
[ ?verbose { t | nil } ]
)
=> l_gridSelection / nil

Description

Returns a list of indexes that represent the grid selection in the GPE (Grid Pattern Editor) assistant. The DPL is a list of list of indexes, for example ((0 1) (1 3) ... ), that are associated with the specified userType (UT).

Arguments

u_sandbox	Specifies the Modgen sandbox object.
`?verbose` { `t` \| `nil` }
	Controls the display of warning messages.

Value Returned

l_gridSelection	Returns a list of indexes that represent the grid selection in the associated GPE.
`nil`	The command was unsuccessful.

Example

In the following example, the value of sb is determined by calling gpeEditSandbox. This value is then passed as argument for gpeGetGridSelection. The return value is a list of grid selections that include indexes from (1 4) to (1 7), indexes from (0 5) to (0 7), grid cell in (0 2), and grid cell in (1 1).

sb = gpeEditSandbox(s)

selection = gpeGetGridSelection(sb)

( ((1 4) (1 7)) ((0 5) (0 7)) (0 2) (1 1) )

Return to top

Virtuoso Layout Suite SKILL ReferenceProduct Version IC23.1, November 2023