Busy Indicator

Introduction

Certain graphical assets may take a while to load or you may wish to show that some other processing is going on. This custom BusyIndicator shows one way in which visual feedback can be provided. This busy indicator has been implemented as a custom QDeclarativeItem in C++ since it uses a conical gradient which it is not possible to represent in an SVG (which only have support for linear and radial gradients). We do take care to minimise the amount of expensive imperative drawing operations. My inspiration for this design comes from StarCraft 2 ;-)

Implementation

First, here is the class declaration:

This is quite a simple sub-class of QDeclarativeItem with only a handful of properties for setting the inner and outer radii of the busy indicator’s ring as a fraction of the item’s size. In this case the item’s size is defined to be min( width, height ) so as to preserve the 1:1 aspect ratio of the ring.

Now for the implementation:

In the constructor we set up a default size of 100×100 pixels for the indicator and call the updateSpinner() function. This function is also called whenever one of the affecting properties changes. These are:

• Height
• Width
• Inner radius
• Outer radius
• Background color
• Foreground color

The implementation of the updateSpinner() function only calculates a new QString value which is later used in paint() as a key in the global QPixmapCache. In the paint() function we check to see if the QPixmapCache already contains a matching pixmap or not. If it does we paint it. If it does not we first generate it, store it in the cache and then paint it.

This approach minimises the amount of expensive painting calls and key constructions.

Usage

Before we can use our custom item in any QML scene we need to expose it to the QML world. We do this with something along these lines:

Then in your QML scene you need to instruct the QML backend to import this collection (of 1) components with:

You are now ready to roll.

Independent Usage

The above should provide you with a nicely spinning busy indicator. Obviously the size and colors can be varied using the properties we declared in the header file.

Compound Usage Within Another Component

It is also easy to include the BusyIndicator into compound components. One example might be for slow to load images:

This will show a nice spinning busy indicator until the image is loaded. Of course you can expose more of the properties to the outside world if you like – this is just a simple example after all.

Another example using this Busy Indicator component along with a small progress bar in the center of the spinning ring to show loading progress for e.g. is shown in this snippet [developer.qt.nokia.com].

Independent Usage as Widget

This implementation of a busy indicator can also be used without QML. It can be added as widget through QGraphicsView [developer.qt.nokia.com] and QGraphicsScene [developer.qt.nokia.com] to a layout [developer.qt.nokia.com] and animated with QTimeLine [developer.qt.nokia.com] as shown at the following example. It is important to note that the viewport must be set in order to display the busy indicator.

Example

• pro file

• mainwindow.h
  
  1. #ifndef MAINWINDOW_H
  2. #define MAINWINDOW_H
  3.  
  4. #include <QtGui/QMainWindow>
  5. #include "busyindicator.h"
  6.  
  7. #include <QGraphicsScene>
  8. #include <QTimeLine>
  9.  
  10. namespace Ui {
  11.     class MainWindow;
  12. }
  13.  
  14. class MainWindow : public QMainWindow
  15. {
  16.     Q_OBJECT
  17. public:
  18.     enum ScreenOrientation {
  19.         ScreenOrientationLockPortrait,
  20.         ScreenOrientationLockLandscape,
  21.         ScreenOrientationAuto
  22.     };
  23.  
  24.     explicit MainWindow(QWidget *parent = 0);
  25.     virtual ~MainWindow();
  26.  
  27. private slots:
  28.  
  29.     void rotateSpinner(int nValue);
  30.  
  31. private:
  32.  
  33.     BusyIndicator* m_pBusyIndicator;
  34.  
  35.     QGraphicsScene* m_scene;
  36.  
  37.     QTimeLine* m_pTimeLine;
  38.  
  39. };
  40.  
  41. #endif // MAINWINDOW_H

• mainwindow.cpp
  
  1. #include "mainwindow.h"
  2.  
  3. #include <QtCore/QCoreApplication>
  4.  
  5. #include <QGraphicsView>
  6. #include <QVBoxLayout>
  7.  
  8. MainWindow::MainWindow(QWidget *parent)
  9.     : QMainWindow(parent), m_pBusyIndicator(NULL), m_pTimeLine(NULL)
  10. {
  11.     QLayout* pLayout = new QVBoxLayout();
  12.  
  13.     QGraphicsScene* pScene = new QGraphicsScene(this);
  14.     m_pBusyIndicator = new BusyIndicator();
  15.     pScene->addItem(dynamic_cast<QGraphicsItem*>(m_pBusyIndicator));
  16.  
  17.     QGraphicsView* pView = new QGraphicsView(pScene, this);
  18.     pView->setViewport(this);
  19.     pView->setMinimumHeight(200);
  20.     pView->show();
  21.  
  22.     pLayout->addWidget(pView);
  23.     setLayout(pLayout);
  24.  
  25.     m_pTimeLine = new QTimeLine(1000, this);
  26.     m_pTimeLine->setLoopCount(0);
  27.     m_pTimeLine->setFrameRange(0, 36);
  28.  
  29.     connect(m_pTimeLine, SIGNAL(frameChanged(int)), this, SLOT(rotateSpinner(int)));
  30.     m_pTimeLine->start();
  31.  
  32. }
  33. //------------------------------------------------------------------------------
  34.  
  35.  
  36. MainWindow::~MainWindow()
  37. {
  38.     //Nothing to do
  39. }
  40. //------------------------------------------------------------------------------
  41.  
  42. void MainWindow::rotateSpinner(int nValue)
  43. {
  44.     qreal nTransX = m_pBusyIndicator->actualOuterRadius();
  45.     m_pBusyIndicator->setTransform(QTransform().translate(nTransX, nTransX).
  46.                         rotate(nValue*10).translate(-1*nTransX, -1*nTransX));
  47. }
  48. //------------------------------------------------------------------------------

Categories:

• Developing_with_Qt
  • Qt_Quick
• QML

HowTo

snippets