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

### 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

option — 指示項目基礎データ へ/から 窓の指示項目を 追加/取出 す　Add/retrieve window options to/from the option database

### 構文 SYNOPSIS

option add pattern value ?priority?
option clear
option get window name class
option readfile fileName ?priority?

### 説明 DESCRIPTION

この option 命令は Tk の指示項目基本データに見出しを追加することと基本データから指示項目を取出すことを許容する｡ 命令の add の形式は新しい指示項目を基本データに追加する｡ pattern は指定された指示項目を含み､星印又は点に隔てられた 名前 及び/又は 級 から構成され､通常の X の書式( PATTERN FORMAT を参照されたい)である｡ value は pattern と結合した文書文字列を含む; これは Tk_GetOption への呼出し､又は option get 命令から返される値である｡もし priority が指定されているとそれは指示項目の為の優先順位である(適正な値については下を参照); その省略時設定は interactive である｡この命令は常に空文字列を返す｡ The option command allows you to add entries to the Tk option database or to retrieve options from the database. The add form of the command adds a new option to the database. Pattern contains the option being specified, and consists of names and/or classes separated by asterisks or dots, in the usual X format (see PATTERN FORMAT). Value contains a text string to associate with pattern; this is the value that will be returned in calls to Tk_GetOption or by invocations of the option get command. If priority is specified, it indicates the priority level for this option (see below for legal values); it defaults to interactive. This command always returns an empty string.

option clear 命令は指示項目の基礎データを刷新する｡省略時設定の指示項目(RESOURCE_MANAGER 資産由来､又は .Xdefaults ファイル)が自動的に再組込みされる､次回､指示項目が基礎データに取去られ､又は､追加される｡この命令は常に空文字列を返す｡ The option clear command clears the option database. Default options (from the RESOURCE_MANAGER property or the .Xdefaults file) will be reloaded automatically the next time an option is added to the database or removed from it. This command always returns an empty string.

option get 命令は name と class の下で window の為に指定された指示項目の値を返す｡もし指示項目基礎データ内に window と name と class とに合致する複数の見出しがあると､その命令はどれであれ最高の priority 水準で作成されたものを返す｡もし同じ優先順位に幾つかの見出しが合致すると､どれであれ､最も後に指示項目基礎データに入れられたものを返す｡もし合致する見出しがないと､空文字列を返す｡ The option get command returns the value of the option specified for window under name and class. If several entries in the option database match window, name, and class, then the command returns whichever was created with highest priority level. If there are several matching entries at the same priority level, then it returns whichever entry was most recently entered into the option database. If there are no matching entries, then the empty string is returned.

この命令の readfile 形式は fileName を読む､それは .Xdefaults の様な X 資産の為の標準的な形式を有するはずで､その基礎データへのファイル内の指定された全ての指示項目を追加する｡もし priority が指定されているとそれは指示項目に加える優先水準を指し示す; その省略時設定は interactive である｡ The readfile form of the command reads fileName, which should have the standard format for an X resource database such as .Xdefaults, and adds all the options specified in that file to the option database. If priority is specified, it indicates the priority level at which to enter the options; priority defaults to interactive.

ファイルは通信路を通じて読まれ､それは "utf-8" 符号化され､不正なバイト並びは自動的に正当なものに変換される｡ これは､ ISO 8859-1 や cp1252 は高い確率で有効に動作することを意味するが､保障はできない｡ このことは変更できない､ [encoding system] の設定は意味を持たない｡ The file is read through a channel which is in "utf-8" encoding, invalid byte sequences are automatically converted to valid ones. This means that encodings like ISO 8859-1 or cp1252 with high probability will work as well, but this cannot be guaranteed. This cannot be changed, setting the [encoding system] has no effect.

option 命令への priority 引数 は通常､次の値の内の一つを使って象徴的に指定される｡ The priority arguments to the option command are normally specified symbolically using one of the following values:

widgetDefault3
  Level 20. Used for default values hard-coded into widgets.

startupFile
  水準 40. 応用譜に特化した初期設定ファイルの指示項目に使用する｡ Level 40. Used for options specified in application-specific startup files.

userDefault
  水準 60. .Xdefaults や､ X 中央集中処理機能に組込まれた資産基礎データや､使用者指定の開始ファイルのような､使用者が指定した省略時設定のファイルに指定された指示項目に使用する｡ Level 60. Used for options specified in user-specific defaults files, such as .Xdefaults, resource databases loaded into the X server, or user-specific startup files.

interactive
  水準 80. 応用譜が実行開始された後に対話的に指定された指示項目に使う｡もし priority が指定されないと､省略時設定はこの水準｡ Level 80. Used for options specified interactively after the application starts running. If priority is not specified, it defaults to this level.

上のどの用語も短縮してよい｡更に､優先順位は 0 と 100 とその間の整数を遣って数字で指定しても良い｡数字の形式は､上に与えたもの以外の新しい優先順位以外では余りよい方法ではない｡ Any of the above keywords may be abbreviated. In addition, priorities may be specified numerically using integers between 0 and 100, inclusive. The numeric form is probably a bad idea except for new priority levels other than the ones given above.

### PATTERN FORMAT

模様はピリオド “.” か星印 “*” かで区切られた語の並びで構成される｡全体としての模様に星印が先頭に追加的に付いてもよい｡ Patterns consist of a sequence of words separated by either periods, “.”, or asterisks “*”. The overall pattern may also be optionally preceded by an asterisk.

模様の中の書く語は慣習的に部品化指示項目を表すときは､大文字か(その場合､部品か指示項目かの級を表す)他のどの文字化で始まる｡模様の最後の語は常に指示項目を現す; その前は､その指示項目が対象とする部品に限られる｡ Each word in the pattern conventionally starts with either an upper-case letter (in which case it denotes the class of either a widget or an option) or any other character, when it denotes the name of a widget or option. The last word in the pattern always indicates the option; the preceding ones constrain which widgets that option will be looked for in.

二つの語がピリオドで区切られている場合､後の語は前の語の直接の子供でなければならない(でなければ､指示項目は指し示された部品のみに適用されねばならない)｡二つの語が星印で区切られている場合､前の語と後の語の間にどの様な深さの部品があってもよい(指示項目は前の部品の全ての子供の部品に適用される)｡ When two words are separated by a period, the latter widget must be a direct child of the former (or the option must apply to only the indicated widgets). When two words are separated by an asterisk, any depth of widgets may lie between the former and latter widgets (and the option applies to all widgets that are children of the former widget).

もし全体としての模様に星印が先頭に付いる場合､全体の模様は何処であれ部品の階層構造全体を通して適用可能である｡そうでない場合､模様の初めの語は名前と級の “.” toplevel に合致する､それは通常 wish に対する指示項目に設定される｡ If the overall pattern is preceded by an asterisk, then the overall pattern applies anywhere it can throughout the whole widget hierarchy. Otherwise the first word of the pattern is matched against the name and class of the “.” toplevel, which are usually set by options to wish.

### 用例 EXAMPLES

応用譜の中の全ての釦に､明示的に上書きされない限り赤い文書を有する様に､ Button 級のための foreground を設定することにより､指導する(註意すべきは､どれかのOSではこの指示項目は無視される): Instruct every button in the application to have red text on it unless explicitly overridden, by setting the foreground for the Button class (note that on some platforms the option is ignored):

    option add *Button.foreground red startupFile

指示項目基礎データ中の記述譜に指定して省略時設定の指示項目に鐘を鳴らすものを追加して入力鍵が押された時に入り口部品内に何が起るかを制御することを許容する: Allow users to control what happens in an entry widget when the Return key is pressed by specifying a script in the option database and add a default option for that which rings the bell:

    entry .e
    bind .e <Return> [option get .e returnCommand Command]
    option add *.e.returnCommand bell widgetDefault

### SEE ALSO

options, wish

### KEYWORDS

database, option, priority, retrieve
Copyright © 1990 The Regents of the University of California.
Copyright © 1994-1996 Sun Microsystems, Inc.