Sitemap
大軒軒

大軒軒

自學 Linux 、網路,將會陸續分享相關知識。

Python tk-event binding (5)

13 min readMar 26, 2024

--

按下特定鍵盤按鈕,使用滑鼠右鍵,滑鼠移動,要讓這些事情發生時同時觸發事件,就需要用到 event binding。

蠻多東西與 event binding 掛勾, 更詳細的事件名稱之後的文章可在未來需要時再回頭看。

此篇目標:

  • 會建立 event 事件的 callback
  • 知道觸發 event 的條件
  • 知道常用的 event

目錄:

  • 基本語法
  • class-level binding (class 層級的綁定)
  • binding all
  • unbind 解除綁定
  • Focus
  • 更詳細的事件名稱
  • 事件觸發順序
  • 虛擬事件
  • 常見的事件名稱
  • 鍵盤按鈕
  • 滑鼠按鈕
  • tkinter.Event 變數
  • event type

基本語法

event binding 的基本語法是
widget.bind('<事件名稱>', callback_func, add=None)

  • 事件名稱 — 底下會詳細描述,名稱的左右邊會使用 <…> 包起來
  • function — 自己定義的功能
  • add — ( 不一定需要 )當一個事件要一次觸發多個 function 時,在 add 後面加上 +,如add='+' 。如果同一個 widget 連續綁定兩次相同的事件,第二次的 func 會覆蓋原先設定,因此只會觸發最後設定的 func。

範例,按下任意鍵盤按鍵,會顯示按了甚麼鍵,並顯示 keycode

import tkinter as tk
from tkinter import ttk

window = tk.Tk()

# 觸發事件會被執行的方法
def even_lbl_1(event):
lbl_1['text'] = f"You pressed: {event.char}"
print(event)

def even_lbl_2(event):
lbl_2['text'] = f"KeyCode is: {event.keycode}"


lbl_1 = ttk.Label(text="Please Press Keyboard.")
lbl_1.pack()

lbl_2 = ttk.Label(text="")
lbl_2.pack()

btn = ttk.Button(text="Press Key")
btn.pack()
btn.focus()

btn.bind('<KeyPress>', even_lbl_1)
btn.bind('<KeyPress>', even_lbl_2, add='+')
# 如果沒有使用 add='+',第二個 bind 會蓋掉第一個 bind

window.mainloop()

class-level binding

前面講的是在已建立的物件上綁定事件,稱為 instance-level binding
另一種方式是對全部同種類的物件進行綁定,如對全部的 Button 綁定一個事件

PS: 對於 ttk 的物件,widget 名稱前面要加上大寫 T,如 Button 要改成 TButton,或使用 winfo_class() 可以取得 widget 名稱。

建議使用 root 去執行,後人閱讀比較容易理解。
雖然也可用其它 widget 執行這個方法,但最終還是會以 root 的腳色執行這個功能。

語法
root.bind_class('widget名稱', '<事件名稱>', callback_func, add=None)

範例,按下任意鍵盤按鍵,會顯示按了甚麼鍵 (請使用英文字母)

import tkinter as tk
from tkinter import ttk

root = tk.Tk()

# 觸發事件會被執行的方法
def even_lbl(event):
lbl_1['text'] = f"You pressed: {event.char}"


lbl_1 = ttk.Label(text="Please Press Keyboard.")
lbl_1.pack()

btn = ttk.Button(text="Press Any Key")
btn.pack()
btn.focus()

# 可使用 winfo_class 檢查 widget 名稱
print( btn.winfo_class() ) # 會顯示 TButton

# 改成使用 root 建立 event bind
root.bind_class('TButton','<KeyPress>', even_lbl)

root.mainloop()

binding all

還有一個綁定的方法 bind_all,將全部的物件都綁定相同的事件

語法
root.bind_all('<事件名稱>', callback_func, add=None)

unbind 解除綁定

語法
widget.unbind('<事件名稱>')

Focus

跟 Key 有關的事件,需要先對 widget 完成 focus 動作,這個時候按下按鍵才會觸發。

有三個方法可以完成 focus 動作

  • 滑鼠左鍵點一下 (此 widget 必須是可 focus)
  • 使用 Tab 鍵選到 (此 widget 必須是可 focus)
  • 使用 widget.focus() 方法

下圖左邊的按鈕,周遭有一圈虛線,這就是 focus 的表現,如果是可以輸入資料的欄位,會出現閃爍的游標,就像純文字文件一樣,這也是 focus 的表現。

focus
focus

並非每樣 widget 預設都可以 focus,或是以呈現 focus 狀態,但從外觀上看不出來,這些 widget 就不適合使用 KeyPress 相關的事件。
例如 Label、Frame 這些不適合使用 KeyPress,並且呈現 focus 狀態時,外觀不會有變化。

更詳細的事件名稱

可以使用更細緻的事件名稱設定觸發條件,如按下 Ctrl + c
<Control-KeyPress-c> ,或 <Control-c> ,KeyPress 可以省略

事件的書寫格式

<modifier-type-detail>

  • modifier — 簡稱 mod,就是 Alt, Ctrl 和 Shift 這三個複合鍵,複合鍵書寫時沒有順序之分,如果是 Ctrl + Alt + Delete,可以是<Alt-Control-KeyPress-KP_Delete> 或是 <Control-Alt-KeyPress-KP_Delete>
    KP
    是鍵盤右邊九宮格的按鍵,如 0 和 KP_0
  • type — 事件名稱,如 KeyPress、KeyRelease。KeyPress 可省略不寫。
    <KeyPress-c> 可改寫成 <c>
  • detail — 詳細的事件,如 Delete 按鍵,<KeyPress-Delete>

另外 modifier 還有連點的事件
Double 連點兩次
Triple 連點三次
Quadruple 連點四次
如 <Double-x> ,連按兩次 x

事件觸發順序

當同時設定 <KeyPress> 和 <Return>,那一個會被觸發,或同時使用 binding_all 和 class binding ,會發生甚麼事。

這邊分成兩類說明,綁定的方法,和使用的事件

綁定的方法

前面提到事件有三種方式,這邊會再多講一個

  • widget.bind(),instance-level binding,距離最近
  • root.bind(),頂層的事件
  • root.bind_class(),class-level binding,相同物件,綁定相同事件
  • root.bind_all(),全部物件都綁定相同事件

如果以上四個都綁定相同事件,則觸發順序會是 由上到下

使用的事件

主要還是以 <KeyPress> 和 <KeyPress-a> 做比較, tkinter 使用 closest match,越細緻的才會比對成功,因此以這個例子,只會觸發 <KeyPress-a> 的事件。

Get 大軒軒’s stories in your inbox

Join Medium for free to get updates from this writer.

綜合以上兩個,假設每一層都有設定<KeyPress> 和 <KeyPress-a>,此時按下 a 按鈕。 tkinter 會在每一層找出一個最細緻的事件,每層都會觸發一次,因此觸發順序會是 widget → root.bind → roo.bind_class → root.bind_all,觸發的事件都是 <KeyPress-a>。

虛擬事件

虛擬事件主要給開發人員自行設定事件,tkinter 也有內建一部分的虛擬事件。

完整的清單可到這個網站觀看 event manual page — Tk Built-In Commands (tcl.tk)

虛擬事件使用 <<虛擬事件名稱>> 的方式命名,前後加上 << >>

平常會用到的內建虛擬事件

  • <<Copy>>,使用 Ctrl + c 複製時會觸發
  • <<Paste>>,使用 Ctrl + v 貼上時會觸發
  • <<ListboxSelect>>,Listbox 專屬,Listbox 其中一個項目被選擇時觸發
  • <<MenuSelect>>,Menu 專屬,點選其中一個 Menu 的選項時觸發
  • <<Modified>>,Text 專屬,內容第一次被修改時觸發

自訂虛擬事件

把好幾個事件綁成一個,類似 group 的概念,語法如下
root.event_add('<<新事件名稱>>', '<原始的事件名稱-1>', '<原始的事件名稱-2')

範例,把滑鼠右鍵和中鍵放在一塊,並且將這個命名為 custom-event

# 此範例未展示完整程式碼

root.event_add('<<custom-event>>', '<Button-3>', '<Button-2>')

btn.bind('<<custom-event>>', callback)

刪除自訂的虛擬事件

root.event_delete('<<新事件名稱>>')

顯示已建立的虛擬事件

root.event_info('<<新事件名稱>>'),顯示這個虛擬事件的設定
root.event_info(),回傳全部以建立的虛擬事件

常見的事件名稱

  • KeyPress — 按下鍵盤的按鍵,需先 focus 才會觸發。可簡寫成 Key
  • KeyRelease — 鬆開按下的鍵盤按鍵,需先 focus 才會觸發。
  • ButtonPress — 按下滑鼠任意鍵,不包括滾動滾輪。可簡寫成 Button
  • ButtonRelease — 鬆開滑鼠按鍵
  • MouseWheel — 滾動滑鼠滾輪,windows 和 MAC 使用這個參數,Linux 的 X-window 使用 Button-4 和 Button-5
  • Shift-MouseWheel — 水平滾動 (不常見),Linux 使用 Shift-Button-4 和 Shift-Button-5
  • Enter — 滑鼠移動到物件上面
  • Leave — 滑鼠離開物件上
  • Motion — 滑鼠在物件上移動,每移動一次都算一次事件,點滑鼠按鍵不算 Motion
  • FocusIn — 使用鍵盤的 Tab 鍵將焦點鎖定到物件上或使用滑鼠左建點擊也會鎖定,常用在 Button 和 Entry, Text
  • FocusOut — 原本鎖定的物件不再被鎖定

PS: 完整的事件可在這邊找到 bind manual page — Tk Built-In Commands (tcl-lang.org)

PS: 這邊有常用事件的解釋 Understanding Tkinter Event Binding Clearly (pythontutorial.net)

PS: 如果使用中文輸入法的狀態下觸發 KeyPress,雖會觸發 KeyPress,但無法抓到按下那個按鍵

PS: 複合鍵的檢查需要額外看 event.state 變數,9 是 shift 複合鍵,12 是 ctrl 複合鍵,131080 是 Alt 複合鍵

PS: 使用滑鼠滾輪時,可以使用變數 event.delta,代表滾輪一次滾動的幅度,不同 OS 的滾動幅度預設值不同,正數代表往前滾動,負數代表往後滾動。Shift-MouseWheel 的情況下,正數代表左,負數為右

鍵盤按鈕

按鍵分大小寫

  • space — 空白鍵
  • Return — Enter 鍵
  • BackSpace — Enter 上面的刪除鍵
  • Shift_L — 左邊的 Shift 鍵 (Shift, ctrl, alt 通常都有左右兩邊,兩邊的編號不同,這裡只寫其中一邊)
  • Control_L — 左邊的 Ctrl 鍵
  • Alt_L — 左邊的 Alt 鍵
  • KP_,鍵盤右邊的九宮格。如 9 就是 KP_9,共有 1–9 和 0,Delete,+,-,/

PS : 完整的鍵盤按鈕可以在這邊找到 keysyms manual page — Tk Built-In Commands (tcl-lang.org)

PS: 這邊有常用按鍵的解釋 Understanding Tkinter Event Binding Clearly (pythontutorial.net)

滑鼠按鈕

ButtonPress 可簡寫成 Button。

  • Button-1,滑鼠左鍵
  • Button-2,滑鼠中鍵
  • Button-3,滑鼠右鍵
  • Double-Button-1,連點滑鼠左鍵兩次
  • ButtonRelease-1,滑鼠左鍵按下去後,鬆開時觸發

tkinter.Event 變數

當觸發事件後,呼叫 function 的同時會自動帶入一個變數,這個變數是 event 物件。

event 裡面包含很多觸發時的資訊,可以供後續設計使用

  • widget,觸發事件的 widget 本體,可使用 event.widget.cget('text') 的方式取得 widget 本身的參數。
  • x, y,以 window 角度來看,滑鼠游標的座標位置,左上角是 0,0。單位 pixel
  • x_root, y_root,以電腦畫面角度來看,滑鼠的座標位置,左上角是 0,0。單位 pixel
  • char,觸發事件的文字
  • keysym,觸發事件的文字符號,如 Tab
  • keycode,鍵盤的 keycode,整數
  • num,滑鼠的按鈕編號,1 左鍵,2 中鍵,3 右鍵
  • width, height,物件新的寬度和高度。僅限物件大小變動的觸發事件
  • type,觸發事件的類型

event type

上面 type 的各個數字的解釋

KeyPress = '2'
Key = KeyPress
KeyRelease = '3'
ButtonPress = '4'
Button = ButtonPress
ButtonRelease = '5'
Motion = '6'
Enter = '7'
Leave = '8'
FocusIn = '9'
FocusOut = '10'
Keymap = '11' # undocumented
Expose = '12'
GraphicsExpose = '13' # undocumented
NoExpose = '14' # undocumented
Visibility = '15'
Create = '16'
Destroy = '17'
Unmap = '18'
Map = '19'
MapRequest = '20'
Reparent = '21'
Configure = '22'
ConfigureRequest = '23'
Gravity = '24'
ResizeRequest = '25'
Circulate = '26'
CirculateRequest = '27'
Property = '28'
SelectionClear = '29' # undocumented
SelectionRequest = '30' # undocumented
Selection = '31' # undocumented
Colormap = '32'
ClientMessage = '33' # undocumented
Mapping = '34' # undocumented
VirtualEvent = '35' # undocumented
Activate = '36'
Deactivate = '37'
MouseWheel = '38'

--

--

大軒軒

Written by 大軒軒

自學 Linux 、網路,將會陸續分享相關知識。