Image Viewer Example

The example shows how to combine QLabel and QScrollArea to display an image.

QLabel is typically used for displaying text, but it can also display an image. QScrollArea provides a scrolling view around another widget. If the child widget exceeds the size of the frame, QScrollArea automatically provides scroll bars.

The example demonstrates how QLabel ‘s ability to scale its contents ( scaledContents ), and QScrollArea ‘s ability to automatically resize its contents ( widgetResizable ), can be used to implement zooming and scaling features. In addition the example shows how to use QPainter to print an image.

With the Image Viewer application, the users can view an image of their choice. The File menu gives the user the possibility to:

• Open… - Open an image file

• Print… - Print an image

• Exit - Exit the application

Once an image is loaded, the View menu allows the users to:

• Zoom In - Scale the image up by 25%

• Zoom Out - Scale the image down by 25%

• Normal Size - Show the image at its original size

• Fit to Window - Stretch the image to occupy the entire window

In addition the Help menu provides the users with information about the Image Viewer example in particular, and about Qt in general.

ImageViewer Class Definition

class ImageViewer(QMainWindow):

    Q_OBJECT
# public
    ImageViewer(QWidget parent = None)
    loadFile = bool(QString )
slots: = private()
    def open():
    def saveAs():
    def print():
    def copy():
    def paste():
    def zoomIn():
    def zoomOut():
    def normalSize():
    def fitToWindow():
    def about():
# private
    def createActions():
    def createMenus():
    def updateActions():
    saveFile = bool(QString fileName)
    def setImage(newImage):
    def scaleImage(factor):
    def adjustScrollBar(scrollBar, factor):
    image = QImage()
    imageLabel = QLabel()
    scrollArea = QScrollArea()
    scaleFactor = 1
#if defined(QT_PRINTSUPPORT_LIB) and QT_CONFIG(printer)
    printer = QPrinter()
#endif
    saveAsAct = QAction()
    printAct = QAction()
    copyAct = QAction()
    zoomInAct = QAction()
    zoomOutAct = QAction()
    normalSizeAct = QAction()
    fitToWindowAct = QAction()

The ImageViewer class inherits from QMainWindow . We reimplement the constructor, and create several private slots to facilitate the menu entries. In addition we create four private functions.

We use createActions() and createMenus() when constructing the ImageViewer widget. We use the updateActions() function to update the menu entries when a new image is loaded, or when the Fit to Window option is toggled. The zoom slots use scaleImage() to perform the zooming. In turn, scaleImage() uses adjustScrollBar() to preserve the focal point after scaling an image.

ImageViewer Class Implementation

def __init__(self, parent):
    QMainWindow.__init__(self, parent)
    self.imageLabel = QLabel
   , scrollArea(QScrollArea)

    imageLabel.setBackgroundRole(QPalette.Base)
    imageLabel.setSizePolicy(QSizePolicy.Ignored, QSizePolicy.Ignored)
    imageLabel.setScaledContents(True)
    scrollArea.setBackgroundRole(QPalette.Dark)
    scrollArea.setWidget(imageLabel)
    scrollArea.setVisible(False)
    setCentralWidget(scrollArea)
    createActions()
    resize(QGuiApplication.primaryScreen().availableSize() * 3 / 5)

In the constructor we first create the label and the scroll area.

We set imageLabel's size policy to ignored , making the users able to scale the image to whatever size they want when the Fit to Window option is turned on. Otherwise, the default size polizy ( preferred ) will make scroll bars appear when the scroll area becomes smaller than the label’s minimum size hint.

We ensure that the label will scale its contents to fill all available space, to enable the image to scale properly when zooming. If we omitted to set the imageLabel's scaledContents property, zooming in would enlarge the QLabel , but leave the pixmap at its original size, exposing the QLabel ‘s background.

We make imageLabel the scroll area’s child widget, and we make scrollArea the central widget of the QMainWindow . At the end we create the associated actions and menus, and customize the ImageViewer's appearance.

def initializeImageFileDialog(dialog, acceptMode):

    firstDialog = True()
    if (firstDialog) {
        firstDialog = False
        picturesLocations = QStandardPaths.standardLocations(QStandardPaths.PicturesLocation)
        dialog.setDirectory(picturesLocations.isEmpty() if QDir.currentPath() else picturesLocations.last())

    mimeTypeFilters = QStringList()
    supportedMimeTypes = acceptMode == QFileDialog.AcceptOpen
        ? QImageReader.supportedMimeTypes() : QImageWriter.supportedMimeTypes()
    for mimeTypeName in supportedMimeTypes:
        mimeTypeFilters.append(mimeTypeName)
    mimeTypeFilters.sort()
    dialog.setMimeTypeFilters(mimeTypeFilters)
    dialog.selectMimeTypeFilter("image/jpeg")
    dialog.setAcceptMode(acceptMode)
    if (acceptMode == QFileDialog.AcceptSave)
        dialog.setDefaultSuffix("jpg")

def open(self):

    dialog = QFileDialog(self, tr("Open File"))
    initializeImageFileDialog(dialog, QFileDialog.AcceptOpen)
    while (dialog.exec() == QDialog.Accepted and not loadFile(dialog.selectedFiles().constFirst())) {}

In the open() slot, we show a file dialog to the user. We compile a list of mime types for use as a filter by querying QImageReader for the available mime type names.

We show the file dialog until a valid file name is entered or the user cancels.

The function loadFile() is used to load the image.

def loadFile(self, QString fileName):

    reader = QImageReader(fileName)
    reader.setAutoTransform(True)
    newImage = reader.read()
    if (newImage.isNull()) {
        QMessageBox.information(self, QGuiApplication.applicationDisplayName(),
                                 tr("Cannot load %1: %2")
                                 .arg(QDir.toNativeSeparators(fileName), reader.errorString()))
        return False

In the loadFile() function, we instantiate a QImageReader and enable automatic transformations by calling setAutoTransform() . For files in JPEG format, this ensures that portrait mode images of digital cameras are shown correctly by applying the appropriate orientation read from the EXIF meta data stored in the image file.

We then load the image using read() . If this returns a null image, indicating that the file is not an image file, we use a QMessageBox to alert the user.

The QMessageBox class provides a modal dialog with a short message, an icon, and some buttons. As with QFileDialog the easiest way to create a QMessageBox is to use its static convenience 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). In this particular example an information message with an OK button (the default) is sufficient, since the message is part of a normal operation.

scaleFactor = 1.0
scrollArea.setVisible(True)
printAct.setEnabled(True)
fitToWindowAct.setEnabled(True)
updateActions()
if (not fitToWindowAct.isChecked())
    imageLabel.adjustSize()

If the format is supported, we display the image in imageLabel by setting the label’s pixmap . Then we enable the Print and Fit to Window menu entries and update the rest of the view menu entries. The Open and Exit entries are enabled by default.

If the Fit to Window option is turned off, the widgetResizable property is false and it is our responsibility (not QScrollArea ‘s) to give the QLabel a reasonable size based on its contents. We call { adjustSize() }{adjustSize()} to achieve this, which is essentially the same as

imageLabel->resize(imageLabel->pixmap()->size());

In the print() slot, we first make sure that an image has been loaded into the application:

def print(self):            Q_ASSERT(not imageLabel.pixmap(Qt.ReturnByValue).isNull())
#if defined(QT_PRINTSUPPORT_LIB) and QT_CONFIG(printdialog)

If the application is built in debug mode, the Q_ASSERT() macro will expand to

if (imageLabel->pixmap(Qt::ReturnByValue).isNull())
    qFatal("ASSERT: "imageLabel->pixmap(Qt::ReturnByValue).isNull()" in file ...");

In release mode, the macro simply disappear. The mode can be set in the application’s .pro file. One way to do so is to add an option to qmake when building the application:

qmake "CONFIG += debug" foo.pro

or

qmake "CONFIG += release" foo.pro

Another approach is to add this line directly to the .pro file.

dialog = QPrintDialog(printer, self)            if (dialog.exec()) {
        painter = QPainter(printer)
        pixmap = imageLabel.pixmap(Qt.ReturnByValue)
        rect = painter.viewport()
        size = pixmap.size()
        size.scale(rect.size(), Qt.KeepAspectRatio)
        painter.setViewport(rect.x(), rect.y(), size.width(), size.height())
        painter.setWindow(pixmap.rect())
        painter.drawPixmap(0, 0, pixmap)

#endif

Then we present a print dialog allowing the user to choose a printer and to set a few options. We construct a painter with a QPrinter as the paint device. We set the painter’s window and viewport in such a way that the image is as large as possible on the paper, but without altering its aspect ratio .

In the end we draw the pixmap at position (0, 0).

def zoomIn(self):            scaleImage(1.25)

def zoomOut(self):

    scaleImage(0.8)

We implement the zooming slots using the private scaleImage() function. We set the scaling factors to 1.25 and 0.8, respectively. These factor values ensure that a Zoom In action and a Zoom Out action will cancel each other (since 1.25 * 0.8 == 1), and in that way the normal image size can be restored using the zooming features.

The screenshots below show an image in its normal size, and the same image after zooming in:

def normalSize(self):        imageLabel.adjustSize()
scaleFactor = 1.0

When zooming, we use the QLabel ‘s ability to scale its contents. Such scaling doesn’t change the actual size hint of the contents. And since the adjustSize() function use those size hint, the only thing we need to do to restore the normal size of the currently displayed image is to call adjustSize() and reset the scale factor to 1.0.

def fitToWindow(self):        fitToWindow = fitToWindowAct.isChecked()
scrollArea.setWidgetResizable(fitToWindow)
if (not fitToWindow)
    normalSize()
updateActions()

The fitToWindow() slot is called each time the user toggled the Fit to Window option. If the slot is called to turn on the option, we tell the scroll area to resize its child widget with the setWidgetResizable() function. Then we disable the Zoom In, Zoom Out and Normal Size menu entries using the private updateActions() function.

If the widgetResizable property is set to false (the default), the scroll area honors the size of its child widget. If this property is set to true, the scroll area will automatically resize the widget in order to avoid scroll bars where they can be avoided, or to take advantage of extra space. But the scroll area will honor the minimum size hint of its child widget independent of the widget resizable property. So in this example we set imageLabel's size policy to ignored in the constructor, to avoid that scroll bars appear when the scroll area becomes smaller than the label’s minimum size hint.

The screenshots below shows an image in its normal size, and the same image with the Fit to window option turned on. Enlarging the window will stretch the image further, as shown in the third screenshot.

If the slot is called to turn off the option, the { setWidgetResizable } property is set to false. We also restore the image pixmap to its normal size by adjusting the label’s size to its content. And in the end we update the view menu entries.

def about(self):        QMessageBox.about(self, tr("About Image Viewer"),
        tr("<p>The <b>Image Viewer</b> example shows how to combine QLabel "
           "and QScrollArea to display an image. QLabel is typically used "
           "for displaying a text, but it can also display an image. "
           "QScrollArea provides a scrolling view around another widget. "
           "If the child widget exceeds the size of the frame, QScrollArea "
           "automatically provides scroll bars. </p><p>The example "
           "demonstrates how QLabel's ability to scale its contents "
           "(QLabel.scaledContents), and QScrollArea's ability to "
           "automatically resize its contents "
           "(QScrollArea.widgetResizable), can be used to implement "
           "zooming and scaling features. </p><p>In addition the example "
           "shows how to use QPainter to print an image.</p>"))

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

def createActions(self):        fileMenu = menuBar().addMenu(tr("File"))
openAct = fileMenu.addAction(tr("Open..."), self, ImageViewer::open)
openAct.setShortcut(QKeySequence.Open)
saveAsAct = fileMenu.addAction(tr("Save As..."), self, ImageViewer::saveAs)
saveAsAct.setEnabled(False)
printAct = fileMenu.addAction(tr("Print..."), self, ImageViewer::print)
printAct.setShortcut(QKeySequence.Print)
printAct.setEnabled(False)
fileMenu.addSeparator()
exitAct = fileMenu.addAction(tr("Exit"), self, QWidget.close)
exitAct.setShortcut(tr("Ctrl+Q"))
editMenu = menuBar().addMenu(tr("Edit"))
copyAct = editMenu.addAction(tr("Copy"), self, ImageViewer::copy)
copyAct.setShortcut(QKeySequence.Copy)
copyAct.setEnabled(False)
pasteAct = editMenu.addAction(tr("Paste"), self, ImageViewer::paste)
pasteAct.setShortcut(QKeySequence.Paste)
viewMenu = menuBar().addMenu(tr("View"))
zoomInAct = viewMenu.addAction(tr("Zoom In (25%)"), self, ImageViewer::zoomIn)
zoomInAct.setShortcut(QKeySequence.ZoomIn)
zoomInAct.setEnabled(False)
zoomOutAct = viewMenu.addAction(tr("Zoom Out (25%)"), self, ImageViewer::zoomOut)
zoomOutAct.setShortcut(QKeySequence.ZoomOut)
zoomOutAct.setEnabled(False)
normalSizeAct = viewMenu.addAction(tr("Normal Size"), self, ImageViewer::normalSize)
normalSizeAct.setShortcut(tr("Ctrl+S"))
normalSizeAct.setEnabled(False)
viewMenu.addSeparator()
fitToWindowAct = viewMenu.addAction(tr("Fit to Window"), self, ImageViewer::fitToWindow)
fitToWindowAct.setEnabled(False)
fitToWindowAct.setCheckable(True)
fitToWindowAct.setShortcut(tr("Ctrl+F"))
helpMenu = menuBar().addMenu(tr("Help"))
helpMenu.addAction(tr("About"), self, ImageViewer::about)
helpMenu.addAction(tr("About Qt"), self, QApplication.aboutQt)

In the private createAction() function, we create the actions providing the application features and populate a menu with them.

We assign a short-cut key to each action and connect them to the appropriate slots. We only enable the openAct and exitAct at the time of creation, the others are updated once an image has been loaded into the application. In addition we make the fitToWindowAct checkable .

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 that consists of a list of pull-down menu items. So we put the menus in the ImageViewer's menu bar which we retrieve with the menuBar() function.

def updateActions(self):        saveAsAct.setEnabled(not image.isNull())
copyAct.setEnabled(not image.isNull())
zoomInAct.setEnabled(not fitToWindowAct.isChecked())
zoomOutAct.setEnabled(not fitToWindowAct.isChecked())
normalSizeAct.setEnabled(not fitToWindowAct.isChecked())

The private updateActions() function enables or disables the Zoom In, Zoom Out and Normal Size menu entries depending on whether the Fit to Window option is turned on or off.

def scaleImage(self, factor):         = factor
imageLabel.resize(scaleFactor * imageLabel.pixmap(Qt.ReturnByValue).size())
adjustScrollBar(scrollArea.horizontalScrollBar(), factor)
adjustScrollBar(scrollArea.verticalScrollBar(), factor)
zoomInAct.setEnabled(scaleFactor < 3.0)
zoomOutAct.setEnabled(scaleFactor > 0.333)

In scaleImage(), we use the factor parameter to calculate the new scaling factor for the displayed image, and resize imageLabel. Since we set the scaledContents property to true in the constructor, the call to resize() will scale the image displayed in the label. We also adjust the scroll bars to preserve the focal point of the image.

At the end, if the scale factor is less than 33.3% or greater than 300%, we disable the respective menu entry to prevent the image pixmap from becoming too large, consuming too much resources in the window system.

def adjustScrollBar(self, scrollBar, factor):        scrollBar.setValue(int(factor * scrollBar.value()
                        + ((factor - 1) * scrollBar.pageStep()/2)))

Whenever we zoom in or out, we need to adjust the scroll bars in consequence. It would have been tempting to simply call

scrollBar->setValue(int(factor * scrollBar->value()));

but this would make the top-left corner the focal point, not the center. Therefore we need to take into account the scroll bar handle’s size (the page step ).

Example project @ code.qt.io