geGetDisabledMenus

geGetDisabledMenus(
w_windowId
[ l_menuList ]
)
=> l_disabledMenus

Description

Given a windowId, returns all the inactive submenus for all banner menus on that window. If menuList is specified, only the inactive submenus on those banner menus are returned.

The returned list contains one sub-list for each banner menu specified. Each sublist contains the symbolic names of all the inactive submenus of the banner menu, or nil if the corresponding banner menu does not contain any inactive submenus. If a slider-menu item is inactive, the slider-menu submenus are omitted from the sublist. Each sublist is sorted alphabetically by symbol name.

geGetDisabledMenus is useful for testing a menu inactivation policy such as that implemented by geUpdateWindowMenus.

Arguments

w_windowId	The ID of the window containing the inactive submenus to be listed.
l_menuList	A list of the symbolic names of banner menus or the symbolic name of one banner menu. If specified, only the inactive submenus of the menus in l_menuList are returned.

Value Returned

l_disabledMenus

A list that contains one sublist for each banner menu specified. Each sublist contains the symbolic names of all the inactive submenus of a banner menu. Each sublist is sorted alphabetically. If a banner menu does not have any inactive submenus, the corresponding sublist is nil.

Examples

Returns all the inactive submenus for all banner menus on the window.

windowId = window(2)
=> window:2
deGetRootType(windowId)
=> "maskLayout"
geGetDisabledMenus(windowId)
=> (nil
    (leDesignDescendItem leDesignEditInPlaceItem
     leDesignResetItem leDesignReturnItem
     leDesignReturnToLevelItem leDesignSaveItem
    )
    nil
    (leCreateConicsItem leCreateContactItem leCreateInstItem
     leCreateLabelItem leCreatePathItem leCreatePinItem
     leCreatePolygonItem leCreateRectItem leCreateSymDevItem
    )
    (leEditAttachItem leEditChopItem leEditConnectivityItem
     leEditConvertToPolygonItem leEditDeleteItem
     leEditDeselectAllItem leEditFlattenItem
     leEditMakeCellItem leEditMergeItem leEditReshapeItem
     leEditRotateFigItem leEditSizeItem leEditSplitItem
     leEditStretchItem leModifyCornerItem
    )
    (leVerifyDRCItem leVerifyExtractItem)
    (leMiscLayerGenItem leMiscMoveOriginItem 
     leMiscYankPasteItem)
)

Note that the sub-lists correspond to the banner menus in the Virtuoso tool. Some sub-lists are nil. Sub-lists are sorted alphabetically. The Create – Conics menu containing Circle, Ellipse, and Donut is not included in the Create banner menu sublist because its parent menu, leCreateConicsItem, is disabled.

Related Topics

geUpdateWindowMenus

Automatic Menu Enabling Functions

Return to top