Wmクラスメソッド

  【目  次】  

999999

 更新日:

Wmクラスメソッド

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

Provides functions for the communication with the window manager. Methods defined here: aspect = wm_aspect(self, minNumer=None, minDenom=None, maxNumer=None, maxDenom=None)
object.attributes(*args)

 「wm_attributes」メソッドと同じです。

client = wm_client(self, name=None) colormapwindows = wm_colormapwindows(self, *wlist) command = wm_command(self, value=None)
object.deiconify()

 「wm_deiconify」メソッドと同じです。

focusmodel = wm_focusmodel(self, model=None) frame = wm_frame(self)
object.geometry(newGeometry=None)

 「wm_geometry」メソッドと同じです。

object.grid(baseWidth=None, baseHeight=None, widthInc=None, heightInc=None)

 「wm_grid」メソッドと同じです。

group = wm_group(self, pathName=None)
object.iconbitmap(bitmap=None, default=None)

 「wm_iconbitmap」メソッドと同じです。

object.iconify()

 「wm_iconify」メソッドと同じです。

iconmask = wm_iconmask(self, bitmap=None) iconname = wm_iconname(self, newName=None)
object.iconphoto(default=False, *args)

 「wm_iconphoto」メソッドと同じです。

iconposition = wm_iconposition(self, x=None, y=None) iconwindow = wm_iconwindow(self, pathName=None)
object.maxsize(width=None, height=None)

 「wm_maxsize」メソッドと同じです。

object.minsize(width=None, height=None)

 「wm_minsize」メソッドと同じです。

object.overrideredirect(boolean=None)

 「wm_overrideredirect」メソッドと同じです。

positionfrom = wm_positionfrom(self, who=None)
object.protocol(name=None, func=None)

 「wm_protocol」メソッドと同じです。

object.resizable(width=None, height=None)

 「wm_resizable」メソッドと同じです。

sizefrom = wm_sizefrom(self, who=None)
object.state(newstate=None)

 「wm_state」メソッドと同じです。

object.title(string=None)

 「wm_title」メソッドと同じです。

transient = wm_transient(self, master=None)
object.withdraw()

 「wm_withdraw」メソッドと同じです。

wm_aspect(self, minNumer=None, minDenom=None, maxNumer=None, maxDenom=None) Instruct the window manager to set the aspect ratio (width/height) of this widget to be between MINNUMER/MINDENOM and MAXNUMER/MAXDENOM. Return a tuple of the actual values if no argument is given.
object.wm_attributes(*args)

 オペレーションシステム(OS)固有のウィンドウに関連付けられた属性(アトリビュート)を設定、取得します。


引数
*args

 Windows システムでは、下記の属性を文字列と値で指定します。

'-alpha', value

 ウィンドウの透過度を設定します。「value」に「0.0」から「1.0」の数値で指定します。「0.0」は完全な透明で「1.0」は透明でないウィンドウです。

'-disabled', boolean

 ウィンドウを有効または無効にします。「boolean」に「True」を指定するとウィンドウは無効になり、「False」を指定すると有効になります。

'-fullscreen', boolean

 ウィンドウのクライアント領域をスクリーンの全面に拡大します。「boolean」に「True」を指定すると全面に拡大され、「False」を指定するとウィンドウは通常の表示になります。

'-toolwindow', boolean

 ウィンドウをツールウィンドウで表示します。ツールウィンドウはタイトルバーにタイトルと閉じるボタンのみを持つウィンドウです。「boolean」に「True」を指定するとツールウィンドウになり、「False」を指定するとウィンドウは通常の表示になります。

'-topmost', boolean

 ウィンドウを最前面に表示します。「boolean」に「True」を指定するとウィンドウは常に最前面に表示され、「False」を指定するとウィンドウは通常の表示になります。

'-transparentcolor', color

 ウィンドウのクライアント領域の指定した色を透明にします。「color」に透明にする色を文字列で指定します。空の文字列が指定されている場合 (デフォルト)、透明な色は使用されません。


返り値

 引数の属性の文字列に続く値を指定しない場合、属性の設定値を取得します。

 引数を設定しない場合、全ての属性と値をタプル形式で取得します。


備考

 引数に複数の属性を指定することができます。指定する属性の文字列と値の組を「,」で区切って記述します。

wm_client(self, name=None) Store NAME in WM_CLIENT_MACHINE property of this widget. Return current value. wm_colormapwindows(self, *wlist) Store list of window names (WLIST) into WM_COLORMAPWINDOWS property of this widget. This list contains windows whose colormaps differ from their parents. Return current list of widgets if WLIST is empty. wm_command(self, value=None) Store VALUE in WM_COMMAND property. It is the command which shall be used to invoke the application. Return current command if VALUE is None.
object.wm_deiconify()

 ウィンドウの非表示を解除して表示します。


備考

 ウィンドウは非表示になる(アイコン化される)前の状態で表示され、フォーカスが設定されます。

 「state」メソッドで引数に「normal」を指定したのと同じです。

wm_focusmodel(self, model=None) Set focus model to MODEL. "active" means that this widget will claim the focus itself, "passive" means that the window manager shall give the focus. Return current focus model if MODEL is None.
object.wm_frame()

 ルートウィンドウ(メインウィンドウ)やトップレベルウィンドウ(サブウィンドウ)のウィンドウハンドルを取得します。


返り値

 ウィンドウの識別子(ウィンドウハンドル)を16進文字列で返します。


備考

 ルートウインドウやトップレベルウィンドウは OS(ウィンドウマネージャ)によって装飾されて作成されます。この場合、OS が操作に用いる識別子(ウィンドウハンドル)はオブジェクト識別子とは異なります。Windows の関数でウィンドウを操作する場合はこの識別子を用います。

object.wm_geometry(newGeometry=None)

 オブジェクトのサイズとスクリーン上での表示位置を設定、取得します。


引数
newGeometry

 設定する値を「幅 x 高さ ± x座標 ± y座標」のフォーマットでの文字列で指定します。「±」は「+」または「-」のいずれかの記号で指定します。値はピクセル単位の整数値です。± x座標は、+ のときスクリーンの左端とオブジェクトの左端の間のピクセル数で、- のときスクリーンの右端とオブジェクトの右端の間のピクセル数を指定します。± y座標は、+ のときスクリーンの上端とオブジェクトの上端の間のピクセル数で、- のときスクリーンの下端とオブジェクトの下端の間のピクセル数を指定します。

 幅 x 高さ、または ± x座標 ± y座標のいずれかを省略できます。

 指定なし、または「None」を指定すると、メソッドは現在のサイズと表示位置を返します。


返り値

 引数が指定されているとき、空の文字列を返します。

 指定なし、または「None」が指定されているとき、「幅 x 高さ ± x座標 ± y座標」のフォーマットの文字列で設定値を返します。


備考

 表示位置はタイトルバーを含んだウィンドウの枠に対して設定されます。このとき、ウィンドウがタイトルバーを持つかどうかによって x 座標の指定値と実際の表示位置が変わります。タイトルバーを持たないウィンドウの場合、表示位置は指定値の通りになります。タイトルバーを持つウィンドウの場合、x 座標の指定が「+」のとき、x 方向(右方向)に指定値より 8 ピクセル分のオフセットを持って表示されます。「-」のときは指定値の表示位置になります。

 サイズはウィンドウのクライアント領域(タイトルバーを除いた領域)を指定します。指定するサイズがシステムが設定する最小値より小さい場合、表示されるサイズは指定値が無視されてシステムの最小値になります。タイトルバーを持つウィンドウを除いて、サイズ設定の最小値は 1 ピクセルです。タイトルバーを持つウィンドウでは幅の最小値は 120 ピクセルになります。ウィンドウはタイトルバーの高さ(31 ピクセル)が加わったサイズで表示されます。スクリーンより大きなサイズを指定しても、スクリーンサイズを超えることはできません。

 サイズと表示位置の取得はウィンドウの表示処理が実行された後に行う必要があります。表示処理の待機には、 Misc クラスメソッドの「update」メソッドを用います。

 このメソッドでサイズを設定すると「width」と「height」オプションの設定値は無視されます。このコードの実行以降は「width」と「height」オプションの設定値は有効ではありません。このメソッドでサイズを設定した後に「width」と「height」オプションによるサイズ設定を有効にするには、空文字「''」を設定した「wm_geometry」または「geometry」メソッドを実行します。

 「wm_grid」メソッド、または「setgrid」オプションを持つウィジェット(リストボックスやテキストなど)によってウィンドウがグリッド化されている場合、サイズの設定はピクセル単位ではなくグリッド単位になります。

 このメソッドでサイズを取得する際には、変更値がオブジェクトに反映された後に行います。パラメータの反映の待機は「update」メソッドを用います。取得サイズの単位はピクセルになります。

object.wm_grid(baseWidth=None, baseHeight=None, widthInc=None, heightInc=None)

 ウィンドウの管理をグリッド単位(グリッドウィンドウ)に設定し、グリッドのピクセルに対する値を設定します。


引数
baseWidth

 基本ウィンドウの幅のグリッド数を整数値で指定します。

baseHeight

 基本ウィンドウの高さのグリッド数を整数値で指定します。

widthInc

 1 グリッドの幅のピクセル数を整数値で指定します。

heightInc

 1 グリッドの高さのピクセル数を整数値で指定します。


返り値

 (なし)


備考

 基本ウィンドウのサイズは、ウィンドウの「width」および「height」オプションで指定された値です。引数の「baseWidth」と「baseHeight」にそれぞれ「widthInc」と「heightInc」を掛けた値が「width」と「height」の値と同じになる必要があります。値が異なる場合、このメソッドによる設定は保証されません。

 グリッドウィンドウの解除には、引数のすべてに空文字「''」を設定します。空文字「''」を設定した「wm_geometry」または「geometry」メソッドを実行することでも解除することができます。

 「setgrid」オプションを持つウィジェット(リストボックスやテキストなど)によってウィンドウがグリッド化される場合、このメソッドの実行と同じになります。



wm_group(self, pathName=None) Set the group leader widgets for related widgets to PATHNAME. Return the group leader of this widget if None is given.
object.wm_iconbitmap(bitmap=None, default=None)

 ico 形式の画像ファイルをウィンドウアイコンに表示します。


引数
bitmap

 ウィンドウアイコンに表示する ico 形式の画像ファイルを指定します。メソッドを実行したウィンドウに適用されます。

default

 ウィンドウアイコンに表示する ico 形式の画像ファイルを指定します。メソッドを実行したウィンドウとそのトップレベルウィンドウの全てに適用されます。


備考

 ファイル名はアプリケーションと同じフォルダにある場合はファイル名のみで指定できます。他フォルダにある場合はフルパスのファイル名で指定します。

 引数「bitmap」と「default」の両者に画像ファイルを指定した場合、引数「default」で指定した画像ファイルが有効になります。

object.wm_iconify()

 ウィンドウを非表示にします。タスクバーにアイコンを表示します。


備考

 「state」メソッドで引数に「iconic」を指定したのと同じです。

wm_iconmask(self, bitmap=None) Set mask for the icon bitmap of this widget. Return the mask if None is given. wm_iconname(self, newName=None) Set the name of the icon for this widget. Return the name if None is given.
object.wm_iconphoto(default=False, *args)

 tkinter のフォトオブジェクトをウィンドウアイコンに表示します。


引数
default

 ウィンドウアイコンのウィンドウへの適用をブール値で指定します。「False」はメソッドを実行したウィンドウのみ、「True」はメソッドを実行したウィンドウとそのトップレベルウィンドウの全てに適用します。

*args

 ウィンドウアイコンに表示する tkinter フォトオブジェクトを指定します。


備考

 tkinter フォトオブジェクトは PhotoImage クラスを用いて作成します。使用できる画像は「png」、「gif」、「ppm」、「pgm」形式です。PhotoImage クラスについては PhotoImage クラスを参照して下さい。

wm_iconposition(self, x=None, y=None) Set the position of the icon of this widget to X and Y. Return a tuple of the current values of X and X if None is given. wm_iconwindow(self, pathName=None) Set widget PATHNAME to be displayed instead of icon. Return the current value if None is given.
object.wm_maxsize(width=None, height=None)

 ウィンドウの最大許容サイズを設定、取得します。


引数
width

 最大許容サイズの幅を整数値で設定します。

height

 最大許容サイズの高さを整数値で設定します。


返り値

 引数に値が指定されていないか「None」が指定されている場合に、最大許容サイズの幅と高さをタプルで返します。それ以外の場合は空の文字列を返します。


備考

 引数の設定は「width」および「height」の両方を指定する必要があります。片方のみの指定はエラーになります。

 ウィンドウがタイトルバーを持つとき、タイトルバーの最大化ボタンによる操作はウィンドウの表示位置がスクリーン原点に移動して、最大値の設定値の大きさになります。

 「wm_grid」または「grid」メソッド等でグリッド化されたウィンドウの場合、寸法はグリッド単位になります。通常はピクセル単位です。

object.wm_minsize(width=None, height=None)

 ウィンドウの最小許容サイズを設定、取得します。


引数
width

 最小許容サイズの幅を整数値で設定します。

height

 最小許容サイズの高さを整数値で設定します。


返り値

 引数に値が指定されていないか「None」が指定されている場合に、最小許容許容サイズの幅と高さをタプルで返します。それ以外の場合は空の文字列を返します。


備考

 引数の設定は「width」および「height」の両方を指定する必要があります。片方のみの指定はエラーになります。

 ウィンドウがタイトルバーを持つとき、タイトルバーの幅より小さな範囲の値の設定は無視されます。タイトルバーの最小化ボタンによる操作は最小値の設定の影響は受けません。

 「wm_grid」または「grid」メソッド等でグリッド化されたウィンドウの場合、寸法はグリッド単位になります。通常はピクセル単位です。

object.wm_overrideredirect(boolean=None)

 ウィンドウのタイトルバーの表示、非表示を設定、取得します。


引数
boolean

 タイトルバーの表示、非表示をブール値で指定します。「True」を指定するとウィンドウのタイトルバーは非表示になります。「False」の指定で表示されます。


返り値

 引数に値を指定しないか「None」を指定するとウィンドウのタイトルバーの表示、非表示の状態を、表示のときは「None」、非表示のときは「True」の値で返します。引数に値を指定すると「None」の値を返します。

wm_positionfrom(self, who=None) Instruct the window manager that the position of this widget shall be defined by the user if WHO is "user", and by its own policy if WHO is "program".
object.wm_protocol(name=None, func=None)

 ウィンドウのイベントに対して、システムでの処理を無効にしてアプリケーションでの処理を可能にします。


引数
name

 アプリケーションで処理するイベントを文字列で指定します。tkinterではウィンドウを閉じるイベントの「WM_DELETE_WINDOW」のみが実装されています。

func

 アプリケーションで処理する関数名を指定します。


返り値

 引数に値が設定されている場合、空文字を返します。設定されていない場合、実装されているイベント名をタプル形式で返します。


備考

 tk/tcl でこのメソッドで定義されているイベントとして「WM_DELETE_WINDOW」、「WM_SAVE_YOURSELF」、「WM_TAKE_FOCUS」がありますが、tkinterで実装されているイベントはウィンドウを閉じる操作の「WM_DELETE_WINDOW」だけです。

 引数を設定しない場合、実装されているイベント名がタプル形式で返ります。tkinterでは「('WM_DELETE_WINDOW',)」として得られます。

 name 引数にイベント名を指定して func 引数に空文字を指定すると、指定したイベントに対して設定されている関数処理は取り消されシステム処理に戻ります。

object.wm_resizable(width=None, height=None)

 ウィンドウサイズのマウスドラッグでの変更可否を設定します。


引数
width

 幅のサイズ変更の可否をブール値で指定します。「True」は変更可能で、「False」は変更不可になります。

height

 高さのサイズ変更の可否をブール値で指定します。「True」は変更可能で、「False」は変更不可になります。


返り値

 引数に値が指定されていないか「None」が指定されている場合に、サイズ変更の可否を幅と高さの順に「0 または 1」のタプルで返します。変更不可は「0」、変更可は「1」の値です。それ以外の場合は空の文字列を返します。


備考

 引数の設定は「width」および「height」の両方を指定する必要があります。片方のみの指定はエラーになります。

 変更不可が設定されている場合でも、プログラムによる変更は可能です。

wm_sizefrom(self, who=None) Instruct the window manager that the size of this widget shall be defined by the user if WHO is "user", and by its own policy if WHO is "program".
object.wm_state(newstate=None)

 ウィンドウの表示状態を設定、取得します。


引数
newstate

 表示状態の設定を下記の文字列で指定します。

withdrawn:ウィンドウを非表示にします。タスクバーにアイコンは表示されません。
iconic:ウィンドウを非表示にします。タスクバーにアイコンを表示します。ウィンドウのタイトルバーの最小化ボタンによる動作と同じです。icon?
normal:ウィンドウを設定されているサイズで表示します。
zoomed:ウィンドウをスクリーンの全画面に拡大して表示します。ウィンドウのタイトルバーの最大化ボタンによる動作と同じです。

返り値

 引数に値が指定されていないか「None」が指定されている場合に、現在のウィンドウの表示状態を上記の文字列で返します。


備考

 「iconic」で非表示化(アイコン化)されたウィンドウはタスクバーのアイコンをマウスで左クリックすることで前のサイズのウィンドウを再表示します。引数に「normal」を指定した「state」メソッドを実行した場合と同じです。

 ウィンドウがスクリーンの全画面に拡大して表示されているとき、タイトルバーの元に戻るボタン(最小化ボタンと最大化ボタンの間のボタン)をマウスで左クリックすると、最大化の前のサイズのウィンドウを再表示します。引数に「normal」を指定して「state」メソッドを実行した場合と同じです。

object.wm_title(string=None)

 ウィンドウのタイトルを設定します。


引数
string

 ウィンドウに表示するタイトルを文字列で指定します。


返り値

 引数に値が指定されていないか「None」が指定されている場合に、タイトルを文字列で返します。それ以外の場合は空の文字列を返します。

wm_transient(self, master=None) Instruct the window manager that this widget is transient with regard to widget MASTER.
object.wm_withdraw()

 ウィンドウを非表示にします。タスクバーにアイコンは表示されません


備考

 「wm_state」メソッドで引数に「withdrawn」を指定したのと同じです。