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_XExtendedFilterDetection_idl__
24#define __com_sun_star_document_XExtendedFilterDetection_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/** provides a "deep" filter detection
40
41    <p>
42    A "deep" filter detection means looking into the document stream to detect
43    the format of it. Services of type <type>ExtendedTypeDetection</type> must support this
44    interface to be called from generic load mechanism of the office for that.
45    </p>
46
47    @see DetectService
48    @see TypeDetection
49    @see FilterFactory
50 */
51published interface XExtendedFilterDetection: com::sun::star::uno::XInterface
52{
53	//-------------------------------------------------------------------------
54    /** controls agreement of a "flat" <type>TypeDetection</type>
55        with given URL or arguments
56
57		<p>
58        Registerd services in configuration, which support this interface for different mime types,
59        will be called automaticly to look into the document stream and cdecide wich format it represent.
60        Add the collected information about detected documents in given <type>MediaDescriptor</type>
61        <var>Descriptor</var>. The decision must be returned as any valid type name (which specifies
62        the detected format) or an empty value for unknown formats.
63		</p>
64
65        @param Descriptor
66            represent a <type>MediaDescriptor</type> which can be used to get/set informations
67            about the detected document
68
69        @returns
70            an internal type name if format was detected successfully
71            <br>
72            or an empty value for an unknown document format.
73	 */
74    string detect( [inout] sequence< com::sun::star::beans::PropertyValue > Descriptor );
75
76}; }; }; }; };
77
78#endif
79