offapi/com/sun/star/document/XExporter.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: XExporter.idl,v $
  10  * $Revision: 1.8 $
  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_document_XExporter_idl__
  31 #define __com_sun_star_document_XExporter_idl__
  32
  33 #ifndef __com_sun_star_lang_XComponent_idl__
  34 #include <com/sun/star/lang/XComponent.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_lang_IllegalArgumentException_idl__
  38 #include <com/sun/star/lang/IllegalArgumentException.idl>
  39 #endif
  40
  41 //=============================================================================
  42
  43 module com { module sun { module star { module document {
  44
  45 //=============================================================================
  46 /** makes it possible to connect a document with an <type>ExportFilter</type>
  47
  48     <p>
  49     An <type>ExportFilter</type> must know the source of his filter operation.
  50     To set this on a filter is part of this interface.
  51     Same mechanism exist for import too.
  52     </p>
  53
  54     @see ExportFilter
  55     @see ImportFilter
  56     @see XImporter
  57  */
  58 published interface XExporter: com::sun::star::uno::XInterface
  59 {
  60     //-------------------------------------------------------------------------
  61     /** sets the source document for the exporter
  62
  63         @param Document
  64             the source document
  65
  66         @throws com::sun::star::lang::IllegalArgumentException
  67             if <var>Document</var> does not support any service which is
  68             supported by this exporter
  69      */
  70     void setSourceDocument(
  71         [in] com::sun::star::lang::XComponent Document )
  72             raises( com::sun::star::lang::IllegalArgumentException );
  73 };
  74
  75 //=============================================================================
  76
  77 }; }; }; };
  78
  79 #endif
  80
  81