HP/util/HP/man/mann/getOpenFile.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 '\" RCS: @(#) $Id: getOpenFile.n,v 1.6 2000/04/23 03:47:13 jingham 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.3 1999/04/16 00:46:35 stanton 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 4c 8c 12c
 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 .PP
 251 .PP
 252 .SH SYNOPSIS
 253 \fBtk_getOpenFile \fR?\fIoption value ...\fR?
 254 .br
 255 \fBtk_getSaveFile \fR?\fIoption value ...\fR?
 256 .BE
 257
 258 .SH DESCRIPTION
 259 .PP
 260 The procedures \fBtk_getOpenFile\fR and \fBtk_getSaveFile\fR pop up a
 261 dialog box for the user to select a file to open or save. The
 262 \fBtk_getOpenFile\fR command is usually associated with the \fBOpen\fR
 263 command in the \fBFile\fR menu. Its purpose is for the user to select an
 264 existing file \fIonly\fR. If the user enters an non-existent file, the
 265 dialog box gives the user an error prompt and requires the user to give
 266 an alternative selection. If an application allows the user to create
 267 new files, it should do so by providing a separate \fBNew\fR menu command.
 268 .PP
 269 The \fBtk_getSaveFile\fR command is usually associated with the \fBSave
 270 as\fR command in the \fBFile\fR menu. If the user enters a file that
 271 already exists, the dialog box prompts the user for confirmation
 272 whether the existing file should be overwritten or not.
 273 .PP
 274 The following \fIoption\-value\fR pairs are possible as command line
 275 arguments to these two commands:
 276 .TP
 277 \fB\-defaultextension\fR \fIextension\fR
 278 Specifies a string that will be appended to the filename if the user
 279 enters a filename without an extension. The defaut value is the empty
 280 string, which means no extension will be appended to the filename in
 281 any case. This option is ignored on the Macintosh platform, which
 282 does not require extensions to filenames.
 283 .TP
 284 \fB\-filetypes\fR \fIfilePatternList\fR
 285 If a \fBFile types\fR listbox exists in the file dialog on the particular
 286 platform, this option gives the \fIfiletype\fRs in this listbox. When
 287 the user choose a filetype in the listbox, only the files of that type
 288 are listed. If this option is unspecified, or if it is set to the
 289 empty list, or if the \fBFile types\fR listbox is not supported by the
 290 particular platform then all files are listed regardless of their
 291 types. See the section SPECIFYING FILE PATTERNS below for a
 292 discussion on the contents of \fIfilePatternList\fR.
 293 .TP
 294 \fB\-initialdir\fR \fIdirectory\fR
 295 Specifies that the files in \fIdirectory\fR should be displayed
 296 when the dialog pops up. If this parameter is not specified, then
 297 the files in the current working directory are displayed. If the
 298 parameter specifies a relative path, the return value will convert the
 299 relative path to an absolute path.  This option may not always work on
 300 the Macintosh.  This is not a bug. Rather, the \fIGeneral Controls\fR
 301 control panel on the Mac allows the end user to override the
 302 application default directory.
 303 .TP
 304 \fB\-initialfile\fR \fIfilename\fR
 305 Specifies a filename to be displayed in the dialog when it pops up.  This
 306 option is ignored on the Macintosh platform.
 307 .TP
 308 \fB\-multiple\fR
 309 Allows the user to choose multiple files from the Open dialog.
 310 This is only available on the Macintosh, and only when Navigation
 311 Services are installed.
 312 .TP
 313 \fB\-message\fR
 314 Specifies a message to include in the client area of the dialog.
 315 This is only available on the Macintosh, and only when Navigation
 316 Services are installed.
 317 .TP
 318 \fB\-parent\fR \fIwindow\fR
 319 Makes \fIwindow\fR the logical parent of the file dialog. The file
 320 dialog is displayed on top of its parent window.
 321 .TP
 322 \fB\-title\fR \fItitleString\fR
 323 Specifies a string to display as the title of the dialog box. If this
 324 option is not specified, then a default title is displayed.
 325 .PP
 326 If the user selects a file, both \fBtk_getOpenFile\fR and
 327 \fBtk_getSaveFile\fR return the full pathname of this file. If the
 328 user cancels the operation, both commands return the empty string.
 329 .SH "SPECIFYING FILE PATTERNS"
 330
 331 The \fIfilePatternList\fR value given by the \fB\-filetypes\fR option
 332 is a list of file patterns. Each file pattern is a list of the
 333 form
 334 .CS
 335 \fItypeName\fR {\fIextension\fR ?\fIextension ...\fR?} ?{\fImacType\fR ?\fImacType ...\fR?}?
 336 .CE
 337 \fItypeName\fR is the name of the file type described by this
 338 file pattern and is the text string that appears in the \fBFile types\fR
 339 listbox. \fIextension\fR is a file extension for this file pattern.
 340 \fImacType\fR is a four-character Macintosh file type. The list of
 341 \fImacType\fRs is optional and may be omitted for applications that do
 342 not need to execute on the Macintosh platform.
 343 .PP
 344 Several file patterns may have the same \fItypeName,\fR in which case
 345 they refer to the same file type and share the same entry in the
 346 listbox. When the user selects an entry in the listbox, all the files
 347 that match at least one of the file patterns corresponding
 348 to that entry are listed. Usually, each file pattern corresponds to a
 349 distinct type of file. The use of more than one file patterns for one
 350 type of file is necessary on the Macintosh platform only.
 351 .PP
 352 On the Macintosh platform, a file matches a file pattern if its
 353 name matches at least one of the \fIextension\fR(s) AND it
 354 belongs to at least one of the \fImacType\fR(s) of the
 355 file pattern. For example, the \fBC Source Files\fR file pattern in the
 356 sample code matches with files that have a \fB\.c\fR extension AND
 357 belong to the \fImacType\fR \fBTEXT\fR. To use the OR rule instead,
 358 you can use two file patterns, one with the \fIextensions\fR only and
 359 the other with the \fImacType\fR only. The \fBGIF Files\fR file type
 360 in the sample code matches files that EITHER have a \fB\.gif\fR
 361 extension OR belong to the \fImacType\fR \fBGIFF\fR.
 362 .PP
 363 On the Unix and Windows platforms, a file matches a file pattern
 364 if its name matches at at least one of the \fIextension\fR(s) of
 365 the file pattern. The \fImacType\fRs are ignored.
 366 .SH "SPECIFYING EXTENSIONS"
 367 .PP
 368 On the Unix and Macintosh platforms, extensions are matched using
 369 glob-style pattern matching. On the Windows platforms, extensions are
 370 matched by the underlying operating system. The types of possible
 371 extensions are: (1) the special extension * matches any
 372 file; (2) the special extension "" matches any files that
 373 do not have an extension (i.e., the filename contains no full stop
 374 character); (3) any character string that does not contain any wild
 375 card characters (* and ?).
 376 .PP
 377 Due to the different pattern matching rules on the various platforms,
 378 to ensure portability, wild card characters are not allowed in the
 379 extensions, except as in the special extension *. Extensions
 380 without a full stop character (e.g, ~) are allowed but may not
 381 work on all platforms.
 382
 383 .SH EXAMPLE
 384 .CS
 385 set types {
 386     {{Text Files}       {.txt}        }
 387     {{TCL Scripts}      {.tcl}        }
 388     {{C Source Files}   {.c}      TEXT}
 389     {{GIF Files}        {.gif}        }
 390     {{GIF Files}        {}        GIFF}
 391     {{All Files}        *             }
 392 }
 393 set filename [tk_getOpenFile -filetypes $types]
 394
 395 if {$filename != ""} {
 396     # Open the file ...
 397 }
 398 .CE
 399
 400 .SH "SEE ALSO"
 401 tk_chooseDirectory
 402
 403 .SH KEYWORDS
 404 file selection dialog