diff options
Diffstat (limited to 'offapi/com/sun/star/document/ExtendedTypeDetection.idl')
-rw-r--r-- | offapi/com/sun/star/document/ExtendedTypeDetection.idl | 91 |
1 files changed, 91 insertions, 0 deletions
diff --git a/offapi/com/sun/star/document/ExtendedTypeDetection.idl b/offapi/com/sun/star/document/ExtendedTypeDetection.idl new file mode 100644 index 0000000000..85af04ff9a --- /dev/null +++ b/offapi/com/sun/star/document/ExtendedTypeDetection.idl @@ -0,0 +1,91 @@ +/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ +/* + * This file is part of the LibreOffice project. + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + * + * This file incorporates work covered by the following license notice: + * + * 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 . + */ + + +module com { module sun { module star { module document { + +/** describes a class of service which will be used for deep TypeDetection + in a generic way + + <p> + Due to the registered types, flat TypeDetection is already possible, i.e. + the assignment of types (e.g. to a URL) only on the basis of configuration data. + If, however, you imagine special cases (e.g. modifying the file extension of a + Writer file from .sdw to .doc), it quickly becomes clear that you cannot always + get a correct result with flat detection. To be certain to get correct results, + you need deep detection, i.e. the file itself has to be examined. + And that is exactly the function of DetectServices. They get all the information + collected so far on a document and then decide which type to assign it to. + In the new modular model, such a detector is meant as UNO service which registers + itself in the office and is requested by the generic type detection if necessary. + <br> + Therefore you need two pieces of information: + <ul> + <li> + The <strong>ServiceName</strong> - This must be a valid UNO service name. + It is also an entry in the corresponding configuration list. + <br> + Example: "com.company.division.DetectService" + <br> + Note that this really means the implementation name of the service. + Because it's not possible otherwise to distinguish between more than one + registered detect services in same office installation! But it's possible for + the generic type detection to create a UNO service by his implementation name too. + </li> + <li> + A list of <strong>Types</strong> able to be recognized by this service - + You can also implement and register detectors for groups of types. + </li> + </ul> + See service TypeDetection and his configuration for further information. + </p> + + @see TypeDetection + */ +published service ExtendedTypeDetection +{ + /** makes the deep detection + + <p> + Generic type detection searches for a registered DetectService for an + already flat detected type. If any could be found it will be created and + used by calling methods of this interface. It gets a MediaDescriptor + which contains information about the document which should be detected and must return + <ul> + <li>an internal type name for detected format</li> + <li>or `NULL` if format is unknown nor supported.</li> + </ul> + May be that given descriptor already includes the opened document stream as parameter + MediaDescriptor::InputStream. Then this one should be used every time. + If it's not included in descriptor the value of MediaDescriptor::URL + must be used to open requested resource by this service. + <br> + Note: The stream should be added to the descriptor if it wasn't a part of them before. + So further steps on the whole detection process can use it and will perform her work. + It's further not allowed to hold a reference to this stream any longer. Only copies + will be valid then. Otherwise nobody can close this stream then. + </p> + */ + interface XExtendedFilterDetection; +}; + + +}; }; }; }; + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ |