util/X86LINUX64/man/mann/tk_getSaveFile.n

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