Version 5.2.6.1, tag libreoffice-5.2.6.1
[LibreOffice.git] / offapi / com / sun / star / document / XImporter.idl
blob3325bb789c16f6470402f0484dfbf1920af913d8
1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2 /*
3 * This file is part of the LibreOffice project.
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/.
9 * This file incorporates work covered by the following license notice:
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 .
19 #ifndef __com_sun_star_document_XImporter_idl__
20 #define __com_sun_star_document_XImporter_idl__
22 #include <com/sun/star/lang/XComponent.idl>
23 #include <com/sun/star/lang/IllegalArgumentException.idl>
26 module com { module sun { module star { module document {
28 /** makes it possible to connect a document with an ImportFilter
30 <p>
31 An ImportFilter must know the target of his filter operation.
32 To set this on a filter is part of this interface.
33 Same mechanism exist for export too.
34 </p>
36 @see ExportFilter
37 @see ImportFilter
38 @see XExporter
40 published interface XImporter: com::sun::star::uno::XInterface
42 /** sets the target document for the importer
44 @param Document
45 the target document
47 @throws com::sun::star::lang::IllegalArgumentException
48 if <var>Document</var> does not support any service which is
49 supported by this importer
51 void setTargetDocument(
52 [in] com::sun::star::lang::XComponent Document )
53 raises( com::sun::star::lang::IllegalArgumentException );
57 }; }; }; };
59 #endif
62 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */