MISC クラスメソッド

← 目次     No.0002 →

999999

 更新日:

Grid クラスメソッド

 Grid クラスには以下のメソッドが定義されています。

object.bbox(column=None, row=None, col2=None, row2=None
「grid_bbox」メソッドと同じです。
Misc クラスで定義されています。
object.columnconfigure(index, cnf={}, **kw)
「grid_columnconfigure」メソッドと同じです。
Misc クラスで定義されています。
object.config(cnf={}, **kw)
「grid_configure」メソッドと同じです。
object.configure(cnf={}, **kw)
「grid_configure」メソッドと同じです。
object.forget()
「grid_forget」メソッドと同じです。
object.grid(cnf={}, **kw)
「grid_configure」メソッドと同じです。
object.grid_bbox(column=None, row=None, col2=None, row2=None)
「grid_configure」メソッドによって分割されたセルの開始セルと終了セルを含む範囲の座標とサイズを取得します。
引数
column
開始セルの列インデックス。
row
開始セルの行インデックス。
col2
終了セルの列インデックス。
row2
終了セルの行インデックス。
返り値
指定された範囲の左上座標(x座標、y座標)とサイズ(幅、高さ)が順に 4 つの要素を持つタプルで返されます。
備考
引数「column」と「row」の組、または「col2」と「row2」の組のみが指定されている場合、指定されたセルの座標とサイズを取得します。
Misc クラスで定義されています。
object.grid_columnconfigure(index, cnf={}, **kw)
「grid_configure」メソッドによって分割されたセルの指定した列のオプションを設定、取得します。
引数
index
設定するセルの列を「整数値」、「ウィンドウパス名」、文字列「all」のいずれかで指定します。「整数値」はセルの列のインデックス、「ウィンドウパス名」は指定するセルに配置されているオブジェクトのパス名、文字列「all」は全てのセルの列を指します。

オプションの値を取得する場合は「整数値」を指定します。

cnf
設定するオプションに以下のキーワードの文字列と値を辞書型で指定します。
オプションの値を取得する場合、この引数は用いられません。
minsize
セルの最少幅をピクセル単位で指定します。セルに配置されるオブジェクトのサイズがこのサイズより小さい場合に、セルは余白を持ってこのサイズに設定されます。
weight
列の相対的な幅を整数値で指定します。「uniform」オプションが同じ値の列のグループで、この値が最も小さい列幅を基準にして同じ値の「uniform」オプションのセルの幅が設定されます。値「0」は「1」と同じです。
uniform
「weight」オプションで列幅を設定するセルのグループを整数値または文字列で指定します。
pad
セルの左右に追加する余白をピクセル単位で指定します。
**kw
設定する列のオプションをキーワードで指定します。オプションは前記の「cnf」引数と同じです。
オプションの値を取得する場合、キーワードのみを指定します。一つのキーワードしか指定できません。
返り値
「**kw」にオプションのキーワードのみが指定されている場合、「index」に指定した列の指定したキーワードのオプション値が返されます。
「**kw」に何も指定されていない場合、「index」に指定した列の現在の全てのオプションの設定値がキーワードと値の辞書型で返されます。
備考
「index」に「all」を指定して、「weight」および「uniform」オプションに任意の値を指定すると、全てのセルの幅はその最大幅のセルと同じに設定されます。
Misc クラスで定義されています。
object.grid_configure(cnf={}, **kw)
オブジェクトの親ウィジェットにグリッド(格子)状にオブジェクトを配置します。
引数
cnf
設定するオプションに以下のキーワードの文字列と値を辞書型で指定します。
column
オブジェクトを配置する列のインデックスを整数値または整数文字で指定します。インデックスは「0」から始まります。デフォルトは「0」に設定されています。
columnspan
オブジェクトが占める列数を整数値または整数文字で指定します。「n」を指定した場合、このオブジェクトの次の列インデックスはこのオブジェクトの列インデックスに「n」加算された値になります。デフォルトは「1」に設定されています。
in
オブジェクトを配置するコンテナのオブジェクトのパス名を指定します。 このオブジェクトの親として指定したオブジェクトは無視されます。
ipadx
オブジェクトの内側の左右のパッディング領域を整数値または文字列で指定します。指定する単位はA1.1 位置、サイズ単位を参照して下さい。デフォルトは「0」に設定されています。
ipady
オブジェクトの内側の上下のパッディング領域を整数値または文字列で指定します。指定する単位はA1.1 位置、サイズ単位を参照して下さい。デフォルトは「0」に設定されています。
padx
オブジェクトの外側の左右のパッディング領域を整数値または文字列で指定します。指定する単位はA1.1 位置、サイズ単位を参照して下さい。デフォルトは「0」に設定されています。
pady
オブジェクトの外側の上下のパッディング領域を整数値または文字列で指定します。指定する単位はA1.1 位置、サイズ単位を参照して下さい。デフォルトは「0」に設定されています。
row
オブジェクトを配置する行のインデックスを整数値または整数文字で指定します。インデックスは「0」から始まります。
このオプションを指定しない場合、配置される行は前のオブジェクトが配置されている行の下になります。前に配置されたオブジェクトがない場合、インデックス「0」の行に配置されます。
rowspan
オブジェクトが占める行数を整数値または整数文字で指定します。「n」を指定した場合、このオブジェクトの次の行インデックスはこのオブジェクトの列インデックスに「n」加算された値になります。デフォルトは「1」に設定されています。
sticky
区画の中でのオブジェクトの配置を文字列で指定します。指定する文字列は「n」、「s」、「e」、「w」の文字を 1 個以上用います。それぞれの文字は「上」、「下」、「右」、「左」を意味します。
文字列の文字は任意に組み合わせることができますが、同じ文字が複数個ある場合、それは 1 個の文字とみなされます。
1 個の文字での指定は、それぞれが意味する位置にオブジェクトを配置します。
「n」、「s」と「e」、「w」の組み合わせはそれぞれが意味する位置の組み合わせにオブジェクトを配置します。
「n」と「s」の組み合わせはオブジェクトを区画の高さ全体に拡張します。「e」と「w」の組み合わせはオブジェクトを区画の幅全体に拡張します。
文字列の中の各文字は連続した記述だけでなく、半角空白および「,」区切りを用いることができます。
値を指定しないか空文字を指定した場合、オブジェクトは区画の中心に配置されます。デフォルトで空文字が設定されています。
**kw
設定する列のオプションをキーワードで指定します。オプションは前記の「cnf」引数と同じです。
object.grid_forget()
オブジェクトの「grid_configure」メソッドの実行を無効にします。これにより、オブジェクトは非表示になり、「grid_configure」メソッドで設定したオプションの値はデフォルト値になります。
備考
オブジェクトを再表示するには、「grid_configure」メソッドを実行します。
object.grid_info()
「grid_configure」メソッドで設定したオプションの値を取得します。
備考
オプションのキーワードの文字列と値を辞書型で返します。
object.grid_location(x, y)
「grid_configure」メソッドによって分割されたセルの指定したピクセル座標でのインデックス座標を取得します。
引数
x
インデックス座標を取得するセルの横座標をピクセル単位で指定します。
y
インデックス座標を取得するセルの縦座標をピクセル単位で指定します。
返り値
セルの列インデックと行インデックスがタプルで返されます。
備考
セルの範囲を超えたピクセル座標を指定すると、上と左を超えた場合は「-1」を、下と右を超えた場合は最大インデックスに「1」が加算されたインデックス値が返されます。
Misc クラスで定義されています。
object.grid_propagate(flag=['_noarg_'])
「grid_configure」メソッドによるサイズ調整の有効、無効の設定、および設定状態の取得をします。
引数
flag
サイズ調整の有効、無効をブール値で指定します。「True」を指定すると有効になり、デフォルトです。「False」を指定すると無効になります。
値を指定しない場合、現在の設定値を返します。
返り値
引数に値を指定しない場合、現在の設定値を返します。設定値が「True」の場合は「True」、「False」の場合は「None」が返ります。
備考
オブジェクト(部品)を「grid_configure」メソッドでオブジェクト(コンテナ)に配置すると、コンテナが「wm_geometry」メソッドまたは「place_configure」メソッドで設定されている場合を除いて、デフォルトでコンテナは部品に合わせてシステムによりサイズが調整されます。調整機能が有効の場合、コンテナでの指定したサイズは無視されます。無効を設定すると、コンテナは指定したサイズで表示されます。
Misc クラスで定義されています。
object.grid_remove()
オブジェクトの「grid_configure」メソッドの実行を無効にします。これにより、オブジェクトは非表示になりますが、オプションの設定値は保持されます。
備考
オブジェクトを再表示するには、「grid_configure」メソッドを実行します。
object.grid_rowumnconfigure(index, cnf={}, **kw)
「grid_configure」メソッドによって分割されたセルの指定した行のオプションを設定、取得します。
引数
index
設定するセルの行を「整数値」、「ウィンドウパス名」、文字列「all」のいずれかで指定します。「整数値」はセルの行のインデックス、「ウィンドウパス名」は指定するセルに配置されているオブジェクトのパス名、文字列「all」は全てのセルの行を指します。

オプションの値を取得する場合は「整数値」を指定します。

cnf
設定するオプションに以下のキーワードの文字列と値を辞書型で指定します。
オプションの値を取得する場合、この引数は用いられません。
minsize
セルの最少の高さをピクセル単位で指定します。セルに配置されるオブジェクトのサイズがこのサイズより小さい場合に、セルは余白を持ってこのサイズに設定されます。
weight
行の相対的な高さを整数値で指定します。「uniform」オプションが同じ値の行のグループで、この値が最も小さい行の高さを基準にして同じ値の「uniform」オプションのセルの高さが設定されます。値「0」は「1」と同じです。
uniform
「weight」オプションで行の高さを設定するセルのグループを整数値または文字列で指定します。
pad
セルの上下に追加する余白をピクセル単位で指定します。
**kw
設定する行のオプションをキーワードで指定します。オプションは前記の「cnf」引数と同じです。
オプションの値を取得する場合、キーワードのみを指定します。一つのキーワードしか指定できません。
返り値
「**kw」にオプションのキーワードのみが指定されている場合、「index」に指定した行の指定したキーワードのオプション値が返されます。
「**kw」に何も指定されていない場合、「index」に指定した行の現在の全てのオプションの設定値がキーワードと値の辞書型で返されます。
備考
「index」に「all」を指定して、「weight」および「uniform」オプションに任意の値を指定すると、全てのセルの高さはその最大の高さのセルと同じに設定されます。
Misc クラスで定義されています。
object.grid_size()
「grid_configure」メソッドによって分割されたセルの列および行の数を取得します。
返り値
列数と行数を順にタプルで返します。
備考
Misc クラスで定義されています。
object.grid_slaves(row=None, column=None)
オブジェクト(コンテナ)に「grid_configure」メソッドによって配置されているオブジェクト(部品)を取得します。
引数
row
オブジェクト(部品)を取得するセルの行のインデックスを指定します。
column
オブジェクト(部品)を取得するセルの列のインデックスを指定します。
返り値
取得したオブジェクト(部品)を最も新しく配置された順にリスト形式で返します。
引数が設定されていない場合、全てのオブジェクト(部品)が返されます。
「row」のみが設定されている場合、指定した行の全てのオブジェクト(部品)が返されます。
「column」のみが設定されている場合、指定した列の全てのオブジェクト(部品)が返されます。
備考
Misc クラスで定義されています。
object.info()
「grid_info」メソッドと同じです。
object.location(x, y)
「grid_location」メソッドと同じです。
object.propagate(flag=['_noarg_'])
「grid_propagate」メソッドと同じです。
object.rowconfigure(index, cnf={}, **kw)
「grid_rowconfigure」メソッドと同じです。
object.size()
「grid_size」メソッドと同じです。
object.slaves(row=None, column=None)
「grid_slaves」メソッドと同じです。