Specifies an interface for adding custom jump lists to the task bar (Windows only)
More...
import <XJumpList.idl;
Specifies an interface for adding custom jump lists to the task bar (Windows only)
To add a new jump list, call
- XJumpList::beginList
- XJumpList::appendCategory / XJumpList::addTasks / XJumpList::showRecentFiles / XJumpList::showFrequentFiles
- XJumpList::commitList
Use XJumpList::abortList to cancel a current list building session. Use XJumpList::getRemovedItems to see which items were removed by the user.
- Since
- LibreOffice 7.4
◆ abortList()
Aborts a list building session started with beginList.
- Exceptions
-
◆ addTasks()
Add items to the "Tasks" category.
This category is system-defined and the category title cannot be changed. Also the user cannot remove or pin items from this category (as he can with items added via XJumpList::appendCategory ).
- Parameters
-
jumpListItems | Specifies a list of com::sun::star::system::JumpListItem. Must contain at least one item. These will be added as entries below the "Tasks" system category. |
- Exceptions
-
◆ appendCategory()
Add a jump list category.
Users can pin or remove items added via this method. Use XJumpList::getRemovedItems to see which items were removed by the user.
- Parameters
-
category | Specifies the category name. It will appear as the title of the custom jump list. Must not include embedded NULs ('\0') |
jumpListItems | Specifies a list of com::sun::star::system::JumpListItem. Must contain at least one item. These will be added as entries below the category name in the custom jump list. |
Make sure you don't add items which the user has removed before (check the result of getRemovedItems
before updating a category). If you try to add items which the user removed before, they will be silently ignored and not added to the list.
- Exceptions
-
◆ beginList()
Start a new jump list.
- Parameters
-
application | Used to map the jump list to the correct application. Use one of the following values:
-
Writer
-
Calc
-
Impress
-
Draw
-
Math
-
Base
-
Startcenter
|
"Startcenter" will map to the generic "LibreOffice" icon.
- Exceptions
-
◆ commitList()
Commits the list.
- Exceptions
-
◆ deleteList()
Deletes the Jump List for a certain application.
- Parameters
-
application | Used to map the jump list to the correct application. Use one of the following values:
-
Writer
-
Calc
-
Impress
-
Draw
-
Math
-
Base
-
Startcenter
|
"Startcenter" will map to the generic "LibreOffice" icon.
- Exceptions
-
◆ getRemovedItems()
Returns items that were removed from the jump list by the user.
appendCategory
will ignore items which were removed by the user before. Use this method to learn which items were removed by the user.
- Parameters
-
application | Used to map the jump list to the correct application. Use one of the following values:
-
Writer
-
Calc
-
Impress
-
Draw
-
Math
-
Base
-
Startcenter
|
"Startcenter" will map to the generic "LibreOffice" icon.
- Returns
- List of removed items.
◆ showFrequentFiles()
Display the frequently used files (populated by LibreOffice)
- Exceptions
-
◆ showRecentFiles()
Display the recently used files (populated by LibreOffice)
- Exceptions
-
The documentation for this interface was generated from the following file: