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_XFilter_idl__ 28#define __com_sun_star_document_XFilter_idl__ 29 30#ifndef __com_sun_star_uno_XInterface_idl__ 31#include <com/sun/star/uno/XInterface.idl> 32#endif 33 34#ifndef __com_sun_star_beans_PropertyValue_idl__ 35#include <com/sun/star/beans/PropertyValue.idl> 36#endif 37 38//============================================================================= 39 40module com { module sun { module star { module document { 41 42//============================================================================= 43/** interface to filter documents 44 45 <p> 46 This interface will be used by service <type>ImportFilter</type> or 47 <type>ExportFilter</type> to support loading/saving of documents in 48 different formats. The target/source of such filter operations must 49 be known <em>before</em> filtering will be started. 50 (see <type>XImporter</type> and <type>XExporter</type> too) 51 Otherwise this interface can't work right. 52 <p> 53 54 @see ImportFilter 55 @see ExportFilter 56 @see XImporter 57 @see XExporter 58 */ 59published interface XFilter: com::sun::star::uno::XInterface 60{ 61 //------------------------------------------------------------------------- 62 /** filter the document. 63 64 <p> 65 The given <type>MediaDescriptor</type> holds all neccessary information 66 about the document. 67 68 Don't hold hard references to the descriptor items. You must copy needed information! 69 Otherwise we couldn't destroy (for example) an existing input stream! 70 </p> 71 @param aDescriptor 72 the MediaDescriptor describing the respective document. 73 @return a boolean value indicating whether the filter operation was successful or not. 74 */ 75 boolean filter( [in] sequence< com::sun::star::beans::PropertyValue > aDescriptor ); 76 77 //------------------------------------------------------------------------- 78 /** cancel the process. 79 */ 80 void cancel(); 81 82}; 83 84//============================================================================= 85 86}; }; }; }; 87 88#endif 89