Python3 Tkinter ボタンについて

Question

tkinter.Button()とttk.Button()について

それぞれでボタンを押したときに、押したままの状態にしたいです。
（ボタンの外観が押したままであればそれでいいです。）

Python 入門 TkinterによるGUIプログラミング

上記のサイトでは ttk.Button() で command を使ったやり方で紹介されていますが、tkinter.Button() や bind() で実現することは可能ですか？

Answer 1

tkinter.Button() や bind() で実現することは可能ですか？

How to make button in Python Tkinter stay pressed until another one is pressedを参考にすると以下のように書けます。
ただし最初に押したときだけ状態が遷移しないようです。

import tkinter as tk

def on_button(e):
    relief = btn['relief']
    if relief == tk.RAISED:
        relief = tk.SUNKEN
    else:
        relief = tk.RAISED
    btn.config(relief=relief)

root = tk.Tk()
btn = tk.Button(root, text='push')
btn.bind('<ButtonPress>', on_button)
btn.pack()
root.mainloop()

Comments

[person]

tkでもcommandだとできました。

bindでは正常に（少なくともWindowsでは）動作させることは無理なんでしょうかね･･･。

# commandで実装(tk.Button())
import tkinter as tk

def b1_pushed():
global b1
if b1["relief"] == "raised":
b1["relief"] = "sunken"
else:
b1["relief"] = "raised"

win = tk.Tk()

b1 = tk.Button(win, text="b1", width=10, command=b1_pushed)
b1.grid()

win.mainloop()

[can110]

> tkでもcommandだとできました。
こちらのWindows環境でもできました。
なぜbindでは初回うまくいかないのか理由が分かりませんが。

[teamikl]

bindの場合は、b1_pushed() の最後で return "break" すると、初回も期待通りに動くはずです。

「初回のみ」の理由をうまく説明できませんが…。なにかデフォルトのイベントの影響でしょうか、
relief を変更した後、b1.update(); time.sleep(5) と意図的に止めてみると
枠が変更されてるのは確認できます。その後に sleep が切れた後、通常の枠に戻ります。

あまり気にしたことが無かったけど、bind と command では呼ばれるタイミングが違うようですね。
command に登録した関数は、ボタンを押した後・枠線を変更した後に呼ばれるようです。

[can110]

コメントありがとうございます。
tkinterのイベントモデルは全く分からないのですが、bindとcommandで挙動が異なるようですね。
勉強になりました。

[person]

自分のほうでも確認しました。
バインドが<Button-1>のときにreturn "break"つけたら動作しますね。
（ちなみにバインドを<ButtonRelease>にしたらダメなようです）

自分の中でちょっとわからないのはreturn "break"の意味なのですが、これって 単純に "break"という文字列を戻り値にするのとは異なるのでしょうか？

[teamikl]

"break" という文字列を戻り値にするのは、tkinter 側の独自の仕様です。

tkinter <=> tcl/tk のやり取りはTCL言語のコード(Python側では文字列)で行っているのですが、
関数を bind() するときに、その関数の戻り値が "break" という文字列であれば、
tcl/tk 側で break コマンド (TCL言語ではコマンドと呼びます) を呼ぶコードが追加されています。
そして、tcl/tk 側では、break が呼ばれるとイベントの伝搬がそこでキャンセルされるようです。

https://docs.python.org/ja/3/library/tkinter.html
ソースコード tkinter/__init__.py のリンク → "def bind" を検索

該当箇所は、 cmd = ('%sif {"[%s %s]" == "break"} break\n'
TCL言語では [関数 引数...] == 戻り値との比較、となってます。

====
参考

因みに、ドキュメントの「バインドとイベント」の項目に "break" の事は、記載されてませんでした。
https://docs.python.org/ja/3/library/tkinter.html#bindings-and-events

Tcl/Tk のマニュアル MULTIPLE MATCHES の項目に記載有り (英語)
https://www.tcl.tk/man/tcl8.6/TkCmd/bind.htm

button.tcl ボタン クラスの実装 ButtonUp/ButtonDown (TCL言語)
https://core.tcl-lang.org/tk/artifact/74d573e9b383577d

ButtonUp を見ると、relief を設定してからコマンド呼び出しされるのが見て取れます。

----
解決策ではありませんが、Python 側で実験。クラスのイベント解除

デフォルトのイベントを解除すると、枠の変更がなくなるので
return "break" なしでも初回のみ枠が変わらない挙動は発生しない。

b1.unbind_class("Button", "<Button-1>")

※全てのボタンに影響がある為、これは解決策ではありません。
ボタンのデフォルトのイベントが影響してるという事を確認するための実験です

以下のように ButtonRelease-1 イベントを解除すると、command が呼ばれなくなる。

b1.unbind_class("Button", "<ButtonRelease-1>")

[teamikl]

「初回のみ～」の原因がわかりました。
デフォルトの<Enter>イベントが鍵でした。

ボタンのデフォルトイベントの振る舞いですが
1. Enter ... ButtonEnter 以前の relief 情報を内部変数へ保存
2. （ここでbindしたユーザ定義の関数)
3. Button-1 ... ButtonDown config -relief sunken
4. ButtonRelease-1 ... ButtonUp config -relief 前のreliefに復帰
5. (commandの場合はここで呼ばれる)

つまり、自分で relief を設定しても、その後
デフォルトのButtonDown/Up イベントにより再設定されているのが
初回のみ Enter で設定された値が適応されてしまった訳です。
2回目以降は ButtonDown がユーザ関数で設定した relief 情報を復帰用に保存します。

マウスカーソルをボタン上から一旦離して、
もう一度ボタンを押すと同じように「初回のみ」の現象が再発するはずです。

return "break" は bind() を用いる場合の回避策ですが、
relief を変更する場合は、command の方が適切な位置だと思います。
(可能なら URL で紹介されてるように ttk で stateを使った方が、
より良いのですが)