Skip to content

A user interaction analysis and heatmap generation toolkit for widget based Qt applications.

License

Notifications You must be signed in to change notification settings

aschet/qlickinspector

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

37 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

QlickInspector

QlickInspector is a library for widget based Qt applications which purpose is to help you to refine your UI. When embedded in your application, QlickInspector records clicks by users and is able to render element based heatmaps that visualize the click frequency on the specific elements. With the hotkey F12 (when enabled) a screenshot of the current window with a heatmap overlay can be generated.

Heatmap Example

Integration

Use to following statements to integrate QlickInspector into your application:

#include <QtWidgets/QApplication>
#include <QtCore/QDir>
#include <qlickinspector.h>

int main(int argc, char *argv[])
{
    QApplication a(argc, argv);
    QlickInspector inspector(&a, QDir::homePath() + "/eventlog");
    inspector.setEnabled(true);
    // NOTE: enable only for users which should be able to generate heatmap reports
    inspector.setHotKeyEnabled(true);
    // ...
    return a.exec();
}

Furthermore all widgets in your application require a unique object name because the object name of a widget, including all object names its parent widgets are used for id generation (e.g. dialog/groupBox/pushButton).

Limitations

  • Widgets require unique object names (in the current child context) for correct data acquisition.
  • The hotkey can only generate a report for the current window (no support for menu hierarchies).
  • No recognition of menu items since they are not represented as widgets.
  • Qt Quick is currently not supported (since I do not have experience in this area).
  • Only click based interactions are measured.
  • No server component, data is only stored and processed on the client side.
  • The storage backend does not support unicode filenames on Microsoft Windows.

Compiling

On Microsoft Windows open a Visual Stuido command prompt, ensure that qmake is in your PATH and that you have configured your QTDIR environment variable:

qmake
nmake
nmake install

On Unix based operating systems ensure that you have a build toolchain installed, qmake is in your PATH and that you have configured your QTDIR environment variable:

qmake
make
make install

© 2017 Thomas Ascher

About

A user interaction analysis and heatmap generation toolkit for widget based Qt applications.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published