offapi/com/sun/star/text/MailMergeEvent.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: MailMergeEvent.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_MailMergeEvent_idl__
  31 #define __com_sun_star_text_MailMergeEvent_idl__
  32
  33
  34
  35 #ifndef __com_sun_star_lang_EventObject_idl__
  36 #include <com/sun/star/lang/EventObject.idl>
  37 #endif
  38 #ifndef __com_sun_star_frame_XModel_idl__
  39 #include <com/sun/star/frame/XModel.idl>
  40 #endif
  41
  42 //=============================================================================
  43
  44 module com { module sun { module star { module text {
  45
  46 //=============================================================================
  47 /** represents a mail merge event.
  48
  49     <p>This type of event is being send by the mail merge service
  50     right before the merging of the next document to be processed.
  51     This allows for example to modify the document specifically
  52     before it gets merged.</p>
  53
  54     @see    com::sun::star::text::MailMerge
  55
  56     @since OOo 1.1.2
  57 */
  58 published struct MailMergeEvent : com::sun::star::lang::EventObject
  59 {
  60     //-------------------------------------------------------------------------
  61     /** The model of the document to be processed next.
  62     */
  63     com::sun::star::frame::XModel Model;
  64 };
  65
  66 //=============================================================================
  67
  68 }; }; }; };
  69
  70 #endif