Product Documentation
Virtuoso Studio Design Environment SKILL Reference
Product Version IC23.1, November 2023

geGetPotentialSelection

geGetPotentialSelection( 
[ w_windowId ]
[ g_ignoreSelect] 
[ l_point]
)
=> ((d_figId l_path) g_isAllSelected [l_selArray]) / nil

Description

Returns the figure ID of the object which can be selected, hierarchical path of the figure, and indicates if the figure is fully or partially selected.

If the boolean g_ignoreSelect is set, the current selection state is ignored.

Arguments

w_windowId

Window ID of the window to use.

g_ignoreSelect

Boolean which indicates if the current selection state should be ignored.

l_point

The point to potentially select.

Value Returned

(d_figId l_path)

ID of the figure and hierarchical path of the figure at the specified point.

g_isAllSelected

When t, indicates if the figure is fully selected. nil indicates partially selected.

[l_selArray]

If the figure is partially selected, indicates which figure points are selected.

nil

The function failed.

Examples

geGetPotentialSelection(window(3) t 10:40)

Related Topics

Selection Functions


Return to top
 ⠀
X