Tcl 9.0/Tk9.0 Documentation > Tk Commands, version 9.0.0 > chooseDirectory

Tcl/Tk Applications | Tcl Commands | Tk Commands | [incr Tcl] Package Commands | SQLite3 Package Commands | TDBC Package Commands | tdbc::mysql Package Commands | tdbc::odbc Package Commands | tdbc::postgres Package Commands | tdbc::sqlite3 Package Commands | Thread Package Commands | Tcl C API | Tk C API | [incr Tcl] Package C API | TDBC Package C API

NAME

tk_chooseDirectory — pops up a dialog box for the user to select a directory.

SYNOPSIS

DESCRIPTION

-command string

-initialdir dirname

-message string

-mustexist boolean

-parent window

-title titleString

EXAMPLE

SEE ALSO

KEYWORDS

NAME

tk_chooseDirectory — pops up a dialog box for the user to select a directory.

SYNOPSIS

tk_chooseDirectory ?option value ...?

DESCRIPTION

The procedure tk_chooseDirectory pops up a dialog box for the user to select a directory. The following option-value pairs are possible as command line arguments:

-command string

Specifies the prefix of a Tcl command to invoke when the user closes the dialog after having selected an item. This callback is not called if the user cancelled the dialog. The actual command consists of string followed by a space and the value selected by the user in the dialog. This is only available on macOS.

-initialdir dirname

Specifies that the directories in directory should be displayed when the dialog pops up. If this parameter is not specified, the initial directory defaults to the current working directory on non-Windows systems and on Windows systems prior to Vista. On Vista and later systems, the initial directory defaults to the last user-selected directory for the application. If the parameter specifies a relative path, the return value will convert the relative path to an absolute path.

-message string

Specifies a message to include in the client area of the dialog. This is only available on macOS.

-mustexist boolean

Specifies whether the user may specify non-existent directories. If this parameter is true, then the user may only select directories that already exist. The default value is false.

-parent window

Makes window the logical parent of the dialog. The dialog is displayed on top of its parent window. On macOS, this turns the file dialog into a sheet attached to the parent window.

-title titleString

Specifies a string to display as the title of the dialog box. If this option is not specified, then a default title will be displayed.

EXAMPLE

set dir [tk_chooseDirectory \
        -initialdir ~ -title "Choose a directory"]
if {$dir eq ""} {
   label .l -text "No directory selected"
} else {
   label .l -text "Selected $dir"
}

SEE ALSO

tk_getOpenFile, tk_getSaveFile

KEYWORDS

directory, selection, dialog, platform-specific