| 1 | '\" |
| 2 | '\" Copyright (c) 1996 Sun Microsystems, Inc. |
| 3 | '\" |
| 4 | '\" See the file "license.terms" for information on usage and redistribution |
| 5 | '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. |
| 6 | '\" |
| 7 | '\" RCS: @(#) $Id: getOpenFile.n,v 1.10.2.1 2004/10/28 10:19:29 dkf Exp $ |
| 8 | '\" |
| 9 | '\" The definitions below are for supplemental macros used in Tcl/Tk |
| 10 | '\" manual entries. |
| 11 | '\" |
| 12 | '\" .AP type name in/out ?indent? |
| 13 | '\" Start paragraph describing an argument to a library procedure. |
| 14 | '\" type is type of argument (int, etc.), in/out is either "in", "out", |
| 15 | '\" or "in/out" to describe whether procedure reads or modifies arg, |
| 16 | '\" and indent is equivalent to second arg of .IP (shouldn't ever be |
| 17 | '\" needed; use .AS below instead) |
| 18 | '\" |
| 19 | '\" .AS ?type? ?name? |
| 20 | '\" Give maximum sizes of arguments for setting tab stops. Type and |
| 21 | '\" name are examples of largest possible arguments that will be passed |
| 22 | '\" to .AP later. If args are omitted, default tab stops are used. |
| 23 | '\" |
| 24 | '\" .BS |
| 25 | '\" Start box enclosure. From here until next .BE, everything will be |
| 26 | '\" enclosed in one large box. |
| 27 | '\" |
| 28 | '\" .BE |
| 29 | '\" End of box enclosure. |
| 30 | '\" |
| 31 | '\" .CS |
| 32 | '\" Begin code excerpt. |
| 33 | '\" |
| 34 | '\" .CE |
| 35 | '\" End code excerpt. |
| 36 | '\" |
| 37 | '\" .VS ?version? ?br? |
| 38 | '\" Begin vertical sidebar, for use in marking newly-changed parts |
| 39 | '\" of man pages. The first argument is ignored and used for recording |
| 40 | '\" the version when the .VS was added, so that the sidebars can be |
| 41 | '\" found and removed when they reach a certain age. If another argument |
| 42 | '\" is present, then a line break is forced before starting the sidebar. |
| 43 | '\" |
| 44 | '\" .VE |
| 45 | '\" End of vertical sidebar. |
| 46 | '\" |
| 47 | '\" .DS |
| 48 | '\" Begin an indented unfilled display. |
| 49 | '\" |
| 50 | '\" .DE |
| 51 | '\" End of indented unfilled display. |
| 52 | '\" |
| 53 | '\" .SO |
| 54 | '\" Start of list of standard options for a Tk widget. The |
| 55 | '\" options follow on successive lines, in four columns separated |
| 56 | '\" by tabs. |
| 57 | '\" |
| 58 | '\" .SE |
| 59 | '\" End of list of standard options for a Tk widget. |
| 60 | '\" |
| 61 | '\" .OP cmdName dbName dbClass |
| 62 | '\" Start of description of a specific option. cmdName gives the |
| 63 | '\" option's name as specified in the class command, dbName gives |
| 64 | '\" the option's name in the option database, and dbClass gives |
| 65 | '\" the option's class in the option database. |
| 66 | '\" |
| 67 | '\" .UL arg1 arg2 |
| 68 | '\" Print arg1 underlined, then print arg2 normally. |
| 69 | '\" |
| 70 | '\" RCS: @(#) $Id: man.macros,v 1.4 2000/08/25 06:18:32 ericm Exp $ |
| 71 | '\" |
| 72 | '\" # Set up traps and other miscellaneous stuff for Tcl/Tk man pages. |
| 73 | .if t .wh -1.3i ^B |
| 74 | .nr ^l \n(.l |
| 75 | .ad b |
| 76 | '\" # Start an argument description |
| 77 | .de AP |
| 78 | .ie !"\\$4"" .TP \\$4 |
| 79 | .el \{\ |
| 80 | . ie !"\\$2"" .TP \\n()Cu |
| 81 | . el .TP 15 |
| 82 | .\} |
| 83 | .ta \\n()Au \\n()Bu |
| 84 | .ie !"\\$3"" \{\ |
| 85 | \&\\$1 \\fI\\$2\\fP (\\$3) |
| 86 | .\".b |
| 87 | .\} |
| 88 | .el \{\ |
| 89 | .br |
| 90 | .ie !"\\$2"" \{\ |
| 91 | \&\\$1 \\fI\\$2\\fP |
| 92 | .\} |
| 93 | .el \{\ |
| 94 | \&\\fI\\$1\\fP |
| 95 | .\} |
| 96 | .\} |
| 97 | .. |
| 98 | '\" # define tabbing values for .AP |
| 99 | .de AS |
| 100 | .nr )A 10n |
| 101 | .if !"\\$1"" .nr )A \\w'\\$1'u+3n |
| 102 | .nr )B \\n()Au+15n |
| 103 | .\" |
| 104 | .if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n |
| 105 | .nr )C \\n()Bu+\\w'(in/out)'u+2n |
| 106 | .. |
| 107 | .AS Tcl_Interp Tcl_CreateInterp in/out |
| 108 | '\" # BS - start boxed text |
| 109 | '\" # ^y = starting y location |
| 110 | '\" # ^b = 1 |
| 111 | .de BS |
| 112 | .br |
| 113 | .mk ^y |
| 114 | .nr ^b 1u |
| 115 | .if n .nf |
| 116 | .if n .ti 0 |
| 117 | .if n \l'\\n(.lu\(ul' |
| 118 | .if n .fi |
| 119 | .. |
| 120 | '\" # BE - end boxed text (draw box now) |
| 121 | .de BE |
| 122 | .nf |
| 123 | .ti 0 |
| 124 | .mk ^t |
| 125 | .ie n \l'\\n(^lu\(ul' |
| 126 | .el \{\ |
| 127 | .\" Draw four-sided box normally, but don't draw top of |
| 128 | .\" box if the box started on an earlier page. |
| 129 | .ie !\\n(^b-1 \{\ |
| 130 | \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul' |
| 131 | .\} |
| 132 | .el \}\ |
| 133 | \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul' |
| 134 | .\} |
| 135 | .\} |
| 136 | .fi |
| 137 | .br |
| 138 | .nr ^b 0 |
| 139 | .. |
| 140 | '\" # VS - start vertical sidebar |
| 141 | '\" # ^Y = starting y location |
| 142 | '\" # ^v = 1 (for troff; for nroff this doesn't matter) |
| 143 | .de VS |
| 144 | .if !"\\$2"" .br |
| 145 | .mk ^Y |
| 146 | .ie n 'mc \s12\(br\s0 |
| 147 | .el .nr ^v 1u |
| 148 | .. |
| 149 | '\" # VE - end of vertical sidebar |
| 150 | .de VE |
| 151 | .ie n 'mc |
| 152 | .el \{\ |
| 153 | .ev 2 |
| 154 | .nf |
| 155 | .ti 0 |
| 156 | .mk ^t |
| 157 | \h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n' |
| 158 | .sp -1 |
| 159 | .fi |
| 160 | .ev |
| 161 | .\} |
| 162 | .nr ^v 0 |
| 163 | .. |
| 164 | '\" # Special macro to handle page bottom: finish off current |
| 165 | '\" # box/sidebar if in box/sidebar mode, then invoked standard |
| 166 | '\" # page bottom macro. |
| 167 | .de ^B |
| 168 | .ev 2 |
| 169 | 'ti 0 |
| 170 | 'nf |
| 171 | .mk ^t |
| 172 | .if \\n(^b \{\ |
| 173 | .\" Draw three-sided box if this is the box's first page, |
| 174 | .\" draw two sides but no top otherwise. |
| 175 | .ie !\\n(^b-1 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c |
| 176 | .el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c |
| 177 | .\} |
| 178 | .if \\n(^v \{\ |
| 179 | .nr ^x \\n(^tu+1v-\\n(^Yu |
| 180 | \kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c |
| 181 | .\} |
| 182 | .bp |
| 183 | 'fi |
| 184 | .ev |
| 185 | .if \\n(^b \{\ |
| 186 | .mk ^y |
| 187 | .nr ^b 2 |
| 188 | .\} |
| 189 | .if \\n(^v \{\ |
| 190 | .mk ^Y |
| 191 | .\} |
| 192 | .. |
| 193 | '\" # DS - begin display |
| 194 | .de DS |
| 195 | .RS |
| 196 | .nf |
| 197 | .sp |
| 198 | .. |
| 199 | '\" # DE - end display |
| 200 | .de DE |
| 201 | .fi |
| 202 | .RE |
| 203 | .sp |
| 204 | .. |
| 205 | '\" # SO - start of list of standard options |
| 206 | .de SO |
| 207 | .SH "STANDARD OPTIONS" |
| 208 | .LP |
| 209 | .nf |
| 210 | .ta 5.5c 11c |
| 211 | .ft B |
| 212 | .. |
| 213 | '\" # SE - end of list of standard options |
| 214 | .de SE |
| 215 | .fi |
| 216 | .ft R |
| 217 | .LP |
| 218 | See the \\fBoptions\\fR manual entry for details on the standard options. |
| 219 | .. |
| 220 | '\" # OP - start of full description for a single option |
| 221 | .de OP |
| 222 | .LP |
| 223 | .nf |
| 224 | .ta 4c |
| 225 | Command-Line Name: \\fB\\$1\\fR |
| 226 | Database Name: \\fB\\$2\\fR |
| 227 | Database Class: \\fB\\$3\\fR |
| 228 | .fi |
| 229 | .IP |
| 230 | .. |
| 231 | '\" # CS - begin code excerpt |
| 232 | .de CS |
| 233 | .RS |
| 234 | .nf |
| 235 | .ta .25i .5i .75i 1i |
| 236 | .. |
| 237 | '\" # CE - end code excerpt |
| 238 | .de CE |
| 239 | .fi |
| 240 | .RE |
| 241 | .. |
| 242 | .de UL |
| 243 | \\$1\l'|0\(ul'\\$2 |
| 244 | .. |
| 245 | .TH tk_getOpenFile n 4.2 Tk "Tk Built-In Commands" |
| 246 | .BS |
| 247 | '\" Note: do not modify the .SH NAME line immediately below! |
| 248 | .SH NAME |
| 249 | tk_getOpenFile, tk_getSaveFile \- pop up a dialog box for the user to select a file to open or save. |
| 250 | .SH SYNOPSIS |
| 251 | \fBtk_getOpenFile \fR?\fIoption value ...\fR? |
| 252 | .br |
| 253 | \fBtk_getSaveFile \fR?\fIoption value ...\fR? |
| 254 | .BE |
| 255 | |
| 256 | .SH DESCRIPTION |
| 257 | .PP |
| 258 | The procedures \fBtk_getOpenFile\fR and \fBtk_getSaveFile\fR pop up a |
| 259 | dialog box for the user to select a file to open or save. The |
| 260 | \fBtk_getOpenFile\fR command is usually associated with the \fBOpen\fR |
| 261 | command in the \fBFile\fR menu. Its purpose is for the user to select an |
| 262 | existing file \fIonly\fR. If the user enters a non-existent file, the |
| 263 | dialog box gives the user an error prompt and requires the user to give |
| 264 | an alternative selection. If an application allows the user to create |
| 265 | new files, it should do so by providing a separate \fBNew\fR menu command. |
| 266 | .PP |
| 267 | The \fBtk_getSaveFile\fR command is usually associated with the \fBSave |
| 268 | as\fR command in the \fBFile\fR menu. If the user enters a file that |
| 269 | already exists, the dialog box prompts the user for confirmation |
| 270 | whether the existing file should be overwritten or not. |
| 271 | .PP |
| 272 | The following \fIoption\-value\fR pairs are possible as command line |
| 273 | arguments to these two commands: |
| 274 | .TP |
| 275 | \fB\-defaultextension\fR \fIextension\fR |
| 276 | Specifies a string that will be appended to the filename if the user |
| 277 | enters a filename without an extension. The default value is the empty |
| 278 | string, which means no extension will be appended to the filename in |
| 279 | any case. This option is ignored on the Macintosh platform, which |
| 280 | does not require extensions to filenames, |
| 281 | .VS 8.4 |
| 282 | and the UNIX implementation guesses reasonable values for this from |
| 283 | the \fB\-filetypes\fR option when this is not supplied. |
| 284 | .VE 8.4 |
| 285 | .TP |
| 286 | \fB\-filetypes\fR \fIfilePatternList\fR |
| 287 | If a \fBFile types\fR listbox exists in the file dialog on the particular |
| 288 | platform, this option gives the \fIfiletype\fRs in this listbox. When |
| 289 | the user choose a filetype in the listbox, only the files of that type |
| 290 | are listed. If this option is unspecified, or if it is set to the |
| 291 | empty list, or if the \fBFile types\fR listbox is not supported by the |
| 292 | particular platform then all files are listed regardless of their |
| 293 | types. See the section \fBSPECIFYING FILE PATTERNS\fR below for a |
| 294 | discussion on the contents of \fIfilePatternList\fR. |
| 295 | .TP |
| 296 | \fB\-initialdir\fR \fIdirectory\fR |
| 297 | Specifies that the files in \fIdirectory\fR should be displayed |
| 298 | when the dialog pops up. If this parameter is not specified, then |
| 299 | the files in the current working directory are displayed. If the |
| 300 | parameter specifies a relative path, the return value will convert the |
| 301 | relative path to an absolute path. This option may not always work on |
| 302 | the Macintosh. This is not a bug. Rather, the \fIGeneral Controls\fR |
| 303 | control panel on the Mac allows the end user to override the |
| 304 | application default directory. |
| 305 | .TP |
| 306 | \fB\-initialfile\fR \fIfilename\fR |
| 307 | Specifies a filename to be displayed in the dialog when it pops up. This |
| 308 | option is ignored on the Macintosh platform. |
| 309 | .TP |
| 310 | \fB\-multiple\fR |
| 311 | Allows the user to choose multiple files from the Open dialog. |
| 312 | On the Macintosh, this is only available when Navigation Services are |
| 313 | installed. |
| 314 | .TP |
| 315 | \fB\-message\fR \fIstring\fR |
| 316 | Specifies a message to include in the client area of the dialog. |
| 317 | This is only available on the Macintosh, and only when Navigation |
| 318 | Services are installed. |
| 319 | .TP |
| 320 | \fB\-parent\fR \fIwindow\fR |
| 321 | Makes \fIwindow\fR the logical parent of the file dialog. The file |
| 322 | dialog is displayed on top of its parent window. |
| 323 | .TP |
| 324 | \fB\-title\fR \fItitleString\fR |
| 325 | Specifies a string to display as the title of the dialog box. If this |
| 326 | option is not specified, then a default title is displayed. |
| 327 | .PP |
| 328 | If the user selects a file, both \fBtk_getOpenFile\fR and |
| 329 | \fBtk_getSaveFile\fR return the full pathname of this file. If the |
| 330 | user cancels the operation, both commands return the empty string. |
| 331 | .SH "SPECIFYING FILE PATTERNS" |
| 332 | |
| 333 | The \fIfilePatternList\fR value given by the \fB\-filetypes\fR option |
| 334 | is a list of file patterns. Each file pattern is a list of the |
| 335 | form |
| 336 | .CS |
| 337 | \fItypeName\fR {\fIextension\fR ?\fIextension ...\fR?} ?{\fImacType\fR ?\fImacType ...\fR?}? |
| 338 | .CE |
| 339 | \fItypeName\fR is the name of the file type described by this |
| 340 | file pattern and is the text string that appears in the \fBFile types\fR |
| 341 | listbox. \fIextension\fR is a file extension for this file pattern. |
| 342 | \fImacType\fR is a four-character Macintosh file type. The list of |
| 343 | \fImacType\fRs is optional and may be omitted for applications that do |
| 344 | not need to execute on the Macintosh platform. |
| 345 | .PP |
| 346 | Several file patterns may have the same \fItypeName,\fR in which case |
| 347 | they refer to the same file type and share the same entry in the |
| 348 | listbox. When the user selects an entry in the listbox, all the files |
| 349 | that match at least one of the file patterns corresponding |
| 350 | to that entry are listed. Usually, each file pattern corresponds to a |
| 351 | distinct type of file. The use of more than one file patterns for one |
| 352 | type of file is necessary on the Macintosh platform only. |
| 353 | .PP |
| 354 | On the Macintosh platform, a file matches a file pattern if its |
| 355 | name matches at least one of the \fIextension\fR(s) AND it |
| 356 | belongs to at least one of the \fImacType\fR(s) of the |
| 357 | file pattern. For example, the \fBC Source Files\fR file pattern in the |
| 358 | sample code matches with files that have a \fB\.c\fR extension AND |
| 359 | belong to the \fImacType\fR \fBTEXT\fR. To use the OR rule instead, |
| 360 | you can use two file patterns, one with the \fIextensions\fR only and |
| 361 | the other with the \fImacType\fR only. The \fBGIF Files\fR file type |
| 362 | in the sample code matches files that EITHER have a \fB\.gif\fR |
| 363 | extension OR belong to the \fImacType\fR \fBGIFF\fR. |
| 364 | .PP |
| 365 | On the Unix and Windows platforms, a file matches a file pattern |
| 366 | if its name matches at least one of the \fIextension\fR(s) of |
| 367 | the file pattern. The \fImacType\fRs are ignored. |
| 368 | .SH "SPECIFYING EXTENSIONS" |
| 369 | .PP |
| 370 | On the Unix and Macintosh platforms, extensions are matched using |
| 371 | glob-style pattern matching. On the Windows platforms, extensions are |
| 372 | matched by the underlying operating system. The types of possible |
| 373 | extensions are: (1) the special extension * matches any |
| 374 | file; (2) the special extension "" matches any files that |
| 375 | do not have an extension (i.e., the filename contains no full stop |
| 376 | character); (3) any character string that does not contain any wild |
| 377 | card characters (* and ?). |
| 378 | .PP |
| 379 | Due to the different pattern matching rules on the various platforms, |
| 380 | to ensure portability, wild card characters are not allowed in the |
| 381 | extensions, except as in the special extension *. Extensions |
| 382 | without a full stop character (e.g. ~) are allowed but may not |
| 383 | work on all platforms. |
| 384 | |
| 385 | .SH EXAMPLE |
| 386 | .CS |
| 387 | set types { |
| 388 | {{Text Files} {.txt} } |
| 389 | {{TCL Scripts} {.tcl} } |
| 390 | {{C Source Files} {.c} TEXT} |
| 391 | {{GIF Files} {.gif} } |
| 392 | {{GIF Files} {} GIFF} |
| 393 | {{All Files} * } |
| 394 | } |
| 395 | set filename [tk_getOpenFile -filetypes $types] |
| 396 | |
| 397 | if {$filename != ""} { |
| 398 | # Open the file ... |
| 399 | } |
| 400 | .CE |
| 401 | |
| 402 | .SH "SEE ALSO" |
| 403 | tk_chooseDirectory |
| 404 | |
| 405 | .SH KEYWORDS |
| 406 | file selection dialog |