/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4; fill-column: 100 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 */

#ifndef __com_sun_star_system_windows_XJumpList_idl__
#define __com_sun_star_system_windows_XJumpList_idl__

#include <com/sun/star/uno/XInterface.idl>
#include <com/sun/star/lang/IllegalArgumentException.idl>
#include <com/sun/star/system/SystemShellExecuteException.idl>


module com { module sun { module star { module system { module windows {

/** Specifies an interface for adding custom jump lists to the task bar (Windows only)

    @since LibreOffice 7.4
*/
interface XJumpList: com::sun::star::uno::XInterface
{
    /** Add a jump list category

        @param category
        Specifies the category name. It will appear as the title of the custom jump list.

        @param jumpListItems
        Specifies a list of com::sun::star::system::JumpListItem.
        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).

        @param application
        Used to map the jump list to the correct application. Use one of the following values:
        <ul>
            <li>Writer</li>
            <li>Calc</li>
            <li>Impress</li>
            <li>Draw</li>
            <li>Math</li>
            <li>Base</li>
            <li>Startcenter</li>
        </ul>

        "Startcenter" will map to the generic "LibreOffice" icon.

        @throws com::sun::star::lang::IllegalArgumentException
        When an empty category name, or an invalid application name is given.
    */
    void appendCategory( [in] string category,
                         [in] sequence<com::sun::star::system::windows::JumpListItem> jumpListItems,
                         [in] string application )
        raises( ::com::sun::star::lang::IllegalArgumentException );

    /** Returns items that were removed from the jump list by the user.

        `appendCategory` will fail if you try to reinsert an item which was removed by the user before.
        Use this method to learn which items were removed by the user.

        @param application
        Used to map the jump list to the correct application. Use one of the following values:
        <ul>
            <li>Writer</li>
            <li>Calc</li>
            <li>Impress</li>
            <li>Draw</li>
            <li>Math</li>
            <li>Base</li>
            <li>Startcenter</li>
        </ul>

        "Startcenter" will map to the generic "LibreOffice" icon.

        @return List of removed items.
    */
    sequence<com::sun::star::system::windows::JumpListItem> getRemovedItems([in] string application);
};


}; }; }; }; };

#endif

/* vim:set shiftwidth=4 softtabstop=4 expandtab cinoptions=b1,g0,N-s cinkeys+=0=break: */