Product Documentation
Cadence User Interface SKILL Reference
Product Version IC23.1, September 2023

hiListFocusableToolbarItems

hiListFocusableToolbarItems( 
[w_window] 
)
=> t / nil

Description

Lists all type-in and combo toolbar items that are currently defined in the specified window and can be used as arguments for the function hiFocusToToolbarItem.

Arguments

w_window

Specifies the window containing the type-in and combo toolbar items. If not specified, the default is the current window.

Value Returned

t

The operation is successful.

nil

The operation fails and a warning is issued if the specified window is invalid.

Examples

The following example shows partial listing from a layout window in which the Display Stop Level toolbar item is not visible due to overlapping of toolbars:

> hiListFocusableToolbarItems()
Toolbar Name/Symbol               Item Name/Symbol                   Type   Editable  Enabled  Visibility
--------------------------------- --------------------------------- ------- --------- -------- 
"Workspaces"                      "Workspace Configuration"         combo      No       Yes    Visible
'deWorkspacesToolbar              'deWorkspacesCombo
--------------------------------- ---------------------------------
"Align"                           "Align Spacing Value"             typein     No       No     Toolbar not visible
'leAlignToolbar                   'leAlignToolbarAlignSpacingValue
                                  ---------------------------------
"Orthogonal Spacing Value" typein     No       No     Toolbar not visible
'leAlignToolbarAlignOrthogonalSpacingValue
--------------------------------- ---------------------------------
"Options"                         "Display Stop Level"              typein     Yes      Yes    Not visible
'lebOptionsToolbar                'lebDisp
=> t

For hiFocusToToolbarItem to work with a Display Stop Level item, the toolbars need to be arranged in such a way that the item is visible. Here, the other three items are either not editable or not enabled. The function does not work with them even if they are made visible.

Related Topics

Toolbar Functions

hiFocusToToolbarItem


Return to top
 ⠀
X