/*************************************************************************
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/

#ifndef __offapi_com_sun_star_awt_XItemListListener_idl__
#define __offapi_com_sun_star_awt_XItemListListener_idl__

#include <com/sun/star/lang/XEventListener.idl>
#include <com/sun/star/awt/ItemListEvent.idl>

//==================================================================================================================

module com { module sun { module star { module awt {

//==================================================================================================================

/** describes a listener for changes in a item list
    @see XListItems
 */
interface XItemListListener : ::com::sun::star::lang::XEventListener
{
    /** is called when an item is inserted into the list
    */
    void    listItemInserted(
                [in] ItemListEvent Event
            );

    /** is called when an item is removed from the list
    */
    void    listItemRemoved(
                [in] ItemListEvent Event
            );

    /** is called when an item in the list is modified, i.e. its text or image changed
    */
    void    listItemModified(
                [in] ItemListEvent Event
            );
    /** is called when the list has been completely cleared, i.e. after an invocation of
        <member>XItemList::removeAllItems</member>
    */
    void    allItemsRemoved(
                [in] ::com::sun::star::lang::EventObject Event
            );

    /** is called when the changes to the item list which occurred are too complex to be notified
        in single events.

        <p>Consumers of this event should discard their cached information about the current item list,
        and completely refresh it from the <type>XItemList</type>'s current state.</p>
    */
    void    itemListChanged(
                [in] ::com::sun::star::lang::EventObject Event
            );
};

//==================================================================================================================

}; }; }; };

//==================================================================================================================

#endif
