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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_text_XMailMergeBroadcaster_idl__
  20 #define __com_sun_star_text_XMailMergeBroadcaster_idl__
  21
  22
  23 #include <com/sun/star/uno/XInterface.idl>
  24 #include <com/sun/star/text/XMailMergeListener.idl>
  25
  26 //module com { module sun { module star { module text {
  27 //     published interface XMailMergeListener;
  28 //}; }; }; };
  29
  30
  31 module com { module sun { module star { module text {
  32
  33 /** allows for adding/removing of mail merge event listeners.
  34
  35     <p>Registered listeners will be notified with a
  36     com::sun::star::text::MailMergeEvent
  37     when a document is about to get merged.</p>
  38
  39     @see    com::sun::star::text::MailMergeEvent
  40     @see    com::sun::star::text::MailMerge
  41
  42     @since OOo 1.1.2
  43 */
  44 published interface XMailMergeBroadcaster : com::sun::star::uno::XInterface
  45 {
  46     /** Adds an entry to the list of mail merge listeners.
  47
  48         @param xListener
  49         The listener to be added.
  50     */
  51     void addMailMergeEventListener(
  52                 [in] com::sun::star::text::XMailMergeListener xListener );
  53
  54     /** Removes an entry to the list of mail merge listeners.
  55
  56         @param xListener
  57         The listener to be removed.
  58     */
  59     void removeMailMergeEventListener(
  60                 [in] com::sun::star::text::XMailMergeListener xListener );
  61 };
  62
  63
  64 }; }; }; };
  65
  66 #endif
  67
  68 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */