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_XInteractionFilterSelect_idl__ 24#define __com_sun_star_document_XInteractionFilterSelect_idl__ 25 26#ifndef __com_sun_star_task_XInteractionContinuation_idl__ 27#include <com/sun/star/task/XInteractionContinuation.idl> 28#endif 29 30//============================================================================= 31 32module com { module sun { module star { module document { 33 34//============================================================================= 35/** continuation used by interaction mechanism at filter detection during 36 loading documents 37 38 <p> 39 If during loading time the filter can't be detected and wasn't given at calling time, 40 a possible <type scope="com::sun::star::task">InteractionHandler</type> will be used. 41 (it's a a part of used <type>MediaDescriptor</type>) 42 A <type>NoSuchFilterRequest</type> will be used then to start right interaction on that to 43 get a decision wich filter should be used for given URL. A possible continiuation 44 of that can be this XInteractionFilterSelect. It will transport the decision back to 45 generic filter detection and force using of it. Of course it's possible to abort 46 the loading process by use another continuation <type scope="com::sun::star::task">XInteractionAbort</type>. 47 </p> 48 49 @see MediaDescriptor 50 @see com::sun::star::task::InteractionHandler 51 @see NoSuchFilterRequest 52 @see com::sun::star::task::XInteractionAbort 53 */ 54published interface XInteractionFilterSelect : com::sun::star::task::XInteractionContinuation 55{ 56 //------------------------------------------------------------------------- 57 /** used by interaction to set selected filter 58 59 <p> 60 This value must be save till another one will be set 61 and must be provided on getFilter() for interest users. 62 </p> 63 */ 64 void setFilter( [in] string Name ); 65 66 //------------------------------------------------------------------------- 67 /** used by detection to get selected filter 68 */ 69 string getFilter(); 70}; 71 72//============================================================================= 73 74}; }; }; }; 75 76#endif 77