【Python tkinter】LabelFrame（ラベルフレーム）ウィジェットの使い方：オプション一覧

LabelFrameウィジェットとは

LabelFrameウィジェットとは、Tkinterで用意されているウィジェットの一つであり、フレームを作成し、そのフレームにラベルを付けることができるウィジェットです。

つまりFrameウィジェットにLabelウィジェットを付けたものだということです。

このLabaelFrameウィジェットを使うとGUIアプリケーションではどのような表示になるかというと、次のようになります。

上図からわかるように、ラベルはフレームの枠線部分に表示されます。

枠線部に表示されるラベルの位置は、オプションで上下左右を変更できます。

このウィジェットにより、フレーム内に配置したウィジェットの目的や用途をユーザーに伝えることができます。

Tkinterで作るGUIアプリケーションのユーザビリティを向上させる上で、LabelFrameウィジェットは欠かせないウィジェットの一つです。

LabelFrameウィジェットの生成

LabelFrameウィジェットを生成するために、次のようにtk.LabelFrameを使用します。

parentには、表示させたいウィジェットまたはメインウィンドウを指定します。

Optionsには、LabelFrameウィジェットに用意されているオプションを指定します。

オプション一覧

LabelFrameウィジェットに用意されているオプションの一覧を以下に記します。

LabaelFrameウィジェットのフレームに関するオプションは、Frameウィジェットと使い方は同じです。

【Python tkinter】Frame（フレーム）の使い方：作成・配置・オプション一覧

ウィジェットに用意されているオプションの一覧を取得したい場合は、keys()メソッドを対象のウィジェットに使います。
keys()メソッドの戻り値として、そのウィジェットのオプションをリストで返してくれます。

ラベルに表示するテキスト：text

オプションtextによって、LabaelFrameウィジェットのラベルに表示するテキストを指定できます。

ラベルのフォント：font

オプションfontによって、LabaelFrameウィジェットのラベルテキストのフォントを指定できます。
第一引数にフォントタイプ、第二引数に文字サイズを指定します。

ラベルの文字色：fg or foreground

オプションfgまたはforegroundによって、LabaelFrameウィジェットのラベルテキストの文字色を指定できます。

ラベルの表示する位置：labelanchor

オプションlabelanchorによって、LabaelFrameウィジェットのラベルテキストの位置を指定できます。

フレームの枠線上どの位置にラベルを設置するか、東西南北を示す“e, w, s, n”を使用します。

例えば、左上であればwn、右下ならばseといった具合になります。

ラベルウィジェットの指定：labelwidget

オプションlabelwidgetによって、LabaelFrameウィジェットのラベルを、指定したLabelウィジェットにすることができます。

Labelウィジェットを表示できるので、Labelウィジェットにしかないオプションを使って、より凝ったラベルをフレームに表示できます。

また指定できるのはLabelウィジェットだけでなく、他のウィジェットでも指定して表示することが可能です。

例えばオプションimageで画像をラベルに付け加えたり、オプションreliefで見た目を変えたりできます。

オプションlabelwidgetを使う場合は、事前に指定するLabelウィジェットを生成しておく必要があります。
またオプションtext、fg、fontは無視されますのでご注意ください。

LabelFrameの子ウィジェットを取得：winfo_children()

LabelFrameウィジェットの子ウィジェットを取得するには、winfo_children()を使います。
wininfo_children()では戻り値に子のリストを返します。

LabelFrameウィジェットの子ウィジェット一つ一つに対して、操作をしたい場合は次のようにfor文を使います。

ウィジェットの無効・有効：stateオプションがある場合

対象子ウィジェットにstateオプションがある場合は、子ウィジェットのstateオプションを使って無効・有効を切り替えていきます。

無効にしたい場合はDISABLEDを指定、有効にしたい場合はNORMALを指定するようにします。

ウィジェットの無効・有効：stateオプションが無い場合

対象子ウィジェットにstateオプションがないが、state()メソッドがあるならば、state()メソッドで子ウィジェットの無効・有効を切り替えていきます。

無効にしたい場合はdisabled、有効にしたい場合は!disabledと指定します。

ソースコード

上記で解説してきた方法を使って、子ウィジェットの無効・有効を切り替えるアプリを作成しました。

以下にソースコードを記しますので、コピペして実際に動くのか試してみてください。

import tkinter as tk

def valid():
    if check.get() == tk.ON:
        flag = tk.NORMAL
        stateflags = ['!disabled']
    else:
        flag = tk.DISABLED
        stateflags = ['disabled']
    for children in labelframe.winfo_children():
        if "state" in children.keys():
            children.config(state=flag)
        if getattr(children, "state", None) != None:
            children.state(stateflags)

root = tk.Tk()
root.title('LabelFrame')
root.geometry('240x100')

check = tk.IntVar(value=tk.ON)
checkbutton_valid = tk.Checkbutton(root, text="有効", variable=check, command=valid)

labelframe = tk.LabelFrame(root, width=150, height=50, labelwidget=checkbutton_valid)

radio = tk.IntVar(value=1)
radio1 = tk.Radiobutton(labelframe, text="機能１", value=1, variable=radio)
radio2 = tk.Radiobutton(labelframe, text="機能２", value=2, variable=radio)

labelframe.pack(pady=10)
radio1.pack()
radio2.pack()

checkbutton_valid.invoke()
root.mainloop()