Skip to content
This repository has been archived by the owner on Jul 4, 2024. It is now read-only.

Latest commit

 

History

History
73 lines (56 loc) · 2.94 KB

README.md

File metadata and controls

73 lines (56 loc) · 2.94 KB
Raw

QTaskbarControl

A class to create a taskbar/launcher progress and more, for all desktop platforms

Features

  • Show a progress in the taskbar/launcher/dock/…
  • Show a badge with a number in the taskbar/launcher/dock/…
  • Works on:
    • Windows >= 7
    • macOS
    • Linux (Desktops that support the com.canonical.Unity.LauncherEntry D-Bus signal, for example Unity, KDE)
  • Additional Windows Features:
    • Set the badge icon background and text color
    • Set the progress state (running, paused, stopped)
    • Show indeterminate progress

Installation

The package is provided via qdep, as Skycoder42/QTaskbarControl. To use it simply:

  1. Install and enable qdep (See qdep - Installing)
  2. Add the following to your pro file:
QDEP_DEPENDS += Skycoder42/QTaskbarControl
!load(qdep):error("Failed to load qdep feature! Run 'qdep.py prfgen --qmake $$QMAKE_QMAKE' to create it.")

Usage

For Linux and Windows you need additional setup. The following example shows the part thats the same for all platforms:

auto taskbar = new QTaskbarControl(parent);
taskbar->setProgress(0.42);
taskbar->setProgressVisible(true);
taskbar->setCounter(42);
taskbar->setCounterVisible(true);

Additional platform-specific setup

Linux

In order to work, the Linux implementation needs an application with a valid desktop file in an accessible location (e.g. ~/.local/share/applications/ on KDE). You need to set desktopFileName property to enable it. The following steps explain how to properly setup QTaskbarProgress with a desktop file:

  1. Create a .desktop file. For testing purpose, the following should suffice:
[Desktop Entry]
Type=Application
Version=1.1
Name=<MyApp>
Exec=<path_to_MyApp>
  1. Copy that file to a location where desktop files are found by the OS (e.g. ~/.local/share/applications, /usr/local/share/applications, /usr/share/applications)
  2. Register the desktop file in your application:
QGuiApplication::setDesktopFileName("myapp.desktop");

And that's it. When you run the application it should work. I case it doesn't work: Try to set a different icon for the desktop file, e.g. gtk-edit. If you see that icon in the taskbar, your application gets correctly "connected" to that desktop file.

Windows

In order to work, the Windows implementation needs associated window. You can set it via QTaskbarControl::setWidget member function:

auto taskbar = new QTaskbarControl(parent);
taskbar->setWidget(widget);

Since widgets in Qt have a valid QWindow only after showing, this function will install event filter and will set a valid QWindow after widget show event automatically. You can also use QTaskbarControl::setWindow to set QWindow directly.

Icon Reference