Warning

This section contains snippets that were automatically translated from C++ to Python and may contain errors.

Scribble Example#

The Scribble example shows how to reimplement some of QWidget ‘s event handlers to receive the events generated for the application’s widgets.

We reimplement the mouse event handlers to implement drawing, the paint event handler to update the application and the resize event handler to optimize the application’s appearance. In addition we reimplement the close event handler to intercept the close events before terminating the application.

The example also demonstrates how to use QPainter to draw an image in real time, as well as to repaint widgets.

../_images/scribble-example.png

With the Scribble application the users can draw an image. The File menu gives the users the possibility to open and edit an existing image file, save an image and exit the application. While drawing, the Options menu allows the users to choose the pen color and pen width, as well as clear the screen. In addition the Help menu provides the users with information about the Scribble example in particular, and about Qt in general.

The example consists of two classes:

  • ScribbleArea is a custom widget that displays a QImage and allows to the user to draw on it.

  • MainWindow provides a menu above the ScribbleArea.

We will start by reviewing the ScribbleArea class. Then we will review the MainWindow class, which uses ScribbleArea.

ScribbleArea Class Definition#

class ScribbleArea(QWidget):

    Q_OBJECT
# public
    ScribbleArea(QWidget parent = None)
    openImage = bool(QString fileName)
    saveImage = bool(QString fileName, char fileFormat)
    def setPenColor(newColor):
    def setPenWidth(newWidth):
    bool isModified() { return modified; }
    QColor penColor() { return myPenColor; }
    int penWidth() { return myPenWidth; }
# public slots
    def clearImage():
    def print():
# protected
    def mousePressEvent(event):
    def mouseMoveEvent(event):
    def mouseReleaseEvent(event):
    def paintEvent(event):
    def resizeEvent(event):
# private
    def drawLineTo(endPoint):
    def resizeImage(image, newSize):
    modified = False
    scribbling = False
    myPenWidth = 1
    myPenColor = Qt.blue()
    image = QImage()
    lastPoint = QPoint()

The ScribbleArea class inherits from QWidget . We reimplement the mousePressEvent(), mouseMoveEvent() and mouseReleaseEvent() functions to implement the drawing. We reimplement the paintEvent() function to update the scribble area, and the resizeEvent() function to ensure that the QImage on which we draw is at least as large as the widget at any time.

We need several public functions: openImage() loads an image from a file into the scribble area, allowing the user to edit the image; save() writes the currently displayed image to file; clearImage() slot clears the image displayed in the scribble area. We need the private drawLineTo() function to actually do the drawing, and resizeImage() to change the size of a QImage . The print() slot handles printing.

We also need the following private variables:

  • modified is true if there are unsaved changes to the image displayed in the scribble area.

  • scribbling is true while the user is pressing the left mouse button within the scribble area.

  • penWidth and penColor hold the currently set width and color for the pen used in the application.

  • image stores the image drawn by the user.

  • lastPoint holds the position of the cursor at the last mouse press or mouse move event.

ScribbleArea Class Implementation#

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

    setAttribute(Qt.WA_StaticContents)

In the constructor, we set the WA_StaticContents attribute for the widget, indicating that the widget contents are rooted to the top-left corner and don’t change when the widget is resized. Qt uses this attribute to optimize paint events on resizes. This is purely an optimization and should only be used for widgets whose contents are static and rooted to the top-left corner.

def openImage(self, QString fileName):        loadedImage = QImage()
if not loadedImage.load(fileName):
    return False
newSize = loadedImage.size().expandedTo(size())
resizeImage(loadedImage, newSize)
image = loadedImage
modified = False
update()
return True

In the openImage() function, we load the given image. Then we resize the loaded QImage to be at least as large as the widget in both directions using the private resizeImage() function and we set the image member variable to be the loaded image. At the end, we call update() to schedule a repaint.

def saveImage(self, QString fileName, char fileFormat):        visibleImage = image
resizeImage(visibleImage, size())
if visibleImage.save(fileName, fileFormat):
    modified = False
    return True

return False

The saveImage() function creates a QImage object that covers only the visible section of the actual image and saves it using QImage::save(). If the image is successfully saved, we set the scribble area’s modified variable to false, because there is no unsaved data.

def setPenColor(self, newColor):        myPenColor = newColor
def setPenWidth(self, newWidth):        myPenWidth = newWidth

The setPenColor() and setPenWidth() functions set the current pen color and width. These values will be used for future drawing operations.

def clearImage(self):        image.fill(qRgb(255, 255, 255))
modified = True
update()

The public clearImage() slot clears the image displayed in the scribble area. We simply fill the entire image with white, which corresponds to RGB value (255, 255, 255). As usual when we modify the image, we set modified to true and schedule a repaint.

def mousePressEvent(self, event):            if event.button() == Qt.LeftButton:
        lastPoint = event.position().toPoint()
        scribbling = True


def mouseMoveEvent(self, event):

    if (event.buttons()  Qt.LeftButton) and scribbling:
        drawLineTo(event.position().toPoint())

def mouseReleaseEvent(self, event):

    if event.button() == Qt.LeftButton and scribbling:
        drawLineTo(event.position().toPoint())
        scribbling = False

For mouse press and mouse release events, we use the button() function to find out which button caused the event. For mouse move events, we use buttons() to find which buttons are currently held down (as an OR-combination).

If the users press the left mouse button, we store the position of the mouse cursor in lastPoint. We also make a note that the user is currently scribbling. (The scribbling variable is necessary because we can’t assume that a mouse move and mouse release event is always preceded by a mouse press event on the same widget.)

If the user moves the mouse with the left button pressed down or releases the button, we call the private drawLineTo() function to draw.

def paintEvent(self, event):        painter = QPainter(self)
dirtyRect = event.rect()
painter.drawImage(dirtyRect, image, dirtyRect)

In the reimplementation of the paintEvent() function, we simply create a QPainter for the scribble area, and draw the image.

At this point, you might wonder why we don’t just draw directly onto the widget instead of drawing in a QImage and copying the QImage onto screen in paintEvent(). There are at least three good reasons for this:

  • The window system requires us to be able to redraw the widget at any time. For example, if the window is minimized and restored, the window system might have forgotten the contents of the widget and send us a paint event. In other words, we can’t rely on the window system to remember our image.

  • Qt normally doesn’t allow us to paint outside of paintEvent(). In particular, we can’t paint from the mouse event handlers. (This behavior can be changed using the WA_PaintOnScreen widget attribute, though.)

  • If initialized properly, a QImage is guaranteed to use 8-bit for each color channel (red, green, blue, and alpha), whereas a QWidget might have a lower color depth, depending on the monitor configuration. This means that if we load a 24-bit or 32-bit image and paint it onto a QWidget , then copy the QWidget into a QImage again, we might lose some information.

def resizeEvent(self, event):        if width() > image.width() or height() > image.height():
    newWidth = qMax(width() + 128, image.width())
    newHeight = qMax(height() + 128, image.height())
    resizeImage(image, QSize(newWidth, newHeight))
    update()

QWidget.resizeEvent(event)

When the user starts the Scribble application, a resize event is generated and an image is created and displayed in the scribble area. We make this initial image slightly larger than the application’s main window and scribble area, to avoid always resizing the image when the user resizes the main window (which would be very inefficient). But when the main window becomes larger than this initial size, the image needs to be resized.

def drawLineTo(self, endPoint):        painter = QPainter(image)
painter.setPen(QPen(myPenColor, myPenWidth, Qt.SolidLine, Qt.RoundCap,
                    Qt.RoundJoin))
painter.drawLine(lastPoint, endPoint)
modified = True
rad = (myPenWidth / 2) + 2
update(QRect(lastPoint, endPoint).normalized()
                                 .adjusted(-rad, -rad, +rad, +rad))
lastPoint = endPoint

In drawLineTo(), we draw a line from the point where the mouse was located when the last mouse press or mouse move occurred, we set modified to true, we generate a repaint event, and we update lastPoint so that next time drawLineTo() is called, we continue drawing from where we left.

We could call the update() function with no parameter, but as an easy optimization we pass a QRect that specifies the rectangle inside the scribble are needs updating, to avoid a complete repaint of the widget.

def resizeImage(self, image, newSize):        if image.size() == newSize:
    return
newImage = QImage(newSize, QImage.Format_RGB32)
newImage.fill(qRgb(255, 255, 255))
painter = QPainter(newImage)
painter.drawImage(QPoint(0, 0), image)
image = newImage

QImage has no nice API for resizing an image. There’s a copy() function that could do the trick, but when used to expand an image, it fills the new areas with black, whereas we want white.

So the trick is to create a brand new QImage with the right size, to fill it with white, and to draw the old image onto it using QPainter . The new image is given the Format_RGB32 format, which means that each pixel is stored as 0xffRRGGBB (where RR, GG, and BB are the red, green and blue color channels, ff is the hexadecimal value 255).

Printing is handled by the print() slot:

def print(self):

#if defined(QT_PRINTSUPPORT_LIB) and QT_CONFIG(printdialog)
    printer = QPrinter(QPrinter.HighResolution)
    printDialog = QPrintDialog(printer, self)

We construct a high resolution QPrinter object for the required output format, using a QPrintDialog to ask the user to specify a page size and indicate how the output should be formatted on the page.

If the dialog is accepted, we perform the task of printing to the paint device:

    if printDialog.exec() == QDialog.Accepted:
        painter = QPainter(printer)
        rect = painter.viewport()
        size = image.size()
        size.scale(rect.size(), Qt.KeepAspectRatio)
        painter.setViewport(rect.x(), rect.y(), size.width(), size.height())
        painter.setWindow(image.rect())
        painter.drawImage(0, 0, image)

#endif // QT_CONFIG(printdialog)

Printing an image to a file in this way is simply a matter of painting onto the QPrinter . We scale the image to fit within the available space on the page before painting it onto the paint device.

MainWindow Class Definition#

class MainWindow(QMainWindow):

    Q_OBJECT
# public
    MainWindow(QWidget parent = None)
# protected
    def closeEvent(event):
# private slots
    def open():
    def save():
    def penColor():
    def penWidth():
    def about():
# private
    def createActions():
    def createMenus():
    maybeSave = bool()
    saveFile = bool(QByteArray fileFormat)
    scribbleArea = ScribbleArea()
    saveAsMenu = QMenu()
    fileMenu = QMenu()
    optionMenu = QMenu()
    helpMenu = QMenu()
    openAct = QAction()
*> = QList<QAction()
    exitAct = QAction()
    penColorAct = QAction()
    penWidthAct = QAction()
    printAct = QAction()
    clearScreenAct = QAction()
    aboutAct = QAction()
    aboutQtAct = QAction()

The MainWindow class inherits from QMainWindow . We reimplement the closeEvent() handler from QWidget . The open(), save(), penColor() and penWidth() slots correspond to menu entries. In addition we create four private functions.

We use the boolean maybeSave() function to check if there are any unsaved changes. If there are unsaved changes, we give the user the opportunity to save these changes. The function returns false if the user clicks Cancel. We use the saveFile() function to let the user save the image currently displayed in the scribble area.

MainWindow Class Implementation#

def __init__(self, parent):
    super().__init__(parent)
    self.scribbleArea = ScribbleArea(self)

    setCentralWidget(scribbleArea)
    createActions()
    createMenus()
    setWindowTitle(tr("Scribble"))
    resize(500, 500)

In the constructor, we create a scribble area which we make the central widget of the MainWindow widget. Then we create the associated actions and menus.

def closeEvent(self, event):            if maybeSave():
        event.accept()
else:
        event.ignore()

Close events are sent to widgets that the users want to close, usually by clicking File|Exit or by clicking the X title bar button. By reimplementing the event handler, we can intercept attempts to close the application.

In this example, we use the close event to ask the user to save any unsaved changes. The logic for that is located in the maybeSave() function. If maybeSave() returns true, there are no modifications or the users successfully saved them, and we accept the event. The application can then terminate normally. If maybeSave() returns false, the user clicked Cancel, so we “ignore” the event, leaving the application unaffected by it.

def open(self):        if maybeSave():
    fileName = QFileDialog.getOpenFileName(self,()
                               tr("Open File"), QDir.currentPath())
    if not fileName.isEmpty():
        scribbleArea.openImage(fileName)

In the open() slot we first give the user the opportunity to save any modifications to the currently displayed image, before a new image is loaded into the scribble area. Then we ask the user to choose a file and we load the file in the ScribbleArea.

def save(self):        action = QAction(sender())
fileFormat = action.data().toByteArray()
saveFile(fileFormat)

The save() slot is called when the users choose the Save As menu entry, and then choose an entry from the format menu. The first thing we need to do is to find out which action sent the signal using sender() . This function returns the sender as a QObject pointer. Since we know that the sender is an action object, we can safely cast the QObject . We could have used a C-style cast or a C++ static_cast<>(), but as a defensive programming technique we use a qobject_cast() . The advantage is that if the object has the wrong type, a null pointer is returned. Crashes due to null pointers are much easier to diagnose than crashes due to unsafe casts.

Once we have the action, we extract the chosen format using data() . (When the actions are created, we use setData() to set our own custom data attached to the action, as a QVariant . More on this when we review createActions().)

Now that we know the format, we call the private saveFile() function to save the currently displayed image.

def penColor(self):        newColor = QColorDialog.getColor(scribbleArea.penColor())
if newColor.isValid():
    scribbleArea.setPenColor(newColor)

We use the penColor() slot to retrieve a new color from the user with a QColorDialog . If the user chooses a new color, we make it the scribble area’s color.

def penWidth(self):        ok = bool()
newWidth = QInputDialog.getInt(self, tr("Scribble"),()
                                    tr("Select pen width:"),
                                    scribbleArea.penWidth(),
                                    1, 50, 1, ok)
if ok:
    scribbleArea.setPenWidth(newWidth)

To retrieve a new pen width in the penWidth() slot, we use QInputDialog . The QInputDialog class provides a simple convenience dialog to get a single value from the user. We use the static getInt() function, which combines a QLabel and a QSpinBox . The QSpinBox is initialized with the scribble area’s pen width, allows a range from 1 to 50, a step of 1 (meaning that the up and down arrow increment or decrement the value by 1).

The boolean ok variable will be set to true if the user clicked OK and to false if the user pressed Cancel.

def about(self):        QMessageBox.about(self, tr("About Scribble"),
        tr("<p>The <b>Scribble</b> example shows how to use QMainWindow as the "
           "base widget for an application, and how to reimplement some of "
           "QWidget's event handlers to receive the events generated for "
           "the application's widgets:</p><p> We reimplement the mouse event "
           "handlers to facilitate drawing, the paint event handler to "
           "update the application and the resize event handler to optimize "
           "the application's appearance. In addition we reimplement the "
           "close event handler to intercept the close events before "
           "terminating the application.</p><p> The example also demonstrates "
           "how to use QPainter to draw an image in real time, as well as "
           "to repaint widgets.</p>"))

We implement the about() slot to create a message box describing what the example is designed to show.

def createActions(self):        openAct = QAction(tr("Open..."), self)
openAct.setShortcuts(QKeySequence.Open)
openAct.triggered.connect(self.open)
imageFormats = QImageWriter.supportedImageFormats()
for format in imageFormats:
    text = tr("%1...").arg(QString.fromLatin1(format).toUpper())
    action = QAction(text, self)
    action.setData(format)
    action.triggered.connect(self.save)
    saveAsActs.append(action)

printAct = QAction(tr("Print..."), self)
printAct.triggered.connect(scribbleArea.print)
exitAct = QAction(tr("Exit"), self)
exitAct.setShortcuts(QKeySequence.Quit)
exitAct.triggered.connect(self.close)
penColorAct = QAction(tr("Pen Color..."), self)
penColorAct.triggered.connect(self.penColor)
penWidthAct = QAction(tr("Pen Width..."), self)
penWidthAct.triggered.connect(self.penWidth)
clearScreenAct = QAction(tr("Clear Screen"), self)
clearScreenAct.setShortcut(tr("Ctrl+L"))
clearScreenAct.triggered.connect(
        scribbleArea.clearImage)
aboutAct = QAction(tr("About"), self)
aboutAct.triggered.connect(self.about)
aboutQtAct = QAction(tr("About Qt"), self)
aboutQtAct.triggered.connect(qApp.aboutQt)

In the createAction() function we create the actions representing the menu entries and connect them to the appropriate slots. In particular we create the actions found in the Save As sub-menu. We use supportedImageFormats() to get a list of the supported formats (as a QList < QByteArray >).

Then we iterate through the list, creating an action for each format. We call setData() with the file format, so we can retrieve it later as data() . We could also have deduced the file format from the action’s text, by truncating the “…”, but that would have been inelegant.

def createMenus(self):        saveAsMenu = QMenu(tr("Save As"), self)
for action in saveAsActs:
    saveAsMenu.addAction(action)
fileMenu = QMenu(tr("File"), self)
fileMenu.addAction(openAct)
fileMenu.addMenu(saveAsMenu)
fileMenu.addAction(printAct)
fileMenu.addSeparator()
fileMenu.addAction(exitAct)
optionMenu = QMenu(tr("Options"), self)
optionMenu.addAction(penColorAct)
optionMenu.addAction(penWidthAct)
optionMenu.addSeparator()
optionMenu.addAction(clearScreenAct)
helpMenu = QMenu(tr("Help"), self)
helpMenu.addAction(aboutAct)
helpMenu.addAction(aboutQtAct)
menuBar().addMenu(fileMenu)
menuBar().addMenu(optionMenu)
menuBar().addMenu(helpMenu)

In the createMenu() function, we add the previously created format actions to the saveAsMenu. Then we add the rest of the actions as well as the saveAsMenu sub-menu to the File, Options and Help menus.

The QMenu class provides a menu widget for use in menu bars, context menus, and other popup menus. The QMenuBar class provides a horizontal menu bar with a list of pull-down QMenu s. At the end we put the File and Options menus in the MainWindow's menu bar, which we retrieve using the menuBar() function.

def maybeSave(self):        if scribbleArea.isModified():
   QMessageBox.StandardButton ret
   ret = QMessageBox.warning(self, tr("Scribble"),
                      tr("The image has been modified.\n"
                         "Do you want to save your changes?"),
                      QMessageBox.Save | QMessageBox.Discard
                      | QMessageBox.Cancel)
    if ret == QMessageBox.Save:
        return saveFile("png")
    elif ret == QMessageBox.Cancel:
        return False

return True

In mayBeSave(), we check if there are any unsaved changes. If there are any, we use QMessageBox to give the user a warning that the image has been modified and the opportunity to save the modifications.

As with QColorDialog and QFileDialog , the easiest way to create a QMessageBox is to use its static functions. QMessageBox provides a range of different messages arranged along two axes: severity (question, information, warning and critical) and complexity (the number of necessary response buttons). Here we use the warning() function sice the message is rather important.

If the user chooses to save, we call the private saveFile() function. For simplicitly, we use PNG as the file format; the user can always press Cancel and save the file using another format.

The maybeSave() function returns false if the user clicks Cancel; otherwise it returns true.

def saveFile(self, QByteArray fileFormat):        initialPath = QDir.currentPath() + "/untitled." + fileFormat()
fileName = QFileDialog.getSaveFileName(self, tr("Save As"),()
                           initialPath,
                           tr("%1 Files (*.%2);;All Files (*)")
                           .arg(QString.fromLatin1(fileFormat.toUpper()))
                           .arg(QString.fromLatin1(fileFormat)))
if fileName.isEmpty():
    return False
return scribbleArea.saveImage(fileName, fileFormat.constData())

In saveFile(), we pop up a file dialog with a file name suggestion. The static getSaveFileName() function returns a file name selected by the user. The file does not have to exist.

Example project @ code.qt.io