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

hiCreateToolbar

hiCreateToolbar(
?name s_name
[ ?title t_title ]
[ ?toolButtonStyle s_buttonStyle ]
[ ?toolTip t_toolTip ]
[ ?items l_toolbarItems ]
[ ?invisible g_invisible ]
[ ?contextMenuItems l_contextMenuItems ]
)
=> o_hiToolbar

Description

Creates a toolbar that you can add to windows and session windows. A toolbar is a container object that can contain combo boxes, type-in items, actions, and separators.

Arguments

?name s_name

Symbol specifying a name for the toolbar. You can reference the toolbar with this symbol in the following way:

windowID->hiToolbars->name

?title t_title

Title of the toolbar that is displayed in the session window’s popup menu. If you do not specify a title, s_name is used.

?toolButtonStyle s_buttonStyle

  

One of the following symbols specifying the style of the toolbar buttons: ’textOnly, ’iconOnly, ’textBesideIcon, or ’textUnderIcon.

Default value: ’iconOnly.

?toolTip t_toolTip

  

Specifies the tooltip, which is displayed whenever the cursor hovers over the toolbar.

?items l_toolbarItems

  

List of items to be displayed in the toolbar; return value of hiCreateAction, hiCreateToolbarComboBox, hiCreateToolbarTypein, or hiCreateToolbarSeparator. The items appear in the order in which they are listed.

?invisible g_invisible

  

t or nil. Specify t if you want the toolbar to be invisible initially; specify nil if you want it to be displayed. The default value is nil.

You can modify the value of this argument after the toolbar is created with the invisible property. For example:

windowId->hiToolbars->toolbarName->invisible = nil

?contextMenuItems l_contextMenuItems

  

List of menu items to populate the context menu.

Values Returned

o_hiToolbar

Handle to the toolbar.

Example

ComboItem=hiCreateToolbarComboBox(
    ?name ’comboItem
    ?value "DesignA"
    ?items list ( "DesignA" "DesignB" "DesignC" )
    ?editable t )
toolbar=hiCreateToolbar( ?name ’toolbar ?title "My Designs" ?items list (ComboItem ) )
w=hiCreateWindow( ’default "graphics" "Test Window" )
hiPlaceToolbar( w toolbar ’top )
hiDisplayWindow(w)

Related Topics

Toolbar Functions

hiPlaceToolbar

hiInsertToolbar

hiShowToolbar

hiSetToolbarObjName


Return to top
 ⠀
X