QWinJumpListCategory Class

The QWinJumpListCategory class represents a jump list category. More...

Header: #include <QWinJumpListCategory>
qmake: QT += winextras
Since: Qt 5.2

Public Types

enum Type { Custom, Recent, Frequent, Tasks }

Public Functions

QWinJumpListCategory(const QString &title = QString())
~QWinJumpListCategory()
QWinJumpListItem *addDestination(const QString &filePath)
void addItem(QWinJumpListItem *item)
QWinJumpListItem *addLink(const QString &title, const QString &executablePath, const QStringList &arguments = QStringList())
QWinJumpListItem *addLink(const QIcon &icon, const QString &title, const QString &executablePath, const QStringList &arguments = QStringList())
QWinJumpListItem *addSeparator()
void clear()
int count() const
bool isEmpty() const
bool isVisible() const
QList<QWinJumpListItem *> items() const
void setTitle(const QString &title)
void setVisible(bool visible)
QString title() const
Type type() const

Detailed Description

The QWinJumpListCategory class represents a jump list category.

Member Type Documentation

enum QWinJumpListCategory::Type

This enum describes the available QWinJumpListCategory types.

ConstantValueDescription
QWinJumpListCategory::Custom0A custom jump list category.
QWinJumpListCategory::Recent1A jump list category of "recent" items.
QWinJumpListCategory::Frequent2A jump list category of "frequent" items.
QWinJumpListCategory::Tasks3A jump list category of tasks.

Member Function Documentation

QWinJumpListCategory::QWinJumpListCategory(const QString &title = QString())

Constructs a custom QWinJumpListCategory with the specified title.

QWinJumpListCategory::~QWinJumpListCategory()

Destroys the QWinJumpListCategory.

QWinJumpListItem *QWinJumpListCategory::addDestination(const QString &filePath)

Adds a destination to the category pointing to filePath.

void QWinJumpListCategory::addItem(QWinJumpListItem *item)

Adds an item to the category.

Adds a link to the category using title, executablePath, and optionally arguments.

This function overloads addLink().

Adds a link to the category using icon, title, executablePath, and optionally arguments.

QWinJumpListItem *QWinJumpListCategory::addSeparator()

Adds a separator to the category.

Note: Only tasks category supports separators.

void QWinJumpListCategory::clear()

Clears the category.

int QWinJumpListCategory::count() const

Returns the amount of items in the category.

bool QWinJumpListCategory::isEmpty() const

Returns whether the category is empty.

bool QWinJumpListCategory::isVisible() const

Returns whether the category is visible.

QList<QWinJumpListItem *> QWinJumpListCategory::items() const

Returns the list of items in the category.

void QWinJumpListCategory::setTitle(const QString &title)

Sets the category title.

See also title().

void QWinJumpListCategory::setVisible(bool visible)

Sets the category visible.

See also isVisible().

QString QWinJumpListCategory::title() const

Returns the category title.

See also setTitle().

Type QWinJumpListCategory::type() const

Returns the category type.

© 2017 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.