【Python tkinter】クリックされたボタンを関数内で判別しテキスト情報などを取得する（bind,event）

プログラムの流れ

クリックされたウィジェット（ボタン）を判別し、テキストや属性値を取得するためのプログラム作成の流れを次に示します。

1. 対象のウィジェットに対してbind()メソッドでコールバック関数を紐づける
2. コールバック関数には引数にeventを指定して作成する
3. event.widget[]でウィジェットの属性情報を取得する

上記の流れについて詳しく解説していきます。

サンプルプログラム

クリックされたボタンを関数内で判別して、テキストを取得し画面に表示するプログラムのソースコードを以下に記します。

# tkinterのインポート
import tkinter as tk
import tkinter.ttk as ttk

def print_text(event):
    text.set("クリックしたボタン　：　" + str(event.widget["text"]))

# rootメインウィンドウの設定
root = tk.Tk()
root.title("tkinter")
root.geometry("300x200")

# メインフレームの作成と設置
frame = ttk.Frame(root)
frame.pack(fill = tk.BOTH, padx=5, pady=10)

# StringVarのインスタンスを格納するウィジェット変数text
text = tk.StringVar(frame)
text.set("")

# 各種ウィジェットの作成
for i in range(1,6):
    button = ttk.Button(frame, text=i)
    button.bind("", print_text)
    button.pack()

label = tk.Label(frame, textvariable=text)
label.pack()

root.mainloop()

このプログラムを起動すると次の画面が表示されます。

このGUIアプリでボタン３を押すと次のように表示されます。

bind()メソッドとは

Buttonウィジェットではオプション引数のcommandを使用することで定義済みの関数を紐づけることができます。

その他のウィジェットに対しても、イベント発生時に紐づけた関数を実行したい場合はbind()メソッドを使用します。

bind()メソッドはすべてのウィジェットに対してトリガーとなる特定のイベントと実行する関数（コールバック関数）の紐づけを行うことができます。

サンプルプログラムでは次のように使われています。

# 各種ウィジェットの作成
for i in range(1,6):
    button = ttk.Button(frame, text=i)
    button.bind("", print_text)
    button.pack()

構文と引数

bind()メソッドでウィジェットに対して、イベント（操作）とコールバック関数の紐づけには次のように行います。

bind()メソッドの第一引数にはコールバック関数を実行するトリガーとなるイベント（操作）を指定し、第二引数に実行する関数を指定します。

addオプションは通常は指定しません。
同一のウィジェットに対してイベントを追加したいときに指定します。

イベント

次のように様々なイベントが用意されています。

Buttonウィジェットに左クリック操作が発生したらcallbackを実行するプログラムは次のように記述します。

button = ttk.Button(frame, text="button")
button.bind("<Button-1>", callback)
button.pack()

addオプション

同一のウィジェットに対してaddオプションを指定せずにイベントをバインドすると、上書きされるため最初にバインドしたイベントとコールバック関数の紐づけはなくなります。

すでにイベントをバインドしているウィジェットに対して、イベントを追加する場合はaddオプションに”+”を指定します。

button = ttk.Button(frame, text="button")
button.bind("<Button-1>", callback)
button.bind("<ButtonRelease>", callback2, '+')
button.pack()

コールバック関数の定義

次に実行されるコールバック関数を定義していきます。

イベントが発生し、コールバック関数が呼び出されると、コールバック関数にはイベントオブジェクト（event）が渡されます。

そのためコールバック関数を定義する際はeventを受け取るように定義します。

サンプルプログラムでは次のようにコールバック関数は定義されています。

def print_text(event):

eventの属性

eventからはユーザーがどういったイベント（操作）を実行したかや、操作されたウィジェットの情報がわかります。

例えばイベント発生のトリガーとなった、「キーボードのどのキーを押したのか」、「イベント発生時のマウスカーソルの座標」などがわかります。

ウィジェット情報の取得

イベント発生を起こしたウィジェット情報の取得にはevent.widgetを使用します。

サンプルプログラムでは次のように記述しています。

text.set("クリックしたボタン　：　" + str(event.widget["text"]))

event.widget["text"]でボタンウィジェットのテキストを取得しています。

クリックされたウィジェットのbg（バックグラウンド色）を取得するには次のように記述します。

これを使うことで、イベントを発生させたウィジェットの情報を変更できます。
例えば押したボタンの背景色を変更して、アクティブになっているボタンが見た目で判別できるようにもできます。

以下では背景色を変更させるプログラムを記します。

キーボード操作の取得

イベント発生を起こした際のキーボード操作の取得にはevent.keysymを使用します。

以下にイベント発生を起こした際のキー入力を表示するサンプルプログラムを記します。

# tkinterのインポート
import tkinter as tk
import tkinter.ttk as ttk

def print_text(event):
    text.set("操作したキー　：　" + str(event.keysym))

# rootメインウィンドウの設定
root = tk.Tk()
root.title("tkinter")
root.geometry("300x200")

# メインフレームの作成と設置
frame = ttk.Frame(root)
frame.pack(fill = tk.BOTH, padx=5, pady=10)

# StringVarのインスタンスを格納するウィジェット変数text
text = tk.StringVar(frame)
text.set("")

# 各種ウィジェットの作成
for i in range(1,6):
    button = ttk.Button(frame, text=i)
    button.bind("", print_text)
    button.pack()

label = tk.Label(frame, textvariable=text)
label.pack()

root.mainloop()