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

Function Object Callbacks with Additional Arguments

Function object callbacks in Cadence User Interface generally accept two standard arguments o_field, which represents the field whose callback is triggered and g_scope, which represents the location where the field is instantiated. Other than these two standard arguments the callbacks of function object type for certain HI fields require additional arguments.The following table lists such callbacks:

Field Names Callback Name Callback Syntax

hiCreateToggleField

?callback

< toggle field callback > ( o_field g_scope s_item g_value)

where,
s_item is the name of the item specified as a symbol.
g_value specifies the value of the toggle item whose value was changed.

If the toggle field is instantiated at multiple places, g_scope passed to a toggle field callback can be different from the one in which the toggle field is placed.

hiCreateButtonBoxField

?callback

< button box field callback > ( o_field g_scope t_button_text)

where,
t_button_text specifies the text string of the button that was pressed.

hiCreateBooleanButton

?callback

< boolean button field callback > ( o_field g_scope g_value)

where,
g_value specifies the value of the boolean button.

hiCreateRadioField

?callback

< radio field callback > ( o_field g_scope t_selection)

where,
t_selection specifies the string representing the radio item that was selected.

hiCreateCyclicField

?callback

< cyclic field callback > ( o_field g_scope g_item )

where,
g_item specifies the item selected, which can be either text or icon.

hiCreateReportField

?callback

< report callback > ( o_field g_scope l_selected_items )

where,
l_selected_items specifies a list of integers representing the selected items of the report.

The g_scope argument passed to a report field callback can be different from the one in which the report field is placed, if the report field is instantiated multiple times.

?doubleClickCB

< double click callback > ( o_field g_scope x_item_index )

where,
x_item_index specifies an integer representing the item that was double-clicked.

?sortCallback

< sort callback > ( o_field g_scope l_sort_property )

where,
l_sort_property is a list (columnToSort sortDirection), where columnToSort is an integer indicating the column to sort and sortDirection is t or nil, indicating descending or ascending order, respectively.

hiCreateTreeTable

?callback

< tree table callback > ( o_field g_scope l_items )

where,
l_items is the list of selected items (symbols).

?sortCallback

< sort callback > ( o_field g_scope l_sort_property )

where,
l_sort_property is a list (columnToSort sortDirection), where columnToSort is an integer indicating the column to sort and sortDirection is t or nil, indicating descending or ascending order, respectively.

?expandCallback

< expand callback > ( o_field g_scope s_item )

where,
s_item is the symbol of the item being expanded.

?collapseCallback

< collapse callback > ( o_field g_scope s_item )

where,
s_item is the symbol of the item being collapsed

?doubleClickCB

< double click callback > ( o_field g_scope s_item )

where,
s_item is the symbol of the item being double-clicked

hiCreateStringField

hiCreateComboField

?modifyCallback

< field modify callback > ( o_field g_scope t_latestTextValue g_sourceOfChange)

where,
t_latestTextValue is the latest text value of the field
g_sourceOfChange is t or nil, where t indicates that the change was made through the program (by changing the value of the field) and nil indicates that the change was made by a user action.

hiCreateHypertextField

?callback

< hypertext field callback > ( o_field g_scope t_hyperlinkName t_hyperlinkRef)

where,
t_hyperlinkName is the name of the hyperlink.

t_hyperlinkRef is the URL associated with the link.

hiCreateAppForm

?callback

< form callback > ( r_form )

where,
r_form is the form for which an OK, Cancel, or custom action is triggered

hiChangeFormCallback

?callback

< form callback > ( r_form )

where,
r_form is the form for which an OK, Cancel, or custom action is triggered

Related Topics

Cadence User Interface Callback Routines

Callbacks Supported by HI Forms and Fields


Return to top
 ⠀
X