このホームページは Amazon Kindle 本の作成中の草稿です。日々、原稿を見直しているので、内容が変わることに留意して読んで下さい。本が出版され次第、このホームページは削除されます。
標準オプション
tkinter のウィジェットに提供されるオプションには共通の標準オプションが定義されています。個々のウィジェットが全ての標準オプションを持っているわけではありませんが、オプションが標準オプションと同じ名前を持つ場合、通常、それらのオプションの定義は標準オプションと同じです。ウィジェットによっては、標準オプションと同じ名前の固有オプションが定義されています。これは、標準オプションにウィジェット固有の属性が加えられて定義されて、この場合、この固有オプションの定義が用いられます。
標準オプション
activebackground | アクティブなときの背景色。 色を文字列で指定します。A1.3 色を参照して下さい。 ウィジェットまたはその要素はマウスカーソルがその上に置かれたときにアクティブになります。ただし、この場合の背景色の描画はシステムによって行なわれるのでシステム依存があります。Windows では、ウィジェットのアクティブ時の背景色にはこのオプションを使用しません。代わりに通常の背景色が使用されます。 固有オプションとして「state」オプションを持つウィジェットは、「state」オプションに「active」を指定することでアクティブにすることができ、背景色はこのオプションが用いられます。 |
activeborderwidth | アクティブな要素の周囲に描画される 3D 境界線の幅。 値を設定単位で指定します。A1.1 位置、サイズ単位を参照して下さい。 アクティブについては「activebackground」オプションの説明を参照して下さい。このオプションは標準オプションで定義されていますが、「Menu」ウィジェットでしか使用されていません。 Windows では 境界線の幅は設定されますが、3D 境界線は描画されません。 |
activeforeground | アクティブなときの前景色。 色を文字列で指定します。A1.3 色を参照して下さい。 アクティブについては「activebackground」オプションの説明を参照して下さい。 テキストを表示するウィジェットの場合、テキストの文字色です。 |
anchor | ウィジェット内情報の表示方法。 テキストまたはビットマップなどをウィジェットに表示する方法を「 n」、「ne」、「e」、「se」、「s」、「sw」、「w」、「nw」、「center」のいずれかの文字列で指定します。例えば、「nw」は、左上隅がウィジェットの左上隅になるように情報を表示することを意味します。A1.5 アンカーを参照して下さい。 |
background または bg | ウィジェットの背景色。 色を文字列で指定します。A1.3 色を参照して下さい。 |
bitmap | ウィジェットに表示するビットマップ。 組み込みビットマップはその名前のビットマップ定数を指定します。ユーザが作成したビットマップは X bitmap フォーマットのファイル(「xbm」ファイル)で、ファイルパス名の最初に「@」をつけて指定することができます。A1.7 登録ビットマップを参照して下さい。 ビットマップが表示される位置は「anchor」、「justify」などの他のオプションの影響を受ける場合があります。 通常、このオプションを指定すると、ビットマップはテキスト値のオプションに上書きされますが、「compound」 オプションを使用すると、両方の表示を制御することができます。「bitmap」オプションに空の文字を設定することで、ビットマップの指定を無効にすることができます。 「bitmap」と「image」オプションの両方を持つウィジェットでは、「image」オプションが優先されます。 |
borderwidth または bd | ウィジェットの周囲に描画される 3D 境界線の幅。 値を設定単位で指定します。A1.1 位置、サイズ単位を参照して下さい。 境界線の描画形状は「relief」オプションで指定します。 通常、境界線はウィジェットの内側に描かれます。また、「padx」、「pady」オプションでウィジェットの内側にパッディングが設定されている場合、その外側に描かれます。 ウィジェットによっては、ウィジェットの外側の周囲に描画するものもあります。 このオプションの指定で、ウィジェットの内側の座標の原点がこの境界線の内側に移動することに注意します。 |
cursor | ウィジェットにマウスがあるときのカーソル形状。 tkinter で用意されているカーソル形状を文字列(カーソル定数)で指定します。A1.8 登録マウスカーソルを参照して下さい。 空の文字列を指定すると、カーソル形状は システム に委ねられます。 |
compound | テキストに対するビットマップまたはイメージの表示位置。 文字列「none」、「bottom」、「top」、「left」、「right」、「center」で指定します。「none」はテキストを表示しません。「bottom」は下側、「top」は上側、「left」は左側、「right」は右側、「center」はテキストに重ねて中心に表示します。デフォルトでは「none」に設定されています。 |
disabledforeground | 無効状態のウィジェットの前景色。 色を文字列で指定します。A1.3 色を参照して下さい。 テキストを表示するウィジェットの場合、テキストの文字色です。ビットマップを表示するウィジェットの場合、ビットの「1」の色です。 空文字を指定した場合、ウィジェットの通常の前景色が使用されますが、点描の塗りつぶしパターンで描画されることによって淡色表示されます。 |
exportselection | ウィジェットでの要素の選択モード。 「True」、「False」の論理値、または「1」、「0」の論理値として解釈される値、または「yes」、「no」の文字列で指定します。 「True」、「1」、「yes」を指定すると、選択要素の内容が tcl クリップボードにコピーされます。また、他のウィジェットに選択が移ると現在の選択は解除されます。デフォルトです。 「False」、「0」、「no」を指定すると、選択要素の内容は tcl クリップボードにコピーされません。また、他のウィジェットに選択が移っても現在の選択は解除されません。 要素を選択するリストボックスなどのウィジェットで使用されます。 |
font | フォント。 テキストのフォントを指定します。A1.4 フォントを参照して下さい。 |
foreground または fg | 通常状態のウィジェットの前景色。 色を文字列で指定します。A1.3 色を参照して下さい。 テキストを表示するウィジェットの場合、テキストの文字色です。ビットマップを表示するウィジェットの場合、ビットの「1」の色です。 |
highlightbackground | フォーカスがないときのハイライト色。 色を文字列で指定します。A1.3 色を参照して下さい。 ハイライト枠が設定されている場合、フォーカスがないときの枠の色を指定します。 ハイライト枠は「highlightthickness」オプションで指定します。枠の幅が「0」のときは描かれません。 Windows では、このオプションはシステムが利用しているため、ウィジェットによっては動作しません。 |
highlightcolor | フォーカスがあるときのハイライト色。 色を文字列で指定します。A1.3 色を参照して下さい。 ハイライト枠が設定されている場合、フォーカスがあるときの枠の色を指定します。 ハイライト枠は「highlightthickness」オプションで指定します。枠の幅が「0」のときは描かれません。 Windows では、このオプションはシステムが利用しているため、ウィジェットによっては動作しません。 |
highlightthickness | ハイライト枠の幅。 値を設定単位で指定します。A1.1 位置、サイズ単位を参照して下さい。 「highlightbackground」、「highlightcolor」オプションで指定したハイライトを描く枠の幅を指定します。枠の幅が「0」のときはハイライトは描かれません。 ハイライト枠はウィジェットの境界枠の外側に描かれます。この幅はウィジェットのサイズに含まれます。 |
image | ウィジェットに表示するイメージ画像 「PhotoImage」または「BitmapImage」から作成された名前付きイメージオブジェクトの名前を指定します。A1.9 イメージを参照して下さい。 イメージが表示される位置は「anchor」、「justify」などの他のオプションの影響を受ける場合があります。 通常、このオプションを指定すると、イメージはテキスト値のオプションに上書きされますが、「compound」 オプションを使用すると、両方の表示を制御することができます。「image」オプションに空の文字を設定することで、イメージの指定を無効にすることができます。 「image」と「bitmap」オプションの両方を持つウィジェットでは、「image」オプションが優先されます。 |
insertbackground | 挿入カーソルの背景色。 色を文字列で指定します。A1.3 色を参照して下さい。 テキストを入力するウィジェットにおいて、文字を挿入するカーソルの背景色を指定します。 通常、この色は、ウィジェットの通常の背景、または、挿入カーソルが選択範囲にかかっている場合は選択背景の上に描画されます。 |
insertborderwidth | 挿入カーソルの周囲に描画される 3D 境界線の幅。 値を設定単位で指定します。A1.1 位置、サイズ単位を参照して下さい。 境界線の描画形状はシステムで設定され、カーソルの内側に描かれます。 カーソルの幅を設定する「insertwidth」オプションの値を超える場合は、描画はその範囲内に制限されます。 |
insertofftime | 挿入カーソルの点滅のオフ時間。 挿入カーソルがオフの状態の時間をミリ秒単位の整数値で指定します。 値に「0」を設定すると、カーソルは点滅しないで常に点灯した状態になります。 |
insertontime | 挿入カーソルの点滅のオン時間。 挿入カーソルがオンの状態の時間をミリ秒単位の整数値で指定します。 値に「0」を設定すると、カーソルは表示しない状態になります。 |
insertwidth | 挿入カーソルの全体の幅。 値を設定単位で指定します。A1.1 位置、サイズ単位を参照して下さい。 「insertborderwidth」オプションで境界線が指定されている場合、境界線はこのオプションで指定した幅の内側に描画されます。 |
jump | スライダー通知設定。 「True」、「False」の論理値、または「1」、「0」の論理値として解釈される値、または「yes」、「no」の文字列で指定します。 スクロールバーなど、ドラッグして値を調整できるスライダーを備えたウィジェットにおいて、スライダーの位置の変更に関する通知のタイミングを設定します。「True」を設定すると、通知はスライダーのドラッグをマウスボタンを離して終了する時点で行われます。「False」はドラッグ中に通知が継続的に行われ、デフォルトです。 このオプションは、Windows では動作しません。 |
justify | テキストの配置。 テキストの行揃えを文字列「left」、「center」、「right」のいずれかで指定します。「left」は行の左の端、「center」は中央の中心、「right」は右の端が並ぶことを示します。 複数行のテキストを表示するウィジェットに用いられます。 |
orient | 水平または垂直配置。 ウィジェットの配置方向を文字列「horizontal」または「vertical」のいずれかで指定します。「horizontal」は水平方向に、「vertical」は垂直方向に配置することを示します。 スクロールバーウィジェットなどの水平方向または垂直方向のいずれかでレイアウトできるウィジェットに用いられます。 |
padx | 横の余白(パッディング)の幅。 値を設定単位で指定します。A1.1 位置、サイズ単位を参照して下さい。 ウィジェットの左右の端に余白を設定します。通常、この余白はウィジェットの境界線の内側に設定されます。 このオプションの指定で、ウィジェットの内側の座標の原点がこの余白の内側に移動することに注意します。 ビットマップまたはイメージを表示している場合、通常、このオプションは無視されます。 |
pady | 縦の余白(パッディング)の幅。 値を設定単位で指定します。A1.1 位置、サイズ単位を参照して下さい。 ウィジェットの上下の端に余白を設定します。通常、この余白はウィジェットの境界線の内側に設定されます。 このオプションの指定で、ウィジェットの内側の座標の原点がこの余白の内側に移動することに注意します。 ビットマップまたはイメージを表示している場合、通常、このオプションは無視されます。 |
relief | 3D 境界線の形状 3D 境界線の形状を文字列で指定します。A1.6 レリーフスタイルを参照して下さい。 境界線の幅は「borderwidth 」または「bd」オプションで指定します。 |
repeatdelay | スライダーの移動開始時間 ミリ秒の整数値で指定します。 スクロールバーなどの矢印ボタンをマウスで押下してスライダーを自動移動させるときの開始するまでの時間を設定します。 Windows では動作しません。 |
repeatinterval | スライダーの移動間隔。 ミリ秒の整数値で指定します。 スクロールバーなどの矢印ボタンをマウスで押下してスライダーを自動移動させるとき、その移動は一定の移動量を繰り返し実行します。この繰り返し実行する間隔を設定します。 Windows では動作しません。 |
selectbackground | ウィジェットでの要素の選択時の背景色。 色を文字列で指定します。A1.3 色を参照して下さい。 要素を選択するリストボックスなどのウィジェットで使用されます。 |
selectborderwidth | ウィジェットでの要素の選択時に、要素の周囲に描画される 3D 境界線の幅。 色を文字列で指定します。A1.3 色を参照して下さい。 境界線の描画形状はシステムで設定され、要素の外側に描かれます。 要素を選択するリストボックスなどのウィジェットで使用されます。 |
selectforeground | ウィジェットでの要素の選択時の前景色。 色を文字列で指定します。A1.3 色を参照して下さい。 テキストを表示するウィジェットの場合、テキストの文字色です。 |
setgrid | グリッド制御設定 「True」、「False」の論理値で指定します。 リストボックスやテキストボックスなどのテキストを表示するウィジェットのサイズは、表示するテキストのフォントを基準に設定されます。このオプションは、この基準をウィジェットを表示するトップレベルウィンドウに適用させるかを制御します。「True」は基準を適用し、「False」は適用しません。 基準が適用されると、トップレベルウィンドウのサイズ設定に関するメソッド「wm_geometry」、「wm_minsize」、「wm_maxsize」などの値の単位がウィジェットのサイズを設定する値の単位になります(幅は文字サイズ、高さは行サイズ)。 |
takefocus | フォーカスの受け入れの設定。 フォーカスを受け入れる場合は「True」、受け入れない場合は「False」を指定します。 フォーカスはシステムまたはアプリケーションで設定することができます。システムでは「Tab」または「Shift-Tab」キーなどでフォーカスを他のウィジェットに移動します。このオプションが「False」に設定されているウィジェットの場合、システムによるフォーカスの設定はスキップされます。 アプリケーションでのフォーカスの設定には影響がありません。 |
text | ウィジェット内に表示する文字列。 文字列が表示される方法はウィジェットに依存し、「anchor」や「justify」などの他のオプションによって決定される場合があります。 |
textvariable | 文字列を表示するウィジェット変数。 ウィジェット変数の名前を指定します。 変数の値は、ウィジェット内に表示されるテキスト文字列です。変数の値が変更された場合、ウィジェットは新しい値を反映するように自動的に更新されます。 文字列が表示される方法はウィジェットに依存し、「anchor」や「justify」などの他のオプションによって決定される場合があります。 |
troughcolor | トラフ領域の色。 色を文字列で指定します。A1.3 色を参照して下さい。 スクロールバーやスケールなどのウィジェットの長方形のトラフ領域(スライダーが移動する領域)に使用する色を設定します。 Windows では動作しません。 |
underline | 下線を引く文字。 文字列のインデクスを指定します。 ウィジェットに表示される文字列の一つの文字に下線を引きます。インデックスの「0」は最初の文字に対応して、インデックスの順に次の文字に対応します。 |
wraplength | ワードラップにおける行の最大長。 値を設定単位で指定します。A1.1 位置、サイズ単位を参照して下さい。 このオプションで指定した長さを超える行は単語単位で次の行に折り返されます。単語の長さが指定した長さを超えている場合は、長さを超える文字で折り返されます。 この値が「0」以下の場合、折り返しは行われません。行はテキストの改行文字でのみ改行されます。 |
xscrollcommand | 水平スクロールバーの「set」メソッド。 ウィジェットの水平方向の表示領域の変化を水平スクロールバーに通知し、スクロールバーのスライダーを動かします。スクロールバーは「set」メソッドでウィジェットからの情報を取得します。 このオプションを指定しない場合、スクロールバーはウィジェットの表示領域の変化に対して動作しません。 |
yscrollcommand | 垂直スクロールバーの「set」メソッド。 ウィジェットの垂直方向の表示領域の変化を垂直スクロールバーに通知し、スクロールバーのスライダーを動かします。スクロールバーは「set」メソッドでウィジェットからの情報を取得します。 このオプションを指定しない場合、スクロールバーはウィジェットの表示領域の変化に対して動作しません。 |