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

hiCreateToolbarTypein

hiCreateToolbarTypein(
?name s_name
[ ?prompt t_prompt ]
[ ?value t_value ]
[ ?tooltip t_tooltip ]
[ ?callback t_callback ]
[ ?editable g_editable ]
[ ?enabled g_enabled ]
[ ?width x_width ]
[ ?statusTip t_statusTip ]
[ ?CBOnEnter g_cbOnEnter ]
)
=> o_typein

Description

Creates a type-in field to be added to the toolbar created using hiCreateToolbar.

Arguments

?name s_name

Symbol specifying the name of the type-in toolbar item. After type-in toolbar item is created, you can change its visibility by setting the invisible property.

?prompt t_prompt

String specifying the prompt (label) for the type-in toolbar item.

?value t_value

The initial value of the type-in toolbar item.

?tooltip t_tooltip

  

The tooltip for the type-in item that appears when the pointer hovers over it.

?callback t_callback

  

Specifies the callback function, which gets triggered when the type-in item value changes.

?editable g_editable

  

t or nil. Specify t if you want the toolbar item to be editable; specify nil if you want it to be read-only. The default value is t.

?enabled g_enabled

  

t or nil. Specify t if you want the toolbar item to be enabled; specify nil if you want it disabled, that is, grayed-out. The default value is t.

?width x_width

Width of the toolbar item.

?statusTip t_statusTip

  

The status text that is displayed in the status bar at the bottom of the window when the mouse hovers over the toolbar item.

?CBOnEnter g_CBOnEnter

  

If specified as a non-nil value, the callback function is triggered when Enter or Return key is pressed in the drop-down list box whether the value entered changes or not. If specified as nil, the callback function is triggered when the value in the drop-down list box changes.

Values Returned

o_typein

Handle to the type-in toolbar item.

Examples

hiCreateToolbarTypein(?name ’typein ?prompt "Account Number" ?value "123" )

Related Topics

Toolbar Functions

hiCreateToolbarComboBox

hiCreateToolbarSeparator

hiInsertToolbarItems


Return to top
 ⠀
X