【ttk.Combobox】マウススクロールしてもリストの値を動かさないようにしたい【Python】

Question

実現したいこと・仕様

独学でtkinterのGUIを学んでおります。

ttk.Comboboxの仕様として、ウィジェット上でマウススクロールをすると、以下のような動作をします。

①リストを表示していないとき
スクロール距離に応じて、Comboboxに設定されたリスト内の値を移動（？）し、Entry部に表示する
②リストを表示しているとき
リストがスクロールされ、Entry部の表示は変わらない

＊＊＊＊＊＊＊＊＊＊＊＊＊＊＊＊＊＊＊＊＊＊＊＊＊＊＊＊＊＊＊＊
変更したい内容

◆リストを表示していないとき
ウィジェット上でスクロールしても、Combobox内の値は変更しない

＊＊＊＊＊＊＊＊＊＊＊＊＊＊＊＊＊＊＊＊＊＊＊＊＊＊＊＊＊＊＊＊

解決法をご教示願いたいです。

該当のソースコード

import tkinter as tk
import tkinter.ttk as ttk

app = tk.Tk()

lst_cb = list(range(20))
cb = ttk.Combobox(app, values=lst_cb)
cb.pack()

app.mainloop()

試したこと

マウススクロールをbindして、無意味な処理（現在の値を取得して、代入）をさせてみましたが、効果はありませんでした。
マウススクロール関数のあとに、勝手に値が書き換えられてしまいます。

def MouseScroll(event):
    s = event.widget.get()
    event.widget.set(s)

https://projetos.prime.cv/gds/python/env_gds/tcl/tk8.6/ttk/combobox.tcl

こちらに、tcl言語でComboboxウィジェットにマウススクロールをbindしている記載があります。
これを無効化できればと思うのですが、書き方がわかりません。

また、リストの表示有無でマウススクロールbindの有無を切り替えられるかも不明です。

試したこと２

return "break"をマウススクロール関数の最後に入れましたが、マウススクロールに伴ってEntry部の表示は変更されてしまいました。

def onScroll(event):
    return "break"

cb.bind_all("<MouseWheel>", onScroll)

補足情報（FW/ツールのバージョンなど）

Windows11
Python 3.9.7
tk 8.6.11

Answer 1

イベントの解除自体は unbind や unbind_class メソッドで解除可能ですが、

リスト表示の有無での挙動を実装するのは複雑で、まず
ttk.Combobox は 複数のウィジェットが組み合わさった実装で、
入力部分(Entry)と選択部分のリスト(Listbox)は、内部で別ウィジェットとなっています。

選択部分のリストとスクロールバーはCombobox 生成時には生成されておらず、
ユーザが選択操作した初回に動的に生成されます。→生成時に イベントを bind 出来ない

代替手段として考えられるのは、bind all で 全てのMouseWheelイベントを捕まえて
ウィジェットのIDで判別する方法

コンボボックス の ID が .!combobox の時、各内部ウィジェットのIDは
.!combobox.popdown ツールウィンドウ(Toplevel)
.!combobox.popdown.f.l ポップダウンリスト
.!combobox.popdown.f.sb リストのスクロールバー

マウススクロール関数のあとに、勝手に値が書き換えられてしまいます。

tkinter の(文書化されてない)仕様で、イベントハンドラの関数で return "break" と
文字列 "break" を返す事で以降のイベントをキャンセル出来ます。

リストの表示有無でマウススクロールbindの有無を切り替えられるかも不明です。

可能ではありますが、リスト表示の判別は
Tcl/Tk/Ttkの内部実装のソースコードを読み解く必要があります。

実装のヒント:

• winfo_exists でリストが生成されているかどうかを確認して、
• winfo_viewable で表示非表示の確認

def onMouseWheel(event):
    widgetID = str(event.widget)

    if widgetID.startswith(f"{cb}"):
        if int(app.tk.eval(f"winfo exists {widgetID}.popdown"):
            if int(app.tk.eval(f"winfo viewable {widgetID}.popdown"):
                ...


app.bind_all("<MouseWheel>", onMouseWheel)

---

リストを表示していないとき
ウィジェット上でスクロールしても、Combobox内の値は変更しない

クラス毎挙動を変更する (全てのttk.Comboboxが対象)

app.unbind_class("TCombobox", "<MouseWheel>")

もしくはインスタンス毎の挙動変更 (変数cbのみが対象)

cb.bind("<MouseWheel>", lambda _: "break")

---

追記: ttk.Combobox スクロールバーのマウスホィール対応

import tkinter as tk
from tkinter import ttk

root = tk.Tk()
combo = ttk.Combobox(root, values=list(range(20)))
combo.pack()

def onMouseWheel(event):
    widgetID = str(event.widget)

    if widgetID.endswith(".f.sb"):
        listbox = widgetID.replace(".f.sb", ".f.l")
        delta = -event.delta//120 # NOTE: Windows only

        root.tk.eval(f"""
            {listbox} yview scroll {delta} units
        """)

root.bind_all("<MouseWheel>", onMouseWheel)
root.mainloop()

bind_all でグローバルの MouseWheel イベントの捕捉ではなく、
「f.sb」に bind する実装方法、差分のみ (Tcl言語 / win用)

    root.tk.eval(f"""
        ttk::combobox::Post {combo}
        ttk::combobox::Unpost {combo}

        if {{[winfo exists {combo}.popdown.f]}} {{
            bind {combo}.popdown.f.sb <MouseWheel> {{
                {combo}.popdown.f.l yview scroll [expr {{-(%D/120)}}] units
            }}
        }}
    """)

※ {{ }} となっているのはPythonのf-stringでのエスケープです。
tcl 言語では単一の括弧ですが、f-string での変数の展開と被る為のエスケープ。

Comments

[netz-eng]

早速のご回答、ありがとうございます。

>選択部分のリストとスクロールバーはCombobox 生成時には生成されておらず、
>tkinter の(文書化されてない)仕様で、イベントハンドラの関数で return "break" と文字列 "break" を返す事で以降のイベントをキャンセル出来ます
なんと、そんな仕様があるんですね……

教えていただいた内容を噛み砕きながら、試行錯誤してみます。
取り急ぎお礼まで。

[netz-eng]

思いのほか、あっさりと解決することができました。
質問文には書いておりませんでしたが、ウィジェット上でスクロールした際、Entry値は変更することなく、別の処理のみ行いたかったので、以下のように書きました。

①一旦コンボボックス全体からマウススクロールをunbindしたのち、必要な処理を行う関数をbindする
app.unbind_class("TCombobox", "<MouseWheel>")
cb.bind_all("<MouseWheel>", onScroll)
②onScroll関数内で、popdownの存在判定
def onScroll(event):
w = str(event.widget)
if not "popdown" in w:
# 行いたい処理

合わせて、問題の主旨とは異なる質問になるのですが、お尋ねしたいことがあります。

ポップダウンが表示されているとき、ポップダウン右端のスクロールバー（.!combobox.popdown.f.sb）上でマウススクロールをしたときも、ポップダウン（.f.l）リストをスクロールするようにしたいのですが、
この場合は「f.sb」に何をbindすればいいのでしょうか？

[teamikl]

> 「f.sb」に何をbindすればいいのでしょうか？

動的に生成される「f.sb」 に対しては、bind を仕掛けるタイミングの検出が難しいので、
<MouseWheel> イベント全てを bind_all して スクロールバーを移動します。

但し、ttk.Combobox の内部ウィジェットの為、tkinter からのアクセスが難しく、
tk.eval 関数で tcl のコマンドを直接やりとりする事になるかもしれません。(未確認)

tcl 側で実装する際のヒント

ソースコード内の ttk::combobox::Scroll がマウスホィールに登録されたイベントハンドラですが、
想定する引数が異なる為、この関数をスクロールバーにbindは出来ません。

ソースコード該当箇所

ttk::bindMouseWheel TCombobox [list ttk::combobox::Scroll %W]
https://projetos.prime.cv/gds/python/env_gds/tcl/tk8.6/ttk/utils.tcl
ttk::bindMouseWheel
https://projetos.prime.cv/gds/python/env_gds/tcl/tk8.6/ttk/combobox.tcl
bind $bindtag <MouseWheel> [append callback { [expr {-(%D/120)}]}]

他の言語で言う構文木を操作するマクロの様なもので、
tcl のソースコードはリストで表現でき、

bind $bindtag <MouseWheel> [append callback { [expr {-(%D/120)}]}]

※ append は list に対する要素の追加

win32 の場合 MouseWheel に bind されるのは

bind TCombobox <MouseWheel> { ttk::combobox::Scroll %W [expr {-(%D/120)}] }

%D はマウスホィールイベントの event.delta
%W にはイベント対象のウィジェットのIDが入りますが、ここでは Combobox 想定なので
スクロールバー「f.sb」に bind する場合は、この辺の引数の調整が必要。

スクロールバーの MouseWheel 対応については yview scroll
https://wiki.tcl-lang.org/page/mousewheel

[teamikl]

> > 「f.sb」に何をbindすればいいのでしょうか？

追加情報ですが、Listbox, Scrollbar のイベントハンドラの設定自体は
ttk::combobox の実装内で既にできてそうです。

<MouseWheel> を bind しなくても、以下の設定だけでもマウスホィール対応でした
listbox.config(yscrollcommand=scrollbar.set)
scrollbar.config(command=listbox.yview)

ttk::combobox のスクロールバーのMouseWheelイベントが効かないのは、
別のイベント伝搬の問題かもしれません。

マウスホィール移動時にリストボックスを動かす設定自体は pythonで書くと (※ windows用)
scrollbar.bind("<MouseWheel>", lambda e: listbox.yview_scroll(-e.delta//120, "units"))

tcl で書くと .sb (scrollbar) .lb (listbox) として
bind <MouseWheel> .sb {.lb yview scroll [expr {-(%D/120)}] units}

[teamikl]

コンボボックスのスクロールバー上のマウスホィール対応について
それっぽい動作を実装出来たので、回答内にサンプルコードを追記しておきます。

bind で実装したい場合の案は、ttk::combobox::Post/Unpost を呼び出し
予め強制的にポップダウンリストを表示する事で「f.sb」を明示的に生成しておく、等が考えられます。

[netz-eng]

色々と考察、試行くださりありがとうございます。
回答に追記いただいた書き方（bindでないほう）で、非常にシンプルに実現することができました！

tclで直接（？）記述して実装する方法もあるんですね。自分にはまだ難解です……。
必要に迫られたときに、また頂いたご回答を見ながら勉強してみます。