offapi/com/sun/star/text/XMailMergeBroadcaster.idl

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