QWinTaskbarButton Class

The QWinTaskbarButton class represents the Windows taskbar button for a top-level window (Windows 7 and newer). More...

Header:	#include <QWinTaskbarButton>
qmake:	QT += winextras
Since:	Qt 5.2
Inherits:	QObject

This class was introduced in Qt 5.2.

• List of all members, including inherited members

Properties

• overlayAccessibleDescription : QString
• overlayIcon : QIcon
• progress : QWinTaskbarProgress* const
• window : QWindow*

Public Functions

	QWinTaskbarButton(QObject *parent = nullptr)
virtual	~QWinTaskbarButton()
QString	overlayAccessibleDescription() const
QIcon	overlayIcon() const
QWinTaskbarProgress *	progress() const
void	setWindow(QWindow *window)
QWindow *	window() const

Public Slots

void	clearOverlayIcon()
void	setOverlayAccessibleDescription(const QString &description)
void	setOverlayIcon(const QIcon &icon)

Detailed Description

The QWinTaskbarButton class enables you to set overlay icons on a taskbar button, and provides access to its progress indicator.

An overlay icon indicates change in the state of an application, whereas a progress indicator shows how time-consuming tasks are progressing.

The following example code illustrates how to use the QWinTaskbarButton and QWinTaskbarProgress classes to adjust the look of the taskbar button:

    QWinTaskbarButton *button = new QWinTaskbarButton(widget);
    button->setWindow(widget->windowHandle());
    button->setOverlayIcon(QIcon(":/loading.png"));

    QWinTaskbarProgress *progress = button->progress();
    progress->setVisible(true);
    progress->setValue(50);

Note: QWidget::windowHandle() returns a valid instance of a QWindow only after the widget has been shown. It is therefore recommended to delay the initialization of the QWinTaskbarButton instances until QWidget::showEvent().

Note: The class wraps API only available since Windows 7. Instantiating it on Windows XP or Windows Vista causes a runtime warning.

See also QWinTaskbarProgress.

Member Function Documentation

QWinTaskbarButton::QWinTaskbarButton(QObject *parent = nullptr)

Constructs a QWinTaskbarButton with the specified parent.

If parent is an instance of QWindow, it is automatically assigned as the taskbar button's window.

[virtual] QWinTaskbarButton::~QWinTaskbarButton()

Destroys the QWinTaskbarButton.