Adding action to CheckBox using PyQt5

Graphical User Interface (GUI) frameworks provide developers with the tools and capabilities to create visually appealing and interactive applications. PyQt5, a Python binding for the Qt framework, offers a robust toolkit for building GUI applications with ease. Among the fundamental components offered by PyQt5 is the CheckBox, a widget that allows users to select or deselect an option.

By adding actions to CheckBoxes, we can enhance the functionality and interactivity of our applications. This feature enables us to perform specific tasks or trigger events based on the state of the CheckBox. Whether it is enabling or disabling a feature, updating a user interface element, or triggering a function, the ability to add actions to CheckBoxes empowers developers to create more dynamic and responsive applications.

Prerequisites

Before we begin, ensure that you have the following prerequisites installed on your machine ?

• Python (version 3.6 or higher)

• PyQt5 library (can be installed via pip install pyqt5)

Importing the Necessary Libraries

Let's start by importing the required libraries for our PyQt5 application ?

import sys
from PyQt5.QtWidgets import QApplication, QMainWindow, QWidget, QCheckBox

We import sys to handle system-specific functionality and QApplication, QMainWindow, QWidget, and QCheckBox from the QtWidgets module of PyQt5. These classes provide the foundation for creating the GUI elements of our application.

Creating the Main Window

To create a window for our application, we'll define a class that inherits from QMainWindow ?

class MainWindow(QMainWindow):
    def __init__(self):
        super().__init__()
        self.initUI()

    def initUI(self):
        self.setWindowTitle("CheckBox Action Example")
        self.setGeometry(100, 100, 300, 200)

        self.central_widget = QWidget(self)
        self.setCentralWidget(self.central_widget)

The MainWindow class inherits from QMainWindow. In the __init__ method, we call the parent class constructor using super().__init__() to initialize the QMainWindow. The initUI() method sets up the initial user interface with window title, size, and a central widget container.

Adding a CheckBox Widget

Next, let's add a CheckBox widget to our main window. This widget will serve as the basis for our action implementation ?

self.checkbox = QCheckBox("Enable Action", self.central_widget)
self.checkbox.setGeometry(50, 50, 200, 30)

We create a QCheckBox widget with the label "Enable Action" and add it to the central widget. The setGeometry() method positions the CheckBox at coordinates (50, 50) with a width of 200 and height of 30 pixels.

Defining the Action Function

We will now define the action that should occur when the CheckBox state changes. In this example, we'll print a message based on whether the CheckBox is checked or unchecked ?

def on_checkbox_change(state):
    if state == 2:  # Qt.Checked
        print("Action enabled!")
    else:
        print("Action disabled!")

self.checkbox.stateChanged.connect(on_checkbox_change)

The on_checkbox_change() function takes a state parameter representing the CheckBox's new state. When state == 2 (Qt.Checked), the CheckBox is checked. We connect this function to the CheckBox's stateChanged signal using connect().

Complete Code Example

Here's the complete working code example ?

import sys
from PyQt5.QtWidgets import QApplication, QMainWindow, QWidget, QCheckBox


class MainWindow(QMainWindow):
    def __init__(self):
        super().__init__()
        self.initUI()

    def initUI(self):
        self.setWindowTitle("CheckBox Action Example")
        self.setGeometry(100, 100, 300, 200)

        self.central_widget = QWidget(self)
        self.setCentralWidget(self.central_widget)

        self.checkbox = QCheckBox("Enable Action", self.central_widget)
        self.checkbox.setGeometry(50, 50, 200, 30)

        def on_checkbox_change(state):
            if state == 2:  # Qt.Checked
                print("Action enabled!")
            else:
                print("Action disabled!")

        self.checkbox.stateChanged.connect(on_checkbox_change)


if __name__ == "__main__":
    app = QApplication(sys.argv)
    window = MainWindow()
    window.show()
    sys.exit(app.exec())

Running the Application

Save the code to a file (e.g., checkbox_action.py) and run it using the command line ?

python checkbox_action.py

When you run the application, you'll see a window with a CheckBox labeled "Enable Action". The application will respond to user interactions as follows ?

CheckBox Checked

When you click the CheckBox to check it, the console output will be ?

Action enabled!

CheckBox Unchecked

When you click the CheckBox to uncheck it, the console output will be ?

Action disabled!

Key Points

• The stateChanged signal is emitted whenever the CheckBox state changes

• State value 2 represents checked (Qt.Checked), while 0 represents unchecked (Qt.Unchecked)

• You can connect multiple functions to the same signal for complex behaviors

• Actions can include updating UI elements, enabling/disabling features, or triggering calculations

Conclusion

Adding actions to CheckBoxes in PyQt5 is accomplished by connecting the stateChanged signal to custom functions. This enables dynamic, interactive applications that respond to user input and create more engaging user experiences.