QWinJumpList Class

The QWinJumpList class represents a transparent wrapper around Windows Jump Lists. More...

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

identifier : QString

Public Functions

	QWinJumpList(QObject *parent = nullptr)
virtual	~QWinJumpList()
void	addCategory(QWinJumpListCategory *category)
QWinJumpListCategory *	addCategory(const QString &title, const QList<QWinJumpListItem > items* = QList<QWinJumpListItem *>())
QList<QWinJumpListCategory *>	categories() const
QWinJumpListCategory *	frequent() const
QString	identifier() const
QWinJumpListCategory *	recent() const
void	setIdentifier(const QString &identifier)
QWinJumpListCategory *	tasks() const

Public Slots

void	clear()

Detailed Description

An application can use Jump Lists to provide users with faster access to files or to display shortcuts to tasks or commands.

Property Documentation

identifier : QString

This property holds the jump list identifier

Specifies an optional explicit unique identifier for the application jump list.

The default value is empty; a system-defined internal identifier is used instead. See Application User Model IDs on MSDN for further details.

Note: The identifier cannot have more than 128 characters and cannot contain spaces. A too long identifier is automatically truncated to 128 characters, and spaces are replaced by underscores.

Access functions:

QString	identifier() const
void	setIdentifier(const QString &identifier)

Member Function Documentation

QWinJumpList::QWinJumpList(QObject **parent* = nullptr)

Constructs a QWinJumpList with the parent object parent.

`[slot]` void QWinJumpList::clear()

Clears the jump list.

See also QWinJumpListCategory::clear().

`[virtual]` QWinJumpList::~QWinJumpList()

Destroys the QWinJumpList.

void QWinJumpList::addCategory(QWinJumpListCategory **category*)

Adds a custom category to the jump list.

QWinJumpListCategory QWinJumpList::addCategory(const QString &title, const QList<QWinJumpListItem > items = QList<QWinJumpListItem *>())

This function overloads addCategory().

Creates a custom category with provided title and optional items, and adds it to the jump list.

QList<QWinJumpListCategory *> QWinJumpList::categories() const

Returns the custom categories in the jump list.

QWinJumpListCategory *QWinJumpList::frequent() const

Returns the frequent items category in the jump list.

QWinJumpListCategory *QWinJumpList::recent() const

Returns the recent items category in the jump list.

QWinJumpListCategory *QWinJumpList::tasks() const

Returns the tasks category in the jump list.

Contents