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