QWinJumpListItem Class
The QWinJumpListItem class represents a jump list item. More...
| Header: | #include <QWinJumpListItem> |
| qmake: | QT += winextras |
| Since: | Qt 5.2 |
Public Types
| enum | Type { Destination, Link, Separator } |
Public Functions
| QWinJumpListItem(Type type) | |
| ~QWinJumpListItem() | |
| QStringList | arguments() const |
| QString | description() const |
| QString | filePath() const |
| QIcon | icon() const |
| void | setArguments(const QStringList &arguments) |
| void | setDescription(const QString &description) |
| void | setFilePath(const QString &filePath) |
| void | setIcon(const QIcon &icon) |
| void | setTitle(const QString &title) |
| void | setType(Type type) |
| void | setWorkingDirectory(const QString &workingDirectory) |
| QString | title() const |
| Type | type() const |
| QString | workingDirectory() const |
Detailed Description
The QWinJumpListItem class represents a jump list item.
Member Type Documentation
enum QWinJumpListItem::Type
This enum describes the available QWinJumpListItem types.
| Constant | Value | Description |
|---|---|---|
QWinJumpListItem::Destination | 0 | Item acts as a link to a file that the application can open. |
QWinJumpListItem::Link | 1 | Item represents a link to an application. |
QWinJumpListItem::Separator | 2 | Item is a separator. Only tasks category supports separators. |
Member Function Documentation
QWinJumpListItem::QWinJumpListItem(Type type)
Constructs a QWinJumpListItem with the specified type.
QWinJumpListItem::~QWinJumpListItem()
Destroys the QWinJumpListItem.
QStringList QWinJumpListItem::arguments() const
Returns the command-line arguments of this item.
See also setArguments().
QString QWinJumpListItem::description() const
Returns the description of this item.
See also setDescription().
QString QWinJumpListItem::filePath() const
Returns the file path set by setFilePath().
See also setFilePath().
QIcon QWinJumpListItem::icon() const
Returns the icon set for this item.
See also setIcon().
void QWinJumpListItem::setArguments(const QStringList &arguments)
Sets command-line arguments for this item.
This value is used only if the type of this item is QWinJumpListItem::Link.
See also arguments() and setFilePath().
void QWinJumpListItem::setDescription(const QString &description)
Sets a description for this item.
This value is used only if the type of this item is QWinJumpListItem::Link.
See also description().
void QWinJumpListItem::setFilePath(const QString &filePath)
Sets the item filePath, the meaning of which depends on the type of this item:
- If the item type is QWinJumpListItem::Destination, filePath is the path to a file that can be opened by an application.
- If the item type is QWinJumpListItem::Link, filePath is the path to an executable that is executed when this item is clicked by the user.
See also filePath(), setWorkingDirectory(), and setArguments().
void QWinJumpListItem::setIcon(const QIcon &icon)
Sets the icon of this item.
This value is used only if the type of this item is QWinJumpListItem::Link.
See also icon().
void QWinJumpListItem::setTitle(const QString &title)
Sets the title of this item.
This value is used only if the type of this item is QWinJumpListItem::Link.
See also title().
void QWinJumpListItem::setType(Type type)
Sets the item type.
See also type().
void QWinJumpListItem::setWorkingDirectory(const QString &workingDirectory)
Sets the path to the working directory of this item to workingDirectory.
This value is used only if the type of this item is QWinJumpListItem::Link.
See also workingDirectory() and setFilePath().
QString QWinJumpListItem::title() const
Returns the title of this item.
See also setTitle().
Type QWinJumpListItem::type() const
Returns the item type.
See also setType().
QString QWinJumpListItem::workingDirectory() const
Returns the working directory path.
See also setWorkingDirectory().