hiFocusToToolbarItem

hiFocusToToolbarItem(
?toolbar S_toolbar 
?item S_toolbarItem 
[?warpPointer g_warp] 
[?window w_window]
)
=> t / nil

Description

Sets the keyboard focus on a visible, enabled, and editable toolbar type-in or combo item.

Arguments

`?toolbar` S_toolbar
	Specifies the name of a toolbar symbol, a title string, or a tooltip string.
`?item` S_toolbarItem
	Specifies the name symbol of a toolbar item or a tooltip string.
`?warpPointer` g_warp
	When set to `t`, the mouse pointer warps to the field when the focus is set.
`?window w_window`	Specifies the window containing the toolbar. If not specified, the default is the current window. The toolbar and item symbols and string for type-in and combo toolbar items can be listed with the SKILL function `hiListFocusableToolbarItems`.

Value Returned

t

The operation is successful.

nil

The operation fails and a warning is issued when one of the following is true:

An invalid window argument is specified.
The specified toolbar or item cannot be found in the window.
The item specified is not a type-in or combo item.

No warning is issued when the type-in or combo item is found, but is not enabled, editable, or visible.

Example

This function can be used to set a bindkey to quickly modify a toolbar value. The following command sets bindkey Ctrl + S to focus on the Display Stop Level toolbar item in the layout window:

> hiSetBindKey("Layout" "Ctrl<Key>S" "hiFocusToToolbarItem(?toolbar \"Options\" ?item \"Display Stop Level\")")

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