xref: /aoo4110/main/offapi/com/sun/star/text/XMailMergeBroadcaster.idl (revision b1cdbd2c)

/**************************************************************
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the 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 OpenOffice 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