/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2008 by Sun Microsystems, Inc.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * $RCSfile: XMailMergeBroadcaster.idl,v $
 * $Revision: 1.7 $
 *
 * 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 __com_sun_star_text_XMailMergeBroadcaster_idl__
#define __com_sun_star_text_XMailMergeBroadcaster_idl__


#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif
#ifndef __com_sun_star_text_XMailMergeListener_idl__
#include <com/sun/star/text/XMailMergeListener.idl>
#endif

//module com { module sun { module star { module text {
//     published interface XMailMergeListener;
//}; }; }; };

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

module com { module sun { module star { module text {

//=============================================================================
/** allows for adding/removing of mail merge event listeners.

    <p>Registered listeners will be notified with a
    <type scope="com::sun::star::text">MailMergeEvent</type>
    when a document is about to get merged.</p>

    @see    com::sun::star::text::MailMergeEvent
    @see    com::sun::star::text::MailMerge

    @since OOo 1.1.2
*/
published interface XMailMergeBroadcaster : com::sun::star::uno::XInterface
{
    //-------------------------------------------------------------------------
    /** Adds an entry to the list of mail merge listeners.

        @param xListener
        The listener to be added.
    */
    void addMailMergeEventListener(
                [in] com::sun::star::text::XMailMergeListener xListener );

    //-------------------------------------------------------------------------
    /** Removes an entry to the list of mail merge listeners.

        @param xListener
        The listener to be removed.
    */
    void removeMailMergeEventListener(
                [in] com::sun::star::text::XMailMergeListener xListener );
};

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

}; }; }; };

#endif