offapi/com/sun/star/document/XExporter.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27 #ifndef __com_sun_star_document_XExporter_idl__
  28 #define __com_sun_star_document_XExporter_idl__
  29
  30 #ifndef __com_sun_star_lang_XComponent_idl__
  31 #include <com/sun/star/lang/XComponent.idl>
  32 #endif
  33
  34 #ifndef __com_sun_star_lang_IllegalArgumentException_idl__
  35 #include <com/sun/star/lang/IllegalArgumentException.idl>
  36 #endif
  37
  38 //=============================================================================
  39
  40 module com { module sun { module star { module document {
  41
  42 //=============================================================================
  43 /** makes it possible to connect a document with an <type>ExportFilter</type>
  44
  45     <p>
  46     An <type>ExportFilter</type> must know the source of his filter operation.
  47     To set this on a filter is part of this interface.
  48     Same mechanism exist for import too.
  49     </p>
  50
  51     @see ExportFilter
  52     @see ImportFilter
  53     @see XImporter
  54  */
  55 published interface XExporter: com::sun::star::uno::XInterface
  56 {
  57     //-------------------------------------------------------------------------
  58     /** sets the source document for the exporter
  59
  60         @param Document
  61             the source document
  62
  63         @throws com::sun::star::lang::IllegalArgumentException
  64             if <var>Document</var> does not support any service which is
  65             supported by this exporter
  66      */
  67     void setSourceDocument(
  68         [in] com::sun::star::lang::XComponent Document )
  69             raises( com::sun::star::lang::IllegalArgumentException );
  70 };
  71
  72 //=============================================================================
  73
  74 }; }; }; };
  75
  76 #endif
  77
  78