1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_text_XMailMergeBroadcaster_idl__
24#define __com_sun_star_text_XMailMergeBroadcaster_idl__
25
26
27#ifndef __com_sun_star_uno_XInterface_idl__
28#include <com/sun/star/uno/XInterface.idl>
29#endif
30#ifndef __com_sun_star_text_XMailMergeListener_idl__
31#include <com/sun/star/text/XMailMergeListener.idl>
32#endif
33
34//module com { module sun { module star { module text {
35//     published interface XMailMergeListener;
36//}; }; }; };
37
38//=============================================================================
39
40module com { module sun { module star { module text {
41
42//=============================================================================
43/** allows for adding/removing of mail merge event listeners.
44
45    <p>Registered listeners will be notified with a
46    <type scope="com::sun::star::text">MailMergeEvent</type>
47    when a document is about to get merged.</p>
48
49    @see    com::sun::star::text::MailMergeEvent
50    @see    com::sun::star::text::MailMerge
51
52    @since OpenOffice 1.1.2
53*/
54published interface XMailMergeBroadcaster : com::sun::star::uno::XInterface
55{
56    //-------------------------------------------------------------------------
57    /** Adds an entry to the list of mail merge listeners.
58
59        @param xListener
60        The listener to be added.
61    */
62    void addMailMergeEventListener(
63                [in] com::sun::star::text::XMailMergeListener xListener );
64
65    //-------------------------------------------------------------------------
66    /** Removes an entry to the list of mail merge listeners.
67
68        @param xListener
69        The listener to be removed.
70    */
71    void removeMailMergeEventListener(
72                [in] com::sun::star::text::XMailMergeListener xListener );
73};
74
75//=============================================================================
76
77}; }; }; };
78
79#endif
80