【Python tkinter】ドロップダウンリスト（プルダウン）を表示：Comboboxウィジェット

Comboboxウィジェットとは

Comboboxウィジェットとは、次図のようなデータをドロップダウンリストで表示して選択できるウィジェットのことです。

ドロップダウンリストでデータを選択するだけでなく、キーボードでデータを自由に入力することも可能です。

そのためListboxウィジェットとEntryウィジェットを組み合わせたようなウィジェットと言えます。

ListboxとEntryのコンビネーションなので、（きっと）コンボボックスと言います。

ComboboxウィジェットはTkinter.ttkモジュールのTkテーマ付きウィジェットであるため、Comboboxウィジェットの生成には、事前にttkをインポートする必要があります。

Comboboxウィジェットの生成

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

parentにはコンボボックスを表示させたい親ウィジェット（frame）またはメインウィンドウ（root）を指定します。

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

Comboboxオブジェクトを生成したら、pack()やgrid()で配置することでコンボボックスウィジェットを指定した親ウィジェットに配置できます。

オプション一覧

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

高さ：height

オプションheightによって、コンボボックスの高さを指定できます。
ここでの高さとは、ドロップダウンリストで表示するデータ件数を差します。

横幅：width

オプションwidthによって、コンボボックスの横幅を指定できます。
横幅はコンボボックス内で表示される文字数で指定します。

文字位置：justify

オプションjustifyによって、コンボボックスに表示するテキストの文字位置を指定することができます。

状態：state

オプションstateによって、コンボボックスの状態を指定できます。
デフォルトではnomalとなっています。

stateにreadonlyを指定すると、Entryの機能が失われます。

すなわちキーボードによる入力ができなくなり、ドロップダウンリストから選択するのみとなります。

stateにdisabledを指定すると、入力および選択が不可になります。

値を保持する変数：textvariable

オプションtextvariableによって、コンボボックスの値を保持する変数を指定します。 textvariableに変数を指定する前に、その変数を事前に定義しておく必要があります。

ドロップダウンリストに表示するデータ：values

オプションvaluesによって、ドロップダウンリストに表示するデータを指定します。
表示するデータ群は事前に定義しておく必要があります。

マウスホバー時のカーソル：cursor

オプションcursorによって、コンボボックスにマウスがホバーしたときのカーソルの種類を指定することができます。

カーソルの種類については、以下サイトを参考にしてください。

Python – Tkinter Cursors

文字サイズ：font

オプションfontによって、コンボボックスのテキスト文字サイズやフォントタイプ、太さを指定できます。

オプションfontの第一引数にフォントタイプ、第二引数に文字サイズ、第三引数に太さを指定します。

スタイルを指定：style

オプションstyleによって、コンボボックスのスタイルを指定することができます。

スタイルを使用することによって、コンボボックスの外観を変更することができます。

詳しい使用方法は、次項で詳しく解説していきます。

スタイル（Style）の設定

ttkの各ウィジェットはスタイル（style）を使用して外観を変更します。
これはTkinterのウィジェットにはなかった設定です。

Ttkの各ウィジェットにはデフォルトスタイルが設定されており、ComboboxではTComboboxというスタイルが設定されています。

ttkでスタイルによる外観変更をするには、まず新たにスタイルオブジェクトを生成します。

次にスタイルオブジェクトに対してconfigure()メソッドを使用して、外観などの設定を変更していきます。

上記ではスタイル名をoffice.TCombobox、フォントの色を赤に変更しています。

スタイルオブジェクトの生成・設定変更ができましたら、コンボボックスを生成する際にオプションstyleでスタイル名を指定します。

• foreground
• selectbackground
• selectforeground
• fieldbackground
• padding
• lightcolor
• arrowsize
• bordercolor

上記のオプションにはテーマ依存のオプションがあります。

テーマ依存のオプションは、使用しているテーマによって反映しないことがあります。
これはテーマで設定されているスタイルが優先されるためです。

テーマ（theme）の設定

ttkはテーマ付きウィジェット（Tk themed widget）と言われるように、各ウィジェットにはテーマが設定されています。

テーマの一覧は次のように確認することができます。

style = ttk.Style()
print(style.theme_names())
# ('winnative', 'clam', 'alt', 'default', 'classic', 'vista', 'xpnative')

上記からわかるように７種類のテーマが用意されています。

テーマを変更する場合は、theme_use()メソッドを使用します。

以下にテーマを変更し、スタイル設定を変更したアプリケーションの例を記します。

import tkinter as tk
from tkinter import ttk

root = tk.Tk()
root.geometry('200x100')

style = ttk.Style()
style.theme_use("winnative")
style.configure("office.TCombobox", selectbackground="blue", fieldbackground="red", padding=5)

module = ('tkinter', 'math', 'os', 'pyinstaller', 'pathlib', 'sys')

v = tk.StringVar()

combobox = ttk.Combobox(root, textvariable= v, values=module, style="office.TCombobox")

combobox.pack(pady=10)

root.mainloop()

関数の定義

Combobox内のデータが選択された時に呼ばれるコールバック関数を考えます。

関数の定義は次のようにEventオブジェクトを受け取れるように引数eventを指定しています。

選択されたデータの取得

Comboboxで選択されたデータの取得には、get()メソッドを使用します。

次の一文を定義した関数select_comboに追加します。

ウィジェットに関数をバインドさせる

生成したコンボボックスに上記で作成した関数を、イベント発生時に実行されるようにバインドします。

ソースコード

以下にCombobox内のデータが選択されたときに、そのデータを取得してコンソール画面に表示するプログラムを記します。

import tkinter as tk
from tkinter import ttk

def select_combo(event):
    print(combobox.get())

root = tk.Tk()
root.geometry('200x100')

style = ttk.Style()
style.theme_use("winnative")
style.configure("office.TCombobox", selectbackground="blue", padding=5)

module = ('tkinter', 'math', 'os', 'pyinstaller', 'pathlib', 'sys')

v = tk.StringVar()

combobox = ttk.Combobox(root, textvariable= v, values=module, style="office.TCombobox")
combobox.bind('<<ComboboxSelected>>', select_combo)

combobox.pack(pady=10)

root.mainloop()