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 |
Properties
- overlayAccessibleDescription : QString
- overlayIcon : QIcon
- progress : QWinTaskbarProgress* const
- window : QWindow*
- 1 property inherited from QObject
Public Functions
QWinTaskbarButton(QObject *parent = nullptr) | |
virtual | ~QWinTaskbarButton() |
QString | overlayAccessibleDescription() const |
QIcon | overlayIcon() const |
QWinTaskbarProgress * | progress() const |
void | setWindow(QWindow *window) |
QWindow * | window() const |
- 31 public functions inherited from QObject
Public Slots
void | clearOverlayIcon() |
void | setOverlayAccessibleDescription(const QString &description) |
void | setOverlayIcon(const QIcon &icon) |
- 1 public slot inherited from QObject
Static Public Members
const QMetaObject | staticMetaObject |
- 9 static public members inherited from QObject
Additional Inherited Members
Detailed Description
The QWinTaskbarButton class represents the Windows taskbar button for a top-level window (Windows 7 and newer).
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.
Property Documentation
overlayAccessibleDescription : QString
This property holds the description of the overlay for accessibility purposes
Access functions:
QString | overlayAccessibleDescription() const |
void | setOverlayAccessibleDescription(const QString &description) |
See also overlayIcon.
overlayIcon : QIcon
This property holds the overlay icon of the taskbar button
Access functions:
QIcon | overlayIcon() const |
void | setOverlayIcon(const QIcon &icon) |
void | clearOverlayIcon() |
progress : QWinTaskbarProgress* const
This property holds the progress indicator of the taskbar button
Note: The progress indicator is not visible by default.
Access functions:
QWinTaskbarProgress * | progress() const |
window : QWindow*
This property holds the window whose taskbar button is manipulated
Access functions:
QWindow * | window() const |
void | setWindow(QWindow *window) |
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.
© 2019 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.