merged tag ooo/OOO330_m14
[LibreOffice.git] / offapi / com / sun / star / text / XMailMergeBroadcaster.idl
bloba4a0d0aa119261ce5ca5850b79a23e3c4b59a70f
1 /*************************************************************************
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
7 * OpenOffice.org - a multi-platform office productivity suite
9 * This file is part of OpenOffice.org.
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org. If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
26 ************************************************************************/
27 #ifndef __com_sun_star_text_XMailMergeBroadcaster_idl__
28 #define __com_sun_star_text_XMailMergeBroadcaster_idl__
31 #ifndef __com_sun_star_uno_XInterface_idl__
32 #include <com/sun/star/uno/XInterface.idl>
33 #endif
34 #ifndef __com_sun_star_text_XMailMergeListener_idl__
35 #include <com/sun/star/text/XMailMergeListener.idl>
36 #endif
38 //module com { module sun { module star { module text {
39 // published interface XMailMergeListener;
40 //}; }; }; };
42 //=============================================================================
44 module com { module sun { module star { module text {
46 //=============================================================================
47 /** allows for adding/removing of mail merge event listeners.
49 <p>Registered listeners will be notified with a
50 <type scope="com::sun::star::text">MailMergeEvent</type>
51 when a document is about to get merged.</p>
53 @see com::sun::star::text::MailMergeEvent
54 @see com::sun::star::text::MailMerge
56 @since OOo 1.1.2
58 published interface XMailMergeBroadcaster : com::sun::star::uno::XInterface
60 //-------------------------------------------------------------------------
61 /** Adds an entry to the list of mail merge listeners.
63 @param xListener
64 The listener to be added.
66 void addMailMergeEventListener(
67 [in] com::sun::star::text::XMailMergeListener xListener );
69 //-------------------------------------------------------------------------
70 /** Removes an entry to the list of mail merge listeners.
72 @param xListener
73 The listener to be removed.
75 void removeMailMergeEventListener(
76 [in] com::sun::star::text::XMailMergeListener xListener );
79 //=============================================================================
81 }; }; }; };
83 #endif