## Tcl9.0.3/Tk9.0.3 Documentation > Tk Commands > getOpenFile

### 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_getOpenFile, tk_getSaveFile — 開いたり保存したりする為のファイルの選択に使う対話箱を出現させる pop up a dialog box for the user to select a file to open or save.
  構文 SYNOPSIS
  説明 DESCRIPTION
    -command string
    -confirmoverwrite boolean
    -defaultextension extension
    -filetypes filePatternList
    -initialdir directory
    -initialfile filename
    -message string
    -multiple boolean
    -parent window
    -title titleString
    -typevariable variableName
  ファイル紋様の指定 SPECIFYING FILE PATTERNS
  拡張子の指定　SPECIFYING EXTENSIONS
  実施例 EXAMPLE
  SEE ALSO
  KEYWORDS

### NAME

tk_getOpenFile, tk_getSaveFile — 開いたり保存したりする為のファイルの選択に使う対話箱を出現させる pop up a dialog box for the user to select a file to open or save.

### 構文 SYNOPSIS

tk_getOpenFile ?option value ...?
tk_getSaveFile ?option value ...?

### 説明 DESCRIPTION

手続函数 tk_getOpenFile と tk_getSaveFile は開いたり保存したりする為のファイルの選択に使う対話箱を出現させる｡ tk_getOpenFile 命令は通常は File 指示項目命令内で Open 命令と連携して使われる｡使用者に関して､既存のファイルのみを選択することのみがその目的である｡もし､使用者が実在しないファイルを入力すると､対話箱は不都合の入力促進文字を与え､代わりの選択を与える｡もし応用譜が使用者に新しいファイルの作成を許容する場合は､別途 New 指示項目命令を提供する｡ The procedures tk_getOpenFile and tk_getSaveFile pop up a dialog box for the user to select a file to open or save. The tk_getOpenFile command is usually associated with the Open command in the File menu. Its purpose is for the user to select an existing file only. If the user enters a non-existent file, the dialog box gives the user an error prompt and requires the user to give an alternative selection. If an application allows the user to create new files, it should do so by providing a separate New menu command.

tk_getSaveFile 命令は通常は File 指示項目命令内で Save as 命令と連携して使われる｡もし､使用者が既に実在するファイルを入れると､対話箱が使用者に既存のファイルが上書きされてもよいかどうかの確認をする｡ The tk_getSaveFile command is usually associated with the Save as command in the File menu. If the user enters a file that already exists, the dialog box prompts the user for confirmation whether the existing file should be overwritten or not.

次の指示項目-値 対が命令行引数としてこれら二つの命令に可能である: The following option-value pairs are possible as command line arguments to these two commands:

-command string
  これは macOS でのみ利用できる｡使用者が品目を選択した後に質問箱を閉じる時に起動する為の Tcl 命令の前置辞を指定する｡この呼び戻しは､使用者が質問箱を解消した時は呼出されない｡実際の命令は空白に続く文字列と質問箱から使用者に選ばれた値とから構成される｡　　　　　　 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.

-confirmoverwrite boolean
  ファイルが実在し保存するとそれを上書きする時､保存対話箱が如何に対応するかの構成設定｡真値は使用者に確認対話箱を見せることを要求する｡偽値は確認なしに上書きすることを要求する｡無為設定は真値｡　　　　　　 Configures how the Save dialog reacts when the selected file already exists, and saving would overwrite it. A true value requests a confirmation dialog be presented to the user. A false value requests that the overwrite take place without confirmation. Default value is true.

-defaultextension extension
  使用者が拡張子なしのファイル名を入力した場合､ファイル名に追加する文字列を指定する｡無為設定は空文字列であり､その意味は如何なる場合にも拡張子を追加しないことを意味する｡この指示項目は macOS では無視される､そこではファイル名に拡張子は要求しない､又 UNIX 実装ではこれが運営されていない場合は -filetypes 指示項目により合理的な値が推定される｡　　　　　 Specifies a string that will be appended to the filename if the user enters a filename without an extension. The default value is the empty string, which means no extension will be appended to the filename in any case. This option is ignored on macOS, which does not require extensions to filenames, and the UNIX implementation guesses reasonable values for this from the -filetypes option when this is not supplied.

-filetypes filePatternList
  もし､特定のOSで File types リスト箱がファイル対話箱内にあると､この指示項目はこのリスト箱内に filetypes を与える｡もし使用者がこのリスト箱内でファイルの型を選ぶと､その型のファイルのみが列挙される｡もしこの指示項目が指定されないか､又は空リストが設定されているか､又は File types がOSによって運営されていない場合はその型を考慮せず全てのファイルが列挙される｡ filePatternList の中身の論議については下の SPECIFYING FILE PATTERNS の節を参照されたい｡　　　 If a File types listbox exists in the file dialog on the particular platform, this option gives the filetypes in this listbox. When the user choose a filetype in the listbox, only the files of that type are listed. If this option is unspecified, or if it is set to the empty list, or if the File types listbox is not supported by the particular platform then all files are listed regardless of their types. See the section SPECIFYING FILE PATTERNS below for a discussion on the contents of filePatternList.

-initialdir directory
  対話箱が現れた時に展示されるファイルが入っている directory を指定する｡もし､この媒介変数が指定されていないと､Windows 以外の系と Vista より前の Windows 系では初期ディレクトリーとして現作動ディレクトリーが無為設定となる｡ Vista とそれ以降の系では､初期ディレクトリーとして､その応用譜で使用者が最後に開いたディレクトリーが無為設定となる｡もし媒介変数が相対経路で指定されると返り値は､相対値から絶対値に変換される｡　　　　　 Specifies that the files 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.

-initialfile filename
  対話箱が出現した時にその中に展示されるファイル名を指定する｡ 　　　　　 Specifies a filename to be displayed in the dialog when it pops up.

-message string
  これは macOS 上のみに有効である｡対話箱内の依頼者領域内に含まれる伝達文を指定する｡　　　　 Specifies a message to include in the client area of the dialog. This is only available on macOS.

-multiple boolean
  使用者に対話箱から複数のファイル選択を許容する｡　　　　　　 Allows the user to choose multiple files from the Open dialog.

-parent window
  window をファイル対話箱の論理的親にする｡このファイル対話箱はその親の上に展示される｡ macOS 上では､ファイル対話箱が親の窓に付着した短冊になる｡　　　　　　 Makes window the logical parent of the file dialog. The file 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 is displayed.

-typevariable variableName
  対話箱が開いた時に､大域変数 variableName は filterList からどの櫛を使うか予備選択に使用され､対話箱が閉じる時に､最後に撰んだ櫛に更新される｡変数は適切な櫛を選ぶ為に最初に一度読み出される｡もし､変数が実在しないか､その値がどの櫛のファイル型にも合致しないか､空({})であると､対話箱はリスト内の最初の櫛を選択する無為設定の振舞いに戻る｡もし対話箱が解約されると変数は修正されない｡　　　　　 The global variable variableName is used to preselect which filter is used from filterList when the dialog box is opened and is updated when the dialog box is closed, to the last selected filter. The variable is read once at the beginning to select the appropriate filter. If the variable does not exist, or its value does not match any filter typename, or is empty ({}), the dialog box will revert to the default behavior of selecting the first filter in the list. If the dialog is canceled, the variable is not modified.

もし使用者がファイルを選ぶと tk_getOpenFile と tk_getSaveFile は両方ともファイルの完全名称を返す｡もし使用者が操作を解約すると両方とも空文字列を返す｡　　　　　 If the user selects a file, both tk_getOpenFile and tk_getSaveFile return the full pathname of this file. If the user cancels the operation, both commands return the empty string.

### ファイル紋様の指定 SPECIFYING FILE PATTERNS

-filetypes 指示項目によって与えられる filePatternList の値はファイルの模様のリストである｡それぞれのファイルの模様は次のリスト形式である　　　　　　 The filePatternList value given by the -filetypes option is a list of file patterns. Each file pattern is a list of the form

    typeName {extension ?extension ...?} ?{macType ?macType ...?}?

typeName はファイルの型の名前でこのファイル模様で記述され､そして､それは File types リスト箱内に現れる文書文字列である｡ extension はファイル模様のファイルの拡張子である｡macType はマッキントッシュの４文字ファイル型である｡macType のリストは選択的でマッキントッシュOS上で実行する必要のない応用譜では省略してもよい｡ typeName is the name of the file type described by this file pattern and is the text string that appears in the File types listbox. extension is a file extension for this file pattern. macType is a four-character Macintosh file type. The list of macTypes is optional and may be omitted for applications that do not need to execute on the Macintosh platform.

幾つかのファイル模様が同じ typeName を有するかもしれない､その場合､それらは同じファイル型を参照し､リスト箱内の同じ見出しを共有する｡使用者がリスト箱内の見出しを選択した時､その見出しに対応する､少なくとも一つのファイル模様に合致する全てのファイルが列挙される｡通常､それぞれのファイル模様は別々の型のファイルに対応する｡ファイルの型について一つより多いファイル模様の利用はマッキントッシュOS上のみで必要である｡ 　　　　　　 Several file patterns may have the same typeName, in which case they refer to the same file type and share the same entry in the listbox. When the user selects an entry in the listbox, all the files that match at least one of the file patterns corresponding to that entry are listed. Usually, each file pattern corresponds to a distinct type of file. The use of more than one file pattern for one type of file is only necessary on the Macintosh platform.

マッキントッシュOS上では､その名前が少なくとも一つの拡張子に合致し且つ､ファイル模様の macType(s) の一つに属するならば､ファイルはファイル模様に合致する｡譬えば､用例の命令符号内の C Source Files のファイル模様は .c 拡張子を有し､且つマック型文書に属するファイルに合致する｡代りに論理和の規則を利用するには､片方は拡張子のみを伴うものと､他方はマック型のみを伴うものの､二つのファイル模様を使用できる｡用例の命令符号内のギフファイル型は .gif 拡張子を有するか若しくはマック型ギフに属する｡　　　　　 On the Macintosh platform, a file matches a file pattern if its name matches at least one of the extension(s) AND it belongs to at least one of the macType(s) of the file pattern. For example, the C Source Files file pattern in the sample code matches with files that have a .c extension AND belong to the macType TEXT. To use the OR rule instead, you can use two file patterns, one with the extensions only and the other with the macType only. The GIF Files file type in the sample code matches files that either have a .gif extension OR belong to the macType GIFF.

Unix と Windows では少なくともファイル模様の拡張子の一つに名前が合致するとファイルはファイル模様に合致する｡マック型は無視される｡ 　　　　　　 On the Unix and Windows platforms, a file matches a file pattern if its name matches at least one of the extension(s) of the file pattern. The macTypes are ignored.

### 拡張子の指定　SPECIFYING EXTENSIONS

ユニクスとマック上では拡張子は､展開型の文様合致則を使って合致される｡Winでは拡張子は基礎になっているOS系により合致される｡可能な拡張子の型は次の通り:　　　　 On the Unix and Macintosh platforms, extensions are matched using glob-style pattern matching. On the Windows platform, extensions are matched by the underlying operating system. The types of possible extensions are:

1. どのファイルにも合致する特別な拡張子 “*” ;　　　 the special extension “*” matches any file;

2. どのファイルにも合致する特別な拡張子 “” (即ち､終止符を含まないファイル名);　　　　　　 the special extension “” matches any files that do not have an extension (i.e., the filename contains no full stop character);

3. 展開できるどのような特別な文字（* や ?）も含まない任意の文字列｡　　　　　 any character string that does not contain any wild card characters (* and ?).

種々のOS上に異なる模様合致則があるので､互換性を確保する為に､拡張子に対しては展開できる特別な文字を許容していない､但し特別な拡張子 “*” は例外である｡終始符号を含まない拡張子(譬えば “~”) は許容されているが全てのOSで動くとは限らない｡　　　　　　 Due to the different pattern matching rules on the various platforms, to ensure portability, wild card characters are not allowed in the extensions, except as in the special extension “*”. Extensions without a full stop character (e.g. “~”) are allowed but may not work on all platforms.

### 実施例 EXAMPLE

    set types {
        {{Text Files}       {.txt}        }
        {{TCL Scripts}      {.tcl}        }
        {{C Source Files}   {.c}      TEXT}
        {{GIF Files}        {.gif}        }
        {{GIF Files}        {}        GIFF}
        {{All Files}        *             }
    }
    set filename [tk_getOpenFile -filetypes $types]

    if {$filename ne ""} {
        # ファイルを開ける
        # Open the file ...
    }

### SEE ALSO

tk_chooseDirectory

### KEYWORDS

file selection dialog
Copyright © 1996 Sun Microsystems, Inc.