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

hiCreateToolbarComboBox

hiCreateToolbarComboBox(
?name s_name
?items l_items
[ ?prompt t_prompt ]
[ ?value t_value ]
[ ?toolTip t_tooltip ]
[ ?callback t_callback ]
[ ?editable g_editable ]
[ ?iconFile t_iconFile ]
[ ?enabled g_enabled ]
[ ?width x_width ]
[ ?statusTip t_statusTip ]
[ ?CBOnEnter g_cbOnEnter ]
[ ?focusInCallback g_focusInCallback ]
)
=> o_comboBox

Description

Creates a drop-down list box item (popularly called a combo box) to be added to the toolbar created using hiCreateToolbar. The drop-down list box has a type-in field as well as a drop-down list. You can either type in a value or select an item from the list.

Arguments

?name s_name

Symbol specifying the name of the toolbar drop-down list box. After drop-down list box item is created, you can change its visibility by setting the invisible property. For example, to hide workspace drop-down list box in the workspaces toolbar: (deFindToolbar "Workspaces" swindow(1))->deWorkspacesCombo->invisible=t"

?items l_items

List of strings that represent the choices in the drop-down list.

?prompt t_prompt

String specifying the prompt (label) for the combination box.

?value t_value

The initial value of the combination box.

?toolTip t_tooltip

  

The tooltip for the combo box that appears when the pointer hovers over it.

?callback t_callback

  

Specifies the callback function, which gets triggered when the combination box value changes.

?editable g_editable

  

Edits the combination box. Specify nil if you want it to be read-only. The default value is t.

?iconFile t_iconFile

Specifies the name of the icon file.

?enabled g_enabled

  

Enables the combination box. Specify nil if you want it disabled, that is, grayed-out. The default value is t.

?width x_width

Width of the combination box.

?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 combination box.

?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.

?focusInCallback g_focusInCallback

  

SKILL function to be executed whenever the field comes into focus, specifically when the type-in part of the field comes into focus. This happens either when you click in the type-in part of the field or when you dismiss the drop-down list, which shifts the focus to the type-in part of the field.The callback can be of string, symbol, or function object type.

Values Returned

o_comboBox

Handle to the toolbar combination box.

Examples

ComboItem = hiCreateToolbarComboBox(
    ?name ’comboItem
    ?value "DesignA"
    ?items list ( "DesignA" "DesignB" "DesignC" )
    ?editable t )
toolbar = hiCreateToolbar( ?name ’toolbar ?title "My Designs" ?items list ( ComboItem ) )

Related Topics

Toolbar Functions

hiCreateToolbarTypein

hiCreateToolbarSeparator

hiAddToolbarItems

hiInsertToolbarItems


Return to top
 ⠀
X