xref: /aoo4110/main/offapi/com/sun/star/document/XImporter.idl (revision b1cdbd2c)

/**************************************************************
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 *
 *************************************************************/


#ifndef __com_sun_star_document_XImporter_idl__
#define __com_sun_star_document_XImporter_idl__

#ifndef __com_sun_star_lang_XComponent_idl__
#include <com/sun/star/lang/XComponent.idl>
#endif

#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
#include <com/sun/star/lang/IllegalArgumentException.idl>
#endif

//=============================================================================

module com { module sun { module star { module document {

//=============================================================================
/** makes it possible to connect a document with an <type>ImportFilter</type>

    <p>
    An <type>ImportFilter</type> must know the target of his filter operation.
    To set this on a filter is part of this interface.
    Same mechanism exist for export too.
    </p>

    @see ExportFilter
    @see ImportFilter
    @see XExporter
 */
published interface XImporter: com::sun::star::uno::XInterface
{
	//-------------------------------------------------------------------------
    /** sets the target document for the importer

        @param Document
            the target document

		@throws com::sun::star::lang::IllegalArgumentException
            if <var>Document</var> does not support any service which is
            supported by this importer
	 */
    void setTargetDocument(
        [in] com::sun::star::lang::XComponent Document )
            raises( com::sun::star::lang::IllegalArgumentException );
};

//=============================================================================

}; }; }; };

#endif