1/************************************************************** 2 * 3 * Licensed to the Apache Software Foundation (ASF) under one 4 * or more contributor license agreements. See the NOTICE file 5 * distributed with this work for additional information 6 * regarding copyright ownership. The ASF licenses this file 7 * to you under the Apache License, Version 2.0 (the 8 * "License"); you may not use this file except in compliance 9 * with the License. You may obtain a copy of the License at 10 * 11 * http://www.apache.org/licenses/LICENSE-2.0 12 * 13 * Unless required by applicable law or agreed to in writing, 14 * software distributed under the License is distributed on an 15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16 * KIND, either express or implied. See the License for the 17 * specific language governing permissions and limitations 18 * under the License. 19 * 20 *************************************************************/ 21 22 23#ifndef __com_sun_star_document_XFilter_idl__ 24#define __com_sun_star_document_XFilter_idl__ 25 26#ifndef __com_sun_star_uno_XInterface_idl__ 27#include <com/sun/star/uno/XInterface.idl> 28#endif 29 30#ifndef __com_sun_star_beans_PropertyValue_idl__ 31#include <com/sun/star/beans/PropertyValue.idl> 32#endif 33 34//============================================================================= 35 36module com { module sun { module star { module document { 37 38//============================================================================= 39/** interface to filter documents 40 41 <p> 42 This interface will be used by service <type>ImportFilter</type> or 43 <type>ExportFilter</type> to support loading/saving of documents in 44 different formats. The target/source of such filter operations must 45 be known <em>before</em> filtering will be started. 46 (see <type>XImporter</type> and <type>XExporter</type> too) 47 Otherwise this interface can't work right. 48 <p> 49 50 @see ImportFilter 51 @see ExportFilter 52 @see XImporter 53 @see XExporter 54 */ 55published interface XFilter: com::sun::star::uno::XInterface 56{ 57 //------------------------------------------------------------------------- 58 /** filter the document. 59 60 <p> 61 The given <type>MediaDescriptor</type> holds all neccessary information 62 about the document. 63 64 Don't hold hard references to the descriptor items. You must copy needed information! 65 Otherwise we couldn't destroy (for example) an existing input stream! 66 </p> 67 @param aDescriptor 68 the MediaDescriptor describing the respective document. 69 @return a boolean value indicating whether the filter operation was successful or not. 70 */ 71 boolean filter( [in] sequence< com::sun::star::beans::PropertyValue > aDescriptor ); 72 73 //------------------------------------------------------------------------- 74 /** cancel the process. 75 */ 76 void cancel(); 77 78}; 79 80//============================================================================= 81 82}; }; }; }; 83 84#endif 85