QWinThumbnailToolBar Class

The QWinThumbnailToolBar class allows manipulating the thumbnail toolbar of a window. More...

Header:	#include <QWinThumbnailToolBar>
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

count : const int iconicLivePreviewPixmap : QPixmap iconicPixmapNotificationsEnabled : bool

iconicThumbnailPixmap : QPixmap window : QWindow*

Public Functions

	QWinThumbnailToolBar(QObject *parent = nullptr)
virtual	~QWinThumbnailToolBar()
void	addButton(QWinThumbnailToolButton *button)
QList<QWinThumbnailToolButton *>	buttons() const
int	count() const
QPixmap	iconicLivePreviewPixmap() const
bool	iconicPixmapNotificationsEnabled() const
QPixmap	iconicThumbnailPixmap() const
void	removeButton(QWinThumbnailToolButton *button)
void	setButtons(const QList<QWinThumbnailToolButton *> &buttons)
void	setIconicPixmapNotificationsEnabled(bool enabled)
void	setWindow(QWindow *window)
QWindow *	window() const

Public Slots

void	clear()
void	setIconicLivePreviewPixmap(const QPixmap &)
void	setIconicThumbnailPixmap(const QPixmap &)

Signals

void	iconicLivePreviewPixmapRequested()
void	iconicThumbnailPixmapRequested()

Detailed Description

Applications can embed a toolbar in the thumbnail of a window, which is shown when hovering over its taskbar icon. A thumbnail toolbar may provide quick access to the commands of a window without requiring the user to restore or activate the window.

The following example code illustrates how to use the functions in the QWinThumbnailToolBar and QWinThumbnailToolButton class to implement a thumbnail toolbar:

    QWinThumbnailToolBar *thumbbar = new QWinThumbnailToolBar(widget);
    thumbbar->setWindow(widget->windowHandle());

    QWinThumbnailToolButton *settings = new QWinThumbnailToolButton(thumbbar);
    settings->setToolTip("Settings");
    settings->setIcon(":/settings.png");
    settings->setDismissOnClick(true);
    connect(settings, SIGNAL(clicked()), settingsPage, SLOT(show()));

    QWinThumbnailToolButton *playPause = new QWinThumbnailToolButton(thumbbar);
    playPause->setToolTip("Play/Pause");
    playPause->setIcon(":/play.png");
    connect(playPause, SIGNAL(clicked()), mediaPlayer, SLOT(play()));

    thumbbar->addButton(settings);
    thumbbar->addButton(playPause);

See also QWinThumbnailToolButton.

Member Function Documentation

QWinThumbnailToolBar::QWinThumbnailToolBar(QObject *parent = nullptr)

Constructs a QWinThumbnailToolBar with the specified parent.

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

[slot] void QWinThumbnailToolBar::clear()

Removes all buttons from the thumbnail toolbar.

[signal] void QWinThumbnailToolBar::iconicLivePreviewPixmapRequested()

This signal is emitted when the operating system requests a new iconic live preview pixmap, typically when the user ALT-tabs to the application.

This function was introduced in Qt 5.4.

See also iconicLivePreviewPixmap.

[signal] void QWinThumbnailToolBar::iconicThumbnailPixmapRequested()

This signal is emitted when the operating system requests a new iconic thumbnail pixmap, typically when the thumbnail is shown.

This function was introduced in Qt 5.4.

See also iconicThumbnailPixmap.

[virtual] QWinThumbnailToolBar::~QWinThumbnailToolBar()

Destroys and clears the QWinThumbnailToolBar.

void QWinThumbnailToolBar::addButton(QWinThumbnailToolButton *button)

Adds a button to the thumbnail toolbar.

Note: The number of buttons is limited to 7.

QList<QWinThumbnailToolButton *> QWinThumbnailToolBar::buttons() const

Returns the list of buttons in the thumbnail toolbar.

See also setButtons().

void QWinThumbnailToolBar::removeButton(QWinThumbnailToolButton *button)

Removes the button from the thumbnail toolbar.

void QWinThumbnailToolBar::setButtons(const QList<QWinThumbnailToolButton *> &buttons)

Sets the list of buttons in the thumbnail toolbar.

Note: Any existing buttons are replaced.

See also buttons().