Product Documentation

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

Contents

1

Introduction to Cadence User Interface

Bottom-Up Construction

Destroy the User Interface

Cadence User Interface Callback Routines

Callbacks Supported by HI Forms and Fields

Function Object Callbacks

Function Object Callbacks with Additional Arguments

2

Command Interpreter Window

CIW Input Commands

Mouse and Keyboard Inputs

Parse Command Line

Command Output Results

Nesting Commands

General Environmental Functions

hiAddExtraRepeatCommand

hiAddNonRepeatPrefix

hiDisplaySaveForRestoreDialog

hiGetDisplayName

hiGetMouseMoveSampleRate

hiGetMouseStopDetectTime

hiGetMultiClickTime

hiGetNonRepeatPrefixes

hiGetScreenSize

hiGetBannerPoint

hiGetBeepVolume

hiGetCommandPoint

hiGetExtraRepeatCommands

hiGetRepeatCommand

hiInsertBlankCIWOutputPage

hiIsExtraRepeatCommand

hiRemoveExtraRepeatCommand

hiRemoveNonRepeatPrefix

hiSaveForRestore

hiSetBeepVolume

hiSetMouseMoveSampleRate

hiSetMouseStopDetectTime

hiSetMultiClickTime

hiSetUserPreferences

hiSetWindowDefaultPrompt

hiSetWindowFocus

Process Control Functions

Log File Functions

hiGetLogFileName

hiLogDragEvents

hiPrintToLogFile

hiSetFilterOptions

Resource Management Functions

hiGetBBoxResource

hiGetGeometryResource

hiGetStringResource

Text Attribute Functions

Cdsenv Editor Functions

startCdsenvEditor

envCyclicStringToIndex

envCyclicIndexToString

envGetAvailableTools

envGetLoadedTools

envGetModifiedTools

envIsToolModified

envRegLoadDumpTrigger

envRegSetTrigger

envSetToolCurrValToDefault

envSetToolDefaultToCurrVal

envSetVarCurrValToDefault

envSetVarDefaultToCurrVal

envUnregLoadDumpTrigger

envUnregSetTrigger

3

Menu Functions

hiCreateHorizontalFixedMenu

hiCreateMenuItem

hiCreatePulldownMenu

hiCreateSimpleMenu

hiCreateSeparatorMenuItem

hiCreateSliderMenuItem

hiCreateTypeinMenuItem

hiSetTypeinMenuItemCompleterList

hiCreateVerticalFixedMenu

hiDeleteMenuItem

hiDisableMenuItem

hiDisplayFixedMenu

hiDisplayWindowMenu

hiEnableMenuItem

hiFixedMenuDown

hiGetWindowMenu

hiInsertMenuItem

hiIsMenuItemEnabled

hiSetMenuItemCallback

hiSetMenuItemStatusTip

hiSetMenuItemText

hiSetWindowMenu

4

Toolbar Functions

ddHiCreateCellToolbarComboBox

ddHiCreateLibraryToolbarComboBox

ddHiCreateViewToolbarComboBox

hiAddToolbarItem

hiAddToolbarItems

hiCreateToolbar

hiCreateToolbarComboBox

hiCreateToolbarTypein

hiCreateToolbarSeparator

hiDeleteToolbar

hiDeleteToolbarBreak

hiDeleteToolbarItem

hiDeleteToolbarItems

hiFocusToToolbarItem

hiGetSharedIcon

hiGetToolbarObjName

hiGetWindowToolbars

hiHasToolbarBreak

hiInsertToolbar

hiInsertToolbarBreak

hiInsertToolbarItem

hiInsertToolbarItems

hiListFocusableToolbarItems

hiPlaceToolbarBreak

hiReattachToolbar

hiSetToolbarObjName

hiSetActionChecked

5

Dialog Boxes

Information Dialog Boxes

File Selection Dialog Boxes

Progress Dialog Boxes

General Dialog Box Functions

hiDisplayAppDBox

hiDisplayUserDBox

hiSetDBoxDefaultLocation

hiGetDBoxDefaultLocation

File Selection Dialog Box Functions

hiDisplayFileDialog

hiFileDialogSelection

hiFileDialogSetSelection

hiFileDialogDone

hiGetExistingFile

hiGetExistingFiles

hiGetExistingDirectory

Progress Dialog Box Functions

hiAdvanceProgressBarOneStep

hiCancelProgressBox

hiDisplayProgressBox

hiGetProgressBarCurrentStep

hiGetProgressBarTotalSteps

hiGetProgressTotalSteps

hiHideProgressBar

hiIsProgressBoxCancelled

hiSetProgressText

hiSetProgressTotalSteps

hiSetProgressAndText

hiSetProgressButtonText

hiSetProgressBannerText

hiResetProgressBox

hiShowProgressBar

hiSetProgressBar

hiSetProgressLabel

Color Dialog Function

hiDisplayColorDialog

Old Dialog Box Functions

hiDisplayBlockingDBox

hiDisplayModalDBox

hiDisplayModelessDBox

hiDisplayNonBlockingDBox

6

List Box Functions

hiDisplayListBox

hiGetListBoxFieldFit

hiListBoxCancel

7

Icon Functions

hiAddIconOverrides

hiCreateColorArray

hiGetIconOverrides

hiLoadImageFile

hiMatchColorByName

hiRemoveIconOverrides

hiSetDisabledIcon

8

Form Functions

One Dimensional Form Layout

Two Dimensional Form Layout

hiLayout Form Functions

hiAddItemToLayout

hiCreateFormLayout

hiCreateGridLayout

hiCreateHorizontalBoxLayout

hiCreateStackedLayout

hiCreateVerticalBoxLayout

hiCreateLayoutForm

hiDeleteItemFromLayout

Traversing Fields

Creating Context Menus for Fields

Setting the hiContextMenu Property

Setting the hiShowContextMenuCallback Property

Creating Tool Tips for Fields

Form and Field Functions

ddHiCreateCellComboField

ddHiCreateLibraryComboField

ddHiCreateViewComboField

hiAddCyclicChoice

hiChangeFormCallback

hiChangeFormTitle

hiCollapseTreeItem

hiCreateAppForm

hiCreateBBoxField

hiCreateBooleanButton

hiCreateButtonBoxField

hiCreateComboField

hiCreateCyclicField

hiCreateFileSelectorField

hiCreateDisclosureButton

hiCreateDisclosureTriangle

hiCreateFloatField

hiCreateFrameField

hiCreateScrollRegion

hiIsScrollRegion

hiCreateFormButton

hiCreateFormLabel

hiCreateHypertextField

hiCreateIntField

hiCreateLayerCyclicField

hiCreateListField

hiCreateListBoxField

hiCreateMLTextField

hiCreateOptionsForm

hiCreateOutputStringField

hiCreatePointField

hiCreatePointListField

hiCreateRadioField

hiCreateReportField

hiCreateScaleField

hiCreateSeparatorField

hiCreateSimpleHypertextField

hiCreateSpinBox

hiCreateFloatSpinBox

hiCreateStringField

hiCreateTabField

hiCreateTreeItem

hiCreateTreeTable

hiCreateToggleField

hiEscapeStringChars

hiEscapeHTMLTags

hiExpandTreeItem

hiGetButtonAreaHeight

hiGetChoiceStrings

hiGetCurrentField

hiGetCurrentForm

hiGetCyclicValueString

hiGetFieldAttachments

hiGetFieldMinSize

hiGetRadioValueString

hiGetFieldOverlaps

hiGetFieldScope

hiGetFormLocation

hiGetInsertionPosition

hiGetItemOfLayout

hiGetLayerCyclicValue

hiGetLayoutChildLayouts

hiGetLayoutFields

hiGetLayoutItems

hiGetListBoxValue

hiGetLayoutFrame

hiGetLayoutItemIndex

hiGetLayoutType

hiGetStackedLayoutCurrentIndex

hiSetFieldMinSize

hiSetKeyboardFocusField

hiSetLayoutFrameTitle

hiSetLayoutMargins

hiGetGridLayoutItemLocation

hiGetKeyboardFocusField

hiGetLayoutMargins

hiGetNumVisibleItems

hiGetScrollBarInfo

hiGetTextFieldFit

hiGetTopListItem

hiGetTreeItemDescription

hiGetTreeItemIcons

hiGetTreeItemParent

hiGetTreeParent

hiHighlightField

hiHypertextReadin

hiHypertextReplace

hiHypertextScroll

hiInsertItemToLayout

hiInstantiateForm

hiIsFormDisplayed

hiIsInstantiated

hiIsInFieldCancel

hiItemInsertTree

hiLayerMatchCyclicStr

hiLaunchBrowser

hiLayerStringToLPP

hiMoveToFormField

hiMoveInsBarToEnd

hiReattachField

hiReportSelectItem

hiReportSelectItems

hiReportSelectAllItems

hiReportDeselectItem

hiReportDeselectItems

hiReportDeselectAllItems

hiReportGetSelectedItems

hiSetButtonIcon

hiSetButtonLabel

hiSetCallbackStatus

hiSetCurrentField

hiSetCurrentForm

hiSetFieldEditable

hiSetFieldEnabled

hiSetFormButtonEnabled

hiSetFormHighlights

hiSetFormMinMaxSize

hiSetFormPosition

hiSetFormToDefaults

hiSetInsertionPosition

hiSetLayerCyclicValue

hiSetStackedLayoutCurrentIndex

hiSetScrollBarValue

hiSetTopListItem

hiSetTreeItemDescription

hiSetTreeItemIcons

hiSetListItemVisible

hiSetListItemCenter

hiShowFieldBorders

hiStoreFormLocation

hiSwapTreeItemSelectionIcons

hiTreeAppendItem

hiTreeAppendItems

hiTreePrependItem

hiTreePrependItems

hiTreeRemoveItem

hiTreeRemoveItems

hiTreeRemoveAllItems

hiTreeTableDeselectItem

hiTreeTableDeselectAllItems

hiTreeTableDeselectItems

hiTreeTableGetExpandedItems

hiTreeTableGetExpandedItemCount

hiTreeTableGetItems

hiTreeTableGetItemCount

hiTreeTableGetSelectedItems

hiTreeTableGetSelectedItemCount

hiTreeTableSelectItem

hiTreeTableSelectAllItems

hiTreeTableSelectItems

hiItemRemoveTree

hiUpdateFormBlock

9

Window Functions

getCurrentWindow

getMaxScreenCoords

hiCreateDockWindow

hiDeiconifyWindow

hiDisplayWindow

hiFocusToCursor

hiGetAbsWindowScreenBBox

hiGetActiveTabWindow

hiGetCurrentEnterFunPoints

hiGetCurrentWindow

hiGetCursorByName

hiGetDrawThruDelta

hiGetEFDrawThruDelta

hiGetEFunCursor

hiGetScreenPoint

hiGetSessionWindow

hiGetWindowState

hiGetWindowDisplayState

hiGetWindowIconifyState

hiGetWindowList

hiGetWindowName

hiIsWindowSpecifier

hiSetDrawThruDelta

hiSetSessionFocus

hiSetTabWindowTitle

hiSetTabWindowIcon

hiSetTabWindowTip

hiSetWindowAtts

hiUnregCloseProc

hiSwitchWindowType

hiIconifyWindow

hiSetWindowName

hiSetWindowIcon

hiGetWidgetType

hiSetCurrentWindow

hiRegCurWindowTrigger

hiUnregCurWindowTrigger

hiGetMaxScreenCoords

hiRemoveFixedMenu

hiMoveFixedMenu

hiGetWindowFixedMenu

hiGetCursorName

hiSetShadowMode

hiRemovePromptLine

hiSetEFunCursor

hiSetEFDrawThruDelta

setCurrentWindow

Viewing Functions

hiZoomRelativeScale

hiZoomAbsoluteScale

hiZoomWindowAtPoint

hiZoomWindowAtMouse

hiZoomInAtMouse

hiZoomOutAtMouse

hiZoomExpandAtPoint

hiZoomExpandAtMouse

hiDynamicPanAbsolute

hiDynamicPanRelative

hiDynamicPanInteractive

hiDynamicPanGrabbing

hiRegZoomPanProc

hiUnregZoomPanProc

hiIsBlinkEnabled

World View Functions

hiCreateWorldView

hiWorldViewRedraw

hiWorldViewZoomIn

hiWorldViewZoomOut

Thumbnail View Functions

hiGenerateThumbnails

hiGetDefaultThumbnail

hiGetDefaultThumbnailResolution

hiGetDefaultWidgetSpacing

hiGetThumbnailFilename

Workspace Functions

hiSaveWinConfig

hiReadWinConfig

hiApplyWinConfig

hiWinConfigModified

hiGetWinConfigInfo

hiSetWinObjName

hiGetWinObjName

Screen Capture Functions

hiWindowSaveImage

hiExportImageDialog

Splash Screen Functions

hiSetSplashBackground

hiSetSplashDefaultBackground

hiSetSplashIcon

hiSetSplashFamily

hiSetSplashProduct

hiSetSplashLicense

Magnifier Functions

hiGetMagnifierSize

hiIsMagnifierAnchored

hiIsMagnifierOpened

hiResizeMagnifier

hiScaleMagnifier

hiToggleAnchorMagnifier

hiToggleMagnifier

hiToggleMagnifierResolution

hiUpdateMagOptions

hiUseMagnifierResolution

hiUsingMagnifierResolution

hiZoomInMagnifier

hiZoomOutMagnifier

10

Window Banner Functions

hiChangeBannerLabel

hiDeleteBannerLabel

hiDeleteBannerMenu

hiDeleteBannerMenus

hiGetBannerLabels

hiGetBannerMenus

hiInsertBannerMenu

hiIsMenuSlotFilled

hiReplaceAllBannerMenus

11

Bindkey Functions

hiBindKeyModifiers

hiRegSetBindKeyProc

hiShowBindKeysByAppType

hiShowBindKeysByWindow

hiRegisterBindKeyPrefix

hiInheritBindKey

hiGetBindKeyInheritRoot

hiGetBindKeyInheritAlias

hiGetBindKeyPrefixList

hiConfigureBindKeys

hiEnableAsstBindKeyPrefix

hiDisableAsstBindKeyPrefix

hiGetDisabledAsstBindKeyPrefixes

hiPrintBindKeyUsage

12

User Entry Functions

Enterfunction Prompts

Terminating an Enterfunction

Callback Procedures

Callback Procedure addPointProc

Callback Procedure delPointProc

Callback Procedure formProc

Callback Procedure doneProc

Enterfunction Flags

Enterfunction Flag dontDraw

Enterfunction Flag alwaysMap

Enterfunction Flag acceptString

Enterfunction Flag acceptNumber

Enterfunction Flag noInfix

Nesting Enterfunctions

changeNextEnterFun

clearAllEnterFunctions

enterFunNestLevel

hiGetCurrentCmd

hiMarkNonNestable

hiToggleEnterForm

setEFunFlightLineTarget

13

Encapsulation Window

hiAppendInputCmd

hiGetEncapSkillCmd

hiSetEncapHistory

hiSetEncapPrompt

hiSetEncapSkillCmd

14

Functions of Viewfile Window

Viewfile Management

HTML Viewfile Window

Text Device Mode

Hypertext Viewfile Window

hiClearClipboard

hiClearCurrentTextSelection

hiDisableTailViewfile

hiEnableTailViewfile

hiSaveAsViewfile

hiStartGenTextIndex

hiGetTextSelection

hiGetTextSelByLoc

hiSetTextSelection

hiSelectTextByLoc

hiGetCurrentTextSelection

hiGetCurrentTextSelectionLoc

hiSetCurrentTextSelectionLoc

hiSetTextSelectAll

hiUnselectTextByLoc

hiUnselectTextClass

hiUnselectTextAll

hiScrollWindowLeft

hiScrollWindowRight

hiScrollWindowUp

hiScrollWindowDown

hiScrollWindowTop

hiScrollWindowBottom

hiScrollWindowToCurrentIndex

hiScrollWindowToIndex

hiScrollWindowToName

hiGetCurrentIndex

hiSetCurrentIndex

Text Customization Functions

hiSetTextHighlightColor

hiTextDisplayString

hiRefreshTextWindow

hiUpdateTextSelectionColors

Word Delimiters

hiGetTextWordDelimiter

hiAddTextWordDelimiter

hiRemoveTextWordDelimiter

hiReplaceTextWordDelimiter

Miscellaneous Viewfile Functions

hiGetTextCharAtLoc

hiGetTextSourceLength

hiGetTextLineColumn

hiGetTextIndexLoc

hiGetTextDispLoc

15

Online Help Mechanism

Form and Dialog Box Help

Properties Required for Task Assistant

Specify Your Own Callback for Help

Setting the hiHelpAction Property on a Form or Dialog Box

Writing a Callback Function for a Form or Dialog Box

Specifying Your Own Callback for Windows

Online Help Functions

hiModalDBoxHelp

hiModelessDBoxHelp

16

QtReplay Functions

nrGetIndexesFromSelection

nrGetSelectedIndexes

nrListColumnMove

nrListColumnSort

nrListItemAction

nrListItemExpand

nrListItemRename

nrSetCurrentWindow

nrSetFileFilter

nrSetWindowVisibility

17

Performance Diagnostic Functions

perfDiagInstall

perfRefreshControl

perfStartCallStackProc

perfStopCallStackProc

18

Display Lists

Add Objects to the Display List

dlAddEventObject

dlAddRasterText

dlAddSkillObject

dlAddStrokeText

dlMakeDisplayList

dlSetClearOnDraw

Display List Draw Functions

dlDrawRasterText

dlDrawStrokeText

Display List Pen Functions

dlSetCurrentPen

dlSetPenFillStyle

dlSetPenStipple

View Display List Functions

dlAttachDlistToWidget

dlAttachDlistToWindow

dlClearDisplayList

dlConfigureButton

dlDetachDlistFromWidget

dlDetachDlistFromWindow

dlGetRasterTextWidth

dlFitDlistOnDraw

dlMakeDlistButton

dlQueryRasterFont

dlSetDlistPosition

dlSetDlistScale

dlSetWidgetName

19

Graph Browser

Terms Used in Cadence User Interface

Properties of the dagArc

Properties of the dagClass

Properties of the dagNode

Properties of the dagTool

Actions and Action Lists

dagAddActionToObject

dagDeleteActionFromObject

dagGetCurrentObject

dagGetCurrentTool

dagLinkParentToChild

dagRefreshObject

dagSetActionStatus

dagSetCurrentTool

dagSetExpandedActionStatus

dagUnlinkParentFromChild

20

Interprocess Communication

21

Stroke Functions

hiGetStrokeBBox

hiGetStrokeFirstPt

hiGetStrokeLastPt

⠀ X