diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-07 09:06:44 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-07 09:06:44 +0000 |
commit | ed5640d8b587fbcfed7dd7967f3de04b37a76f26 (patch) | |
tree | 7a5f7c6c9d02226d7471cb3cc8fbbf631b415303 /offapi/com/sun/star/document/FilterFactory.idl | |
parent | Initial commit. (diff) | |
download | libreoffice-ed5640d8b587fbcfed7dd7967f3de04b37a76f26.tar.xz libreoffice-ed5640d8b587fbcfed7dd7967f3de04b37a76f26.zip |
Adding upstream version 4:7.4.7.upstream/4%7.4.7upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'offapi/com/sun/star/document/FilterFactory.idl')
-rw-r--r-- | offapi/com/sun/star/document/FilterFactory.idl | 226 |
1 files changed, 226 insertions, 0 deletions
diff --git a/offapi/com/sun/star/document/FilterFactory.idl b/offapi/com/sun/star/document/FilterFactory.idl new file mode 100644 index 000000000..acb0280e2 --- /dev/null +++ b/offapi/com/sun/star/document/FilterFactory.idl @@ -0,0 +1,226 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_document_FilterFactory_idl__ +#define __com_sun_star_document_FilterFactory_idl__ + +#include <com/sun/star/lang/XMultiServiceFactory.idl> +#include <com/sun/star/container/XNameContainer.idl> +#include <com/sun/star/container/XContainerQuery.idl> +#include <com/sun/star/util/XFlushable.idl> + + +module com { module sun { module star { module document { + +/** factory to create filter components. + + <p> + After a generic TypeDetection an internal type name + will be known. Further a generic com::sun::star::frame::FrameLoader + can use this information, to search a suitable filter (may the default filter) at + this factory and use it for loading the document into a specified frame. + </p> + + <p> + This factory implements read/write access on the underlying configuration set. + and further a validate and flush mechanism for more performance and a special query mode + can be used here too. + </p> + */ +published service FilterFactory +{ + /** factory interface to create and initialize filter components. + + <p> + <strong>Current behavior</strong><p> + The methods createInstance() or createInstanceWithArguments() of this interface must be + called with an internal type name!. This name is used internally to search a suitable + (mostly the default) filter for this type then. The found filter will be created, initialized + and returned then. Creation of a filter by using its internal filter name directly can be + reached by using createInstanceWithArguments() with an optional property "FilterName" only. + See the following example: + + @code{.java} + private com.sun.star.uno.XInterface createFilterDirect( com.sun.star.lang.XMultiServiceFactory xFilterFactory , + java.lang.String sInternalFilterName ) + { + com.sun.star.beans.PropertyValue aFilterProp = new com.sun.star.beans.PropertyValue(); + aFilterProp.Name = "FilterName"; + aFilterProp.Value = sInternalFilterName; + + com.sun.star.uno.Any[] lProps = new com.sun.star.uno.Any[1]; + lProps[0] = aFilterProp; + + java.lang.Object aFilter = xFilterFactory.createInstanceWithArguments("", lProps); + return (com.sun.star.uno.XInterface)UnoRuntime.queryInterface(com.sun.star.uno.XInterface.class, aFilter); + } + @endcode + </p> + + <p> + <strong>Proposed behavior</strong><p> + Searching of a suitable filter for a given internal type name, must be done by the new interface + com::sun::star::container::XContainerQuery, available on this factory too. + The factory interface can be used to create filter components by its internal filter name only. + </p> + + <p> + <strong>How it can be distinguished?</strong><p> + The new proposed implementation will throw a com::sun::star::container::NoSuchElementException + if the first parameter of createInstance() or createInstanceWithArguments() does not match to a valid container (means + filter) item. Further it will throw a com::sun::star::lang::IllegalArgumentException if the optional + parameter "FilterName" could not be detected inside the argument list of call createInstanceWithArguments(). + </p> + + <p> + <strong>Initialization of a filter component</strong><p> + Every filter, which was created by this factory can(!) be initialized with its own configuration data + and may given optional arguments of the corresponding createInstanceWithArguments() request. To do so the filter + instance must support the optional interface com::sun::star::lang::XInitialization. + The arguments parameter will have the following structure: + <ul> + <li>sequence< Any >[0] contains a sequence< com::sun::star::beans::PropertyValue >, + which represent the configuration data set of this filter. The used properties are the same, as + they are available at the container interface of this factory service. (see below)</li> + <li>Every following item of the argument list sequence< Any >[1..n] contains the copied argument of the + corresponding createInstanceWithArguments() call. That means: Item 0 or the original list was copied as + item 1 of the destination list ... etc. + </ul> + </p> + */ + interface com::sun::star::lang::XMultiServiceFactory; + + /** provides read access to the complete set of configuration data. + + <p> + Every container item is specified as a set of properties and will be + represented by a sequence< com::sun::star::beans::PropertyValue > structure. + Follow properties are supported: + (But note: not all of them must be present every time!) + </p> + <table border=1> + <tr> + <td><strong>Property Name</strong></td> + <td><strong>Value Type</strong></td> + <td><strong>Description</strong></td> + </tr> + <tr> + <td><em>Name</em></td> + <td>[string]</td> + <td>The internal name is the only value, which makes a container item unique.</td> + </tr> + <tr> + <td><em>UIName</em></td> + <td>[string]</td> + <td>It contains the localized name for this filter for the current locale.</td> + </tr> + <tr> + <td><em>UINames</em></td> + <td>[sequence< string >]</td> + <td>It contains all available localized names for this filter. The are organized + in pairs and represented as a structure of sequence< com::sun::star::beans::PropertyValue >. + The name of such property must be interpreted as locale; its value as the localized + filter name corresponding to this locale.</td> + </tr> + <tr> + <td><em>Type</em></td> + <td>[string]</td> + <td>Every filter is registered for a type. This value contains the internal name of it. + (see service TypeDetection for further information)</td> + </tr> + <tr> + <td><em>DocumentService</em></td> + <td>[string]</td> + <td>It's the UNO service name of the document type, which can be handled by this filter. + (e.g. com::sun::star::text::TextDocument)</td> + </tr> + <tr> + <td><em>FilterService</em></td> + <td>[string]</td> + <td>It means the UNO implementation name of the filter component. + Note: It really means the implementation instead of the UNO service name. + Because it's not possible to distinguish between more than one filters; if all of them + uses a generic identifier!</td> + </tr> + <tr> + <td><em>Flags</em></td> + <td>[integer]</td> + <td>They describe the filter more specific.<br> + (e.g. they mark it as IMPORT/EXPORT or DEFAULT filter.)</td> + </tr> + <tr> + <td><em>UserData</em></td> + <td>[string]</td> + <td>This field contains filter specific configuration data.</td> + </tr> + <tr> + <td><em>FileFormatVersion</em></td> + <td>[integer]</td> + <td>It specifies the supported file format version if there exist more than ones.</td> + </tr> + <tr> + <td><em>TemplateName</em></td> + <td>[string]</td> + <td>It's the name of a suitable default template.</td> + </tr> + </table> + </p> + + <p> + Note:<br> + All elements of this container will be addressed by his internal name, + and it must be an unambiguous value. + </p> + */ + interface com::sun::star::container::XNameAccess; + + /** provides a write access to the configuration data. + */ + [optional] interface com::sun::star::container::XNameContainer; + + /** provides search on the configuration data set. + + <p> + Against simple property search it provides some complex algorithms too. + For further information please read the SDK documentation. + </p> + */ + interface com::sun::star::container::XContainerQuery; + + /** can be used to perform container changes. + + <p> + Because the complexness of such configuration set can be very high, + it seems not very useful to update the underlying configuration layer + on every container change request immediately. Another strategy can be to + make all changes (adding/changing/removing of items) and call flush at the end. + That will validate the whole container and reject inconsistent data sets. + Only in case all made changes was correct, they will be written back to the + configuration. Further this interface provides the possibility, that interested + changes listener can be registered too. + </p> + */ + [optional] interface com::sun::star::util::XFlushable; +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ |