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
  20
  21 //module com { module sun { module star { module text {
  22 //     published interface XMailMergeListener;
  23 //}; }; }; };
  24
  25
  26 module com { module sun { module star { module text {
  27
  28 /** allows for adding/removing of mail merge event listeners.
  29
  30     <p>Registered listeners will be notified with a
  31     com::sun::star::text::MailMergeEvent
  32     when a document is about to get merged.</p>
  33
  34     @see    com::sun::star::text::MailMergeEvent
  35     @see    com::sun::star::text::MailMerge
  36
  37     @since OOo 1.1.2
  38 */
  39 published interface XMailMergeBroadcaster : com::sun::star::uno::XInterface
  40 {
  41     /** Adds an entry to the list of mail merge listeners.
  42
  43         @param xListener
  44         The listener to be added.
  45     */
  46     void addMailMergeEventListener(
  47                 [in] com::sun::star::text::XMailMergeListener xListener );
  48
  49     /** Removes an entry to the list of mail merge listeners.
  50
  51         @param xListener
  52         The listener to be removed.
  53     */
  54     void removeMailMergeEventListener(
  55                 [in] com::sun::star::text::XMailMergeListener xListener );
  56 };
  57
  58
  59 }; }; }; };
  60
  61 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */