TUTORIAL

PyQt5 チュートリアル - ラジオボタン

このチュートリアルでは、PyQt5 `QRadioButton` ウィジェットの例を紹介します。ラジオボタンの作成、`toggled` シグナルへのスロット接続、オプションの事前選択、独立したグループの維持を扱います。

このページの内容

QRadioButton を使うと、ユーザーは選択肢のセットから 1 つだけを選択できます。複数の選択肢が互いに排他的な場合に適したウィジェットです。独立したオン/オフの選択には、代わりに QCheckBox を使用してください。各チェックボックスはそれぞれ独自の状態を保持するからです。各 QRadioButton は丸いインジケーターとテキストラベルを組み合わせたもので、同じ親ウィジェットを共有するラジオボタンは自動的に 1 つの排他的なグループを形成します。1 つを選択すると、他は解除されます。

QRadioButton ウィジェットを作成する

表示する選択肢のテキストを QRadioButton コンストラクターに渡し、他のウィジェットと同じようにレイアウトへ追加します。次のスクリプトは、ユーザーがどの都市に住んでいるかを尋ね、New York と Houston を選択肢として提示し、回答用に 2 つ目の QLabel を確保するウィンドウを作成します。PyQt5 とグラフィカルディスプレイが必要です。importlib.util.find_spec のチェックにより、PyQt5 がインストールされていない環境でもファイルは正常に終了し、デスクトップでは下図のウィンドウが開きます。

このコード例とウィンドウに表示されるラベルは、コードブロックのバイト単位の一致を維持するため英語のままです。

import importlib.util
import sys

if importlib.util.find_spec("PyQt5") is None:
    sys.exit(0)  # PyQt5 is required for the GUI below

from PyQt5.QtWidgets import (
    QApplication,
    QLabel,
    QRadioButton,
    QVBoxLayout,
    QWidget,
)


class basicRadiobuttonExample(QWidget):
    def __init__(self):
        super().__init__()

        self.init_ui()

    def init_ui(self):
        self.label = QLabel("Which city do you live in?")
        self.rbtn1 = QRadioButton("New York")
        self.rbtn2 = QRadioButton("Houston")
        self.label2 = QLabel("")

        self.rbtn1.toggled.connect(self.onClicked)
        self.rbtn2.toggled.connect(self.onClicked)

        layout = QVBoxLayout()
        layout.addWidget(self.label)
        layout.addWidget(self.rbtn1)
        layout.addWidget(self.rbtn2)
        layout.addWidget(self.label2)

        self.setGeometry(200, 200, 300, 150)

        self.setLayout(layout)
        self.setWindowTitle("PyQt5 Radio Button Example")

        self.show()

    def onClicked(self):
        radioBtn = self.sender()
        if radioBtn.isChecked():
            self.label2.setText("You live in " + radioBtn.text())


if __name__ == "__main__":
    app = QApplication(sys.argv)
    ex = basicRadiobuttonExample()
    sys.exit(app.exec_())

「PyQt5 Radio Button Example」というタイトルの PyQt5 ウィンドウのレンダリング結果。「Which city do you live in?」という質問、未選択の New York と Houston のラジオボタン、空白の結果行が表示されている

コンストラクター文字列("New York" や "Houston")は、各丸いインジケーターの横に描画されるテキストになります。self.label は質問を表示し、self.label2 は後で選択結果を報告する空白のラベルとして始まり、QVBoxLayout は追加された順にウィジェットを縦に積み重ねます。setGeometry(200, 200, 300, 150) はウィンドウの位置とサイズを設定し、setWindowTitle() はキャプションを設定します。

toggled シグナルに応答する

QRadioButton は、チェック状態がどちらの方向へ変化しても toggled シグナルを発行します。選択されたときにチェック状態で 1 回、選択を失ったボタンでは未チェック状態で 1 回発行されます。両方のボタンを 1 つのスロット(self.rbtn1.toggled.connect(self.onClicked) と self.rbtn2.toggled.connect(self.onClicked))に接続すれば、グループ全体を追跡できます。

toggled は選択解除されたボタンでも発行されるため、スロットは isChecked() でフィルタリングし、新しく選択されたボタンだけが結果を更新するようにします。onClicked の中では、self.sender() がシグナルを発行したウィジェットを返し、text() がその表示中の選択肢ラベルを読み取り、self.label2.setText("You live in " + radioBtn.text()) が回答を書き込みます。

toggled シグナルは新しいチェック状態をブール値としても渡すため、def onClicked(self, checked) と宣言したスロットは isChecked() を呼ぶ代わりにその値を使うこともできます。ここでは送信元の isChecked() を確認する方が、どのボタンがテキストを生成したかを明確にできるため、より単純なパターンです。

基本例のインタラクション: Houston のラジオボタンを選択するとチェックが付き、New York の選択が解除され、結果ラベルが「You live in Houston」に更新される

setChecked() でデフォルトの選択を設定する

新しい QRadioButton インスタンスは未チェックの状態で始まるため、ウィンドウは何も選択されていない状態で開きます。アプリケーションの起動時に 1 つを事前選択するには、そのボタンで setChecked() を呼び出します(self.rbtn1.setChecked(True))。

チェック状態を変更すると、ユーザーのクリックと同じように toggled が発行されます。事前選択で結果ラベルなどの依存ウィジェットも更新したい場合は、シグナルを接続した後で setChecked(True) を呼び出してください。起動時の選択を通知せずにおきたい場合は、接続する前に呼び出します。

QButtonGroup で独立したグループを作成する

同じ親を持つ QRadioButton ウィジェットはすべて 1 つの暗黙的なグループに属するため、toggled シグナルが別々のスロットに接続されていても、同時にチェックできるのはそのうちの 1 つだけです。ウィンドウで複数の独立した質問をする場合は、各選択肢セットを QtWidgets の QButtonGroup で包み、addButton() でボタンを登録します。すると各グループは、他のグループとは独立にチェック済みボタンを 1 つ許可します。次の例は都市と州の両方を尋ねるもので、最初のスクリプトと同じ PyQt5 デスクトップ環境が必要です:

このセクションのコードとウィンドウに表示されるラベルは、コードブロックのバイト単位の一致を維持するため英語のままです。

import importlib.util
import sys

if importlib.util.find_spec("PyQt5") is None:
    sys.exit(0)  # PyQt5 is required for the GUI below

from PyQt5.QtWidgets import (
    QApplication,
    QButtonGroup,
    QLabel,
    QRadioButton,
    QVBoxLayout,
    QWidget,
)


class basicRadiobuttonExample(QWidget):
    def __init__(self):
        super().__init__()

        self.init_ui()

    def init_ui(self):
        self.label = QLabel("Which city do you live in?")
        self.rbtn1 = QRadioButton("New York")
        self.rbtn2 = QRadioButton("Houston")
        self.label2 = QLabel("")

        self.label3 = QLabel("Which state do you live in?")
        self.rbtn3 = QRadioButton("New York")
        self.rbtn4 = QRadioButton("Texas")
        self.label4 = QLabel("")

        self.btngroup1 = QButtonGroup()
        self.btngroup2 = QButtonGroup()

        self.btngroup1.addButton(self.rbtn1)
        self.btngroup1.addButton(self.rbtn2)
        self.btngroup2.addButton(self.rbtn3)
        self.btngroup2.addButton(self.rbtn4)

        self.rbtn1.toggled.connect(self.onClickedCity)
        self.rbtn2.toggled.connect(self.onClickedCity)

        self.rbtn3.toggled.connect(self.onClickedState)
        self.rbtn4.toggled.connect(self.onClickedState)

        layout = QVBoxLayout()
        layout.addWidget(self.label)
        layout.addWidget(self.rbtn1)
        layout.addWidget(self.rbtn2)
        layout.addWidget(self.label2)

        layout.addWidget(self.label3)
        layout.addWidget(self.rbtn3)
        layout.addWidget(self.rbtn4)
        layout.addWidget(self.label4)

        self.setGeometry(200, 200, 300, 300)

        self.setLayout(layout)
        self.setWindowTitle("PyQt5 Radio Button Example")

        self.show()

    def onClickedCity(self):
        radioBtn = self.sender()
        if radioBtn.isChecked():
            self.label2.setText("You live in " + radioBtn.text())

    def onClickedState(self):
        radioBtn = self.sender()
        if radioBtn.isChecked():
            self.label4.setText("You live in " + radioBtn.text())


if __name__ == "__main__":
    app = QApplication(sys.argv)
    ex = basicRadiobuttonExample()
    sys.exit(app.exec_())

2 つの独立した選択肢セットを持つ PyQt5 ウィンドウのレンダリング結果。「Which city do you live in?」の下で都市のラジオボタンが選択され、「Which state do you live in?」の下で州のラジオボタンが選択されている

このプログラムは 2 つの QButtonGroup インスタンスを作成します。都市ボタン用の self.btngroup1 と、州ボタン用の self.btngroup2 です。addButton() は各ラジオボタンをそのグループに登録します。都市のペアには self.btngroup1.addButton(self.rbtn1) と self.btngroup1.addButton(self.rbtn2) を、州のペアには self.btngroup2.addButton(self.rbtn3) と self.btngroup2.addButton(self.rbtn4) を使います。グループがなければ、4 つのボタンすべてが同じ親を共有するため、Texas を選ぶと都市の選択が解除されてしまいます。グループを設定しておけば、各質問が独自のチェック済みボタンを保持し、各結果ラベルは独立して更新されます。

このルールはウィンドウだけではテキストとして示せないため、次の純粋な Python モデルで同じ排他性を再現します。グループごとに 1 つの選択が可能で、2 つ目のグループは 1 つ目の影響を受けません。この例を実行してみてください。以下のコードと出力の文字列も英語のままです。

class RadioGroup:
    def __init__(self):
        self.buttons = []
        self.checked = None

    def add(self, label):
        self.buttons.append(label)

    def select(self, label):
        self.checked = label
        return "Selected: " + label


city = RadioGroup()
city.add("New York")
city.add("Houston")

state = RadioGroup()
state.add("New York")
state.add("Texas")

print(city.select("New York"))
print(state.select("Texas"))
print(city.select("Houston"))
print("State group still holds:", state.checked)
Selected: New York
Selected: Texas
Selected: Houston
State group still holds: Texas

QButtonGroup はこのモデルの RadioGroup と同じ役割を果たします。新しい選択は同じグループ内で前の選択を置き換え、もう一方のグループはその回答を保持します。