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

hiFileDialogSetSelection

hiFileDialogSetSelection(
&_dialogName
l_selection
s_event
)
=> t / nil

Description

This function is logged when a selection is made from a file dialog.

Applications do not usually call this function.

Arguments

&_dialogName

The file dialog indentity that is set into the s_dialogName argument of hiDisplayFileDialog when the file dialog is created.

l_selection

List of selections that can be in the same format as the return value of hiDisplayFileDialog, which is a list of lists of directory-path/file-name pairs. Here, the directory-path should be the same for every file, or a list of directory-path and file-name, or a list of directory-paths and a list of file names.

If l_selection includes multiple files, only the first file in the list is shown in the file dialog.

s_event

Symbol indicating which the button the user clicked after making a selection. Legal values are ’done, ’apply, and ’cancel, which correspond to the Open/Save/OK, Apply, and Cancel buttons.

Values Returned

t

The argument &_dialogName is a valid file dialog identity.

nil

&_dialogName is not a valid file dialog ID.

Examples

( hiFileDialogSetSelection hiEditFileDialog '( "/tmp" "foo.txt" ) 'done )
( hiFileDialogSetSelection hiEditFileDialog '( ( "/tmp" "foo.txt" ) ( "/tmp" "bar.txt" ) ) 'done )
( hiFileDialogSetSelection hiEditFileDialog '( "/tmp" ( "foo.txt" "bar.txt" ) ) 'done )

Related Topics

File Selection Dialog Box Functions

hiFileDialogSelection

hiFileDialogSetSelection

hiFileDialogDone

hiGetExistingFile

hiGetExistingFiles

hiGetAnyFile

hiGetExistingDirectory


Return to top
 ⠀
X