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

ddHiCreateViewToolbarComboBox

ddHiCreateViewToolbarComboBox(
?name s_name 
[ ?prompt t_prompt ] 
[ ?value t_currentValue ]
[ ?callback g_callback ]
[ ?editable g_editable ]
[ ?enabled g_enabled ]
[ ?width x_width ]
[ ?statusTip t_statusTip ]
[ ?toolTip t_toolTip ] 
[ ?viewTypes l_viewTypes ]
[ ?validationType g_validationType ] 
[ ?highlightType g_highlightType ] 
) 
=> o_comboBox

Description

Creates a customized View combo-toolbar item, which is an extension of a regular toolbar combo box item, for selecting views.

Arguments

?name s_name

A handle to this combo box within a form. To reference it, use toolbarHandle-><name>

?prompt t_prompt

  

A string specifying the prompt for the combo box. To reference it, use toolbarHandle-><name>->prompt

?value t_currentValue

  

The initial and current values of this combo box. To reference it, use toolbarHandle-><name>->value

?callback g_callback

  

A string, symbol, or function object type callback that is executed if the value of the combo box changes. If a new value is typed in, the callback is called when the combo box has “lost focus”. This happens for example, when you move the pointer outside the toolbar, or tab to another widget.

If a new value is selected from the drop-down list, then the callback is called immediately, not when the combo box loses focus.

If the callback is of string type, you can specify one or more SKILL functions or even multiple SKILL statements that get executed when the value of the combo box changes.

?editable g_editable

  

If set to nil, the combo box is read-only; setting g_editable to t makes the combo box editable.

?enabled g_enabled

  

Specifies whether the combo box is enabled. The default value is t.

?width x_width

The width of the combo box.

?statusTip t_statusTip

  

Displays the status text in the status bar at the bottom of the window when the pointer hovers over the combo box.

?toolTip t_toolTip

  

The tool tip that is displayed when the pointer hovers over the combo box.

?viewTypes l_viewTypes

  

A list of DFII view types (string). The list is used for view-type based filtering in the view combo-box widget. A view is made available for selection only if the view type associated with its master file is a member of the l_viewTypes list.

?validationType g_validationType

  

Specifies the criteria that determines if the input is valid or not. Acceptable values (symbol) are:

allowAny: No restriction on input type.

allowExisting (default): Allow existing unfiltered data returned by (DDPI) generator.

allowNew: Allow data other than the return value of (DDPI) generator.

?highlightType g_highlightType

  

Specifies when and how a widget is to be highlighted. Acceptable values (symbol) are:

background

highlight

error

highlightInvalidText (default)

The first three values have the same definitions as given for the g_highlighType argument of hiHighlightField.

Setting the property to highlightInvalidText turns on automatic highlighting, which highlights the widget when an invalid input is entered. The validity of the input is determined based on the setting of the validationType property.

Value Returned

o_comboBox

Returns the view combo-toolbar item.

Examples

A view combo-toolbar item is created.

trCellItem = ddHiCreateViewToolbarcomboBox(
    ?name 'cellItem
    ?prompt "Cell" 
    ?viewTypes ( list "schematicSymbol" "schematic" )
    )

Related Topics

Toolbar Functions

hiHighlightField

ddHiCreateViewComboField


Return to top
 ⠀
X