offapi/com/sun/star/document/XExporter.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_document_XExporter_idl__
  20 #define __com_sun_star_document_XExporter_idl__
  21
  22 #include <com/sun/star/lang/XComponent.idl>
  23 #include <com/sun/star/lang/IllegalArgumentException.idl>
  24
  25
  26 module com { module sun { module star { module document {
  27
  28 /** makes it possible to connect a document with an ExportFilter
  29
  30     <p>
  31     An ExportFilter must know the source of his filter operation.
  32     To set this on a filter is part of this interface.
  33     Same mechanism exist for import too.
  34     </p>
  35
  36     @see ExportFilter
  37     @see ImportFilter
  38     @see XImporter
  39  */
  40 published interface XExporter: com::sun::star::uno::XInterface
  41 {
  42     /** sets the source document for the exporter
  43
  44         @param Document
  45             the source document
  46
  47         @throws com::sun::star::lang::IllegalArgumentException
  48             if <var>Document</var> does not support any service which is
  49             supported by this exporter
  50      */
  51     void setSourceDocument(
  52         [in] com::sun::star::lang::XComponent Document )
  53             raises( com::sun::star::lang::IllegalArgumentException );
  54 };
  55
  56
  57 }; }; }; };
  58
  59 #endif
  60
  61
  62 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */