home *** CD-ROM | disk | FTP | other *** search
/ Chip 2000 May / Chip_2000-05_cd1.bin / zkuste / Perl / ActivePerl-5.6.0.613.msi / 䆊䌷䈹䈙䏵-䞅䞆䞀㡆䞃䄦䠥 / _5976abfdb8e3c8f0427231a1f823113c < prev    next >
Text File  |  2000-03-23  |  9KB  |  193 lines

  1.  
  2. <HTML>
  3. <HEAD>
  4. <TITLE>getSaveFile - pop up a dialog box for the user to select a file to open or save.</TITLE>
  5. <LINK REL="stylesheet" HREF="../../../Active.css" TYPE="text/css">
  6. <LINK REV="made" HREF="mailto:">
  7. </HEAD>
  8.  
  9. <BODY>
  10. <TABLE BORDER=0 CELLPADDING=0 CELLSPACING=0 WIDTH=100%>
  11. <TR><TD CLASS=block VALIGN=MIDDLE WIDTH=100% BGCOLOR="#cccccc">
  12. <STRONG><P CLASS=block> getSaveFile - pop up a dialog box for the user to select a file to open or save.</P></STRONG>
  13. </TD></TR>
  14. </TABLE>
  15.  
  16. <A NAME="__index__"></A>
  17. <!-- INDEX BEGIN -->
  18.  
  19. <UL>
  20.  
  21.     <LI><A HREF="#name">NAME</A></LI><LI><A HREF="#supportedplatforms">SUPPORTED PLATFORMS</A></LI>
  22.  
  23.     <LI><A HREF="#synopsis">SYNOPSIS</A></LI>
  24.     <LI><A HREF="#description">DESCRIPTION</A></LI>
  25.     <LI><A HREF="#specifying file patterns">SPECIFYING FILE PATTERNS</A></LI>
  26.     <LI><A HREF="#specifying extensions">SPECIFYING EXTENSIONS</A></LI>
  27.     <LI><A HREF="#example">EXAMPLE</A></LI>
  28.     <LI><A HREF="#see also">SEE ALSO</A></LI>
  29.     <LI><A HREF="#keywords">KEYWORDS</A></LI>
  30. </UL>
  31. <!-- INDEX END -->
  32.  
  33. <HR>
  34. <P>
  35. <H1><A NAME="name">NAME</A></H1>
  36. <P>getOpenFile, getSaveFile - pop up a dialog box for the user to select a file to open or save.</P>
  37. <P>
  38. <HR>
  39. <H1><A NAME="supportedplatforms">SUPPORTED PLATFORMS</A></H1>
  40. <UL>
  41. <LI>Linux</LI>
  42. <LI>Solaris</LI>
  43. <LI>Windows</LI>
  44. </UL>
  45. <HR>
  46. <H1><A NAME="synopsis">SYNOPSIS</A></H1>
  47. <P>    <EM>$widget</EM>-><STRONG>getOpenFile</STRONG>(?<EM>-option</EM>=>value, ...>?)</P>
  48. <P>    <EM>$widget</EM>-><STRONG>getSaveFile</STRONG>(?<EM>-option</EM>=>value, ...>?)</P>
  49. <P>
  50. <HR>
  51. <H1><A NAME="description">DESCRIPTION</A></H1>
  52. <P>The methods <STRONG>getOpenFile</STRONG> and <STRONG>getSaveFile</STRONG> pop up a
  53. dialog box for the user to select a file to open or save.</P>
  54. <P>The <STRONG>getOpenFile</STRONG> method is usually associated with the <STRONG>Open</STRONG>
  55. command in the <STRONG>File</STRONG> menu.  Its purpose is for the user to select an
  56. existing file <EM>only</EM>.  If the user enters an non-existent file, the
  57. dialog box gives the user an error prompt and requires the user to give
  58. an alternative selection. If an application allows the user to create
  59. new files, it should do so by providing a separate <STRONG>New</STRONG> menu command.</P>
  60. <P>The <STRONG>getSaveFile</STRONG> method is usually associated with the <STRONG>Save</STRONG>
  61. as command in the <STRONG>File</STRONG> menu. If the user enters a file that
  62. already exists, the dialog box prompts the user for confirmation
  63. whether the existing file should be overwritten or not.</P>
  64. <P>If the user selects a file, both <STRONG>getOpenFile</STRONG> and
  65. <STRONG>getSaveFile</STRONG> return the full pathname of this file. If the
  66. user cancels the operation, both commands return an undefined value.</P>
  67. <P>The following <EM>option-value</EM> pairs are possible as command line
  68. arguments to these two commands:</P>
  69. <DL>
  70. <DT><STRONG><A NAME="item_%2Ddefaultextension_%3D%3E_extension"><STRONG>-defaultextension</STRONG> => <EM>extension</EM></A></STRONG><BR>
  71. <DD>
  72. Specifies a string that will be appended to the filename if the user
  73. enters a filename without an extension. The default value is the empty
  74. string, which means no extension will be appended to the filename in
  75. any case. This option is ignored on the Macintosh platform, which
  76. does not require extensions to filenames.
  77. <P></P>
  78. <DT><STRONG><A NAME="item_%2Dfiletypes_%3D%3E_%5BfilePattern_%3F%2C_%2E%2E%2"><STRONG>-filetypes</STRONG> => [<EM>filePattern</EM> ?, ...?]</A></STRONG><BR>
  79. <DD>
  80. If a <STRONG>File types</STRONG> listbox exists in the file dialog on the particular
  81. platform, this option gives the <EM>filetype</EM>s in this listbox. When
  82. the user choose a filetype in the listbox, only the files of that type
  83. are listed. If this option is unspecified, or if it is set to the
  84. empty list, or if the <STRONG>File types</STRONG> listbox is not supported by the
  85. particular platform then all files are listed regardless of their
  86. types. See <A HREF="#specifying file patterns">SPECIFYING FILE PATTERNS</A> below for a
  87. discussion on the contents of <EM>filePattern</EM>s.
  88. <P></P>
  89. <DT><STRONG><A NAME="item_%2Dinitialdir_%3D%3E_directory"><STRONG>-initialdir</STRONG> => <EM>directory</EM></A></STRONG><BR>
  90. <DD>
  91. Specifies that the files in <EM>directory</EM> should be displayed
  92. when the dialog pops up. If this parameter is not specified, then
  93. the files in the current working directory are displayed.  This
  94. option may not always work on the Macintosh.  This is not a bug.
  95. Rather, the <EM>General Controls</EM> control panel on the Mac allows the
  96. end user to override the application default directory.
  97. <P></P>
  98. <DT><STRONG><A NAME="item_%2Dinitialfile_%3D%3E_filename"><STRONG>-initialfile</STRONG> => <EM>filename</EM></A></STRONG><BR>
  99. <DD>
  100. Specifies a filename to be displayed in the dialog when it pops
  101. up. This option is ignored by the <STRONG>getOpenFile</STRONG> method.
  102. <P></P>
  103. <DT><STRONG><A NAME="item_%2Dtitle_%3D%3E_titleString"><STRONG>-title</STRONG> => <EM>titleString</EM></A></STRONG><BR>
  104. <DD>
  105. Specifies a string to display as the title of the dialog box. If this
  106. option is not specified, then a default title is displayed. This
  107. option is ignored on the Macintosh platform.
  108. <P></P></DL>
  109. <P>
  110. <HR>
  111. <H1><A NAME="specifying file patterns">SPECIFYING FILE PATTERNS</A></H1>
  112. <P>The <EM>filePattern</EM>s given by the <STRONG>-filetypes</STRONG> option
  113. are a list of file patterns. Each file pattern is a list of the
  114. form</P>
  115. <PRE>
  116.  typeName [extension ?extension ...?] ?[macType ?macType ...?]?</PRE>
  117. <P><EM>typeName</EM> is the name of the file type described by this
  118. file pattern and is the text string that appears in the <STRONG>File types</STRONG>
  119. listbox. <EM>extension</EM> is a file extension for this file pattern.
  120. <EM>macType</EM> is a four-character Macintosh file type. The list of
  121. <EM>macType</EM>s is optional and may be omitted for applications that do
  122. not need to execute on the Macintosh platform.</P>
  123. <P>Several file patterns may have the same <EM>typeName,</EM> in which case
  124. they refer to the same file type and share the same entry in the
  125. listbox. When the user selects an entry in the listbox, all the files
  126. that match at least one of the file patterns corresponding
  127. to that entry are listed. Usually, each file pattern corresponds to a
  128. distinct type of file. The use of more than one file patterns for one
  129. type of file is necessary on the Macintosh platform only.</P>
  130. <P>On the Macintosh platform, a file matches a file pattern if its
  131. name matches at least one of the <EM>extension</EM>(s) AND it
  132. belongs to at least one of the <EM>macType</EM>(s) of the
  133. file pattern. For example, the <STRONG>C Source Files</STRONG> file pattern in the
  134. sample code matches with files that have a <STRONG>\.c</STRONG> extension AND
  135. belong to the <EM>macType</EM> <STRONG>TEXT</STRONG>. To use the OR rule instead,
  136. you can use two file patterns, one with the <EM>extensions</EM> only and
  137. the other with the <EM>macType</EM> only. The <STRONG>GIF Files</STRONG> file type
  138. in the sample code matches files that EITHER have a <STRONG>\.gif</STRONG>
  139. extension OR belong to the <EM>macType</EM> <STRONG>GIFF</STRONG>.</P>
  140. <P>On the Unix and Windows platforms, a file matches a file pattern
  141. if its name matches at at least one of the <EM>extension</EM>(s) of
  142. the file pattern. The <EM>macType</EM>s are ignored.</P>
  143. <P>
  144. <HR>
  145. <H1><A NAME="specifying extensions">SPECIFYING EXTENSIONS</A></H1>
  146. <P>On the Unix and Macintosh platforms, extensions are matched using
  147. glob-style pattern matching. On the Windows platforms, extensions are
  148. matched by the underlying operating system. The types of possible
  149. extensions are: (1) the special extension * matches any
  150. file; (2) the special extension ``'' matches any files that
  151. do not have an extension (i.e., the filename contains no full stop
  152. character); (3) any character string that does not contain any wild
  153. card characters (* and ?).</P>
  154. <P>Due to the different pattern matching rules on the various platforms,
  155. to ensure portability, wild card characters are not allowed in the
  156. extensions, except as in the special extension *. Extensions
  157. without a full stop character (e.g, ~) are allowed but may not
  158. work on all platforms.</P>
  159. <P>
  160. <HR>
  161. <H1><A NAME="example">EXAMPLE</A></H1>
  162. <PRE>
  163.  my $types = [
  164.      ['Text Files',       ['.txt', '.text']],
  165.      ['TCL Scripts',      '.tcl'           ],
  166.      ['C Source Files',   '.c',      'TEXT'],
  167.      ['GIF Files',        '.gif',          ],
  168.      ['GIF Files',        '',        'GIFF'],
  169.      ['All Files',        '*',             ],
  170.  ];
  171.  my $filename = $widget->getOpenFile(-filetypes=>$types);</PRE>
  172. <PRE>
  173.  if ($filename ne "") {
  174.      # Open the file ...
  175.  }</PRE>
  176. <P>
  177. <HR>
  178. <H1><A NAME="see also">SEE ALSO</A></H1>
  179. <P><A HREF="../../../site/lib/Tk/FBox.html">Tk::FBox</A>, <A HREF="../../../site/lib/Tk/FileSelect.html">Tk::FileSelect</A></P>
  180. <P>
  181. <HR>
  182. <H1><A NAME="keywords">KEYWORDS</A></H1>
  183. <P>file selection dialog</P>
  184. <TABLE BORDER=0 CELLPADDING=0 CELLSPACING=0 WIDTH=100%>
  185. <TR><TD CLASS=block VALIGN=MIDDLE WIDTH=100% BGCOLOR="#cccccc">
  186. <STRONG><P CLASS=block> getSaveFile - pop up a dialog box for the user to select a file to open or save.</P></STRONG>
  187. </TD></TR>
  188. </TABLE>
  189.  
  190. </BODY>
  191.  
  192. </HTML>
  193.