PyQt5 QCalendarWidget - Getting Background Role

Last Updated : 01 Oct, 2021

In this article, we will see how we get the background role of the QCalendarWidget. Background role defines the brush from the calendar’s palette that is used to render the background. If no explicit background role is set, the calendar inherits its parent widget’s background role. In order to set the background role, we use setBackgroundRole method.

In order to do this we will use backgroundRole method with the QCalendarWidget object.
Syntax : calendar.backgroundRole()
Argument : It takes no argument
Return : It return QPalette.ColorRole object but when printed its shows its associated value

Below is the implementation

Python3

# importing libraries
from PyQt5.QtWidgets import *
from PyQt5 import QtCore, QtGui
from PyQt5.QtGui import * 
from PyQt5.QtCore import * 
import sys


class Window(QMainWindow):

    def __init__(self):
        super().__init__()

        # setting title
        self.setWindowTitle("Python ")

        # setting geometry
        self.setGeometry(100, 100, 600, 400)

        # calling method
        self.UiComponents()

        # showing all the widgets
        self.show()

    # method for components
    def UiComponents(self):

        # creating a QCalendarWidget object
        self.calendar = QCalendarWidget(self)

        # setting geometry to the calendar
        self.calendar.setGeometry(50, 10, 400, 250)

        # enabling auto fill background
        self.calendar.setAutoFillBackground(True)

        # setting background role
        self.calendar.setBackgroundRole(QPalette.Base)

        # getting palette and setting color to the background to it
        p = self.calendar.palette()
        p.setColor(self.calendar.backgroundRole(), Qt.yellow)
        self.calendar.setPalette(p)

        # creating a label
        label = QLabel(self)

        # setting geometry
        label.setGeometry(120, 280, 200, 60)

        # making it multi line
        label.setWordWrap(True)

        # getting the background role
        value = self.calendar.backgroundRole()

        # setting text to the label
        label.setText("Background Role : " + str(value))


# create pyqt5 app
App = QApplication(sys.argv)

# create the instance of our Window
window = Window()


# start the app
sys.exit(App.exec())