/**************************************************************
*
* 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
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*
*************************************************************/
#ifndef __com_sun_star_document_FilterFactory_idl__
#define __com_sun_star_document_FilterFactory_idl__
#ifndef __com_sun_star_lang_XMultiServiceFactory_idl__
#include
After a generic
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.
Current behaviour
The methods createInstance() or createInstanceWithArguments() of this interface must be
called with an internal type name!. This name is used internaly 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 it's internal filter name directly can be
reached by using createInstanceWithArguments() with an optional property "FilterName" only.
See the following example:
Proposed behaviour
Searching of a suitable filter for a given internal type name, must be done by the new interface
How it can be distinguished?
The new prosposed implementation will throw an
Initialization of a filter component
Every filter, which was created by this factory can(!) be intialized with it's own configuration data
and may given optional arguments of the corresponding createInstanceWithArguments() request. To do so the filter
instance must support the optional interface
Every container item is specified as a set of properties and will be
represented by a sequence<
Property Name | Value Type | Description |
Name | [string] | The internal name is the only value, which makes a container item unique. |
UIName | [string] | It contains the localized name for this filter for the current locale. |
UINames | [sequence< string >] | It contains all available localized names for this filter. The are organized
in pairs and represented as a structure of sequence< |
Type | [string] | Every filter is registered for a type. This value contains the internal name of it.
(see service |
DocumentService | [string] | It's the uno service name of the document type, which can be handled by this filter.
(e.g. |
FilterService | [string] | It means the uno implementation name of the filter component. Note: It means the realy the implementation instead of the uno service name. Because it's not possible to distinguish between more then one filters; if all of them uses a generic identifier! |
Flags | [integer] | They describe the filter more specific. (e.g. they mark it as IMPORT/EXPORT or DEFAULT filter.) |
UserData | [string] | This field contains filter specific configuration data. |
FileFormatVersion | [integer] | It specifies the supported file format version if there exist more then ones. |
TemplateName | [string] | It's the name of a suitable default template. |
Note:
All elements of this container will be adressed by his internal name,
and it must be an unambigous value.
Against simple property search it provides some complex algorithms too. For further informations please read the SDK documentation.
*/ interface com::sun::star::container::XContainerQuery; //------------------------------------------------------------------------- /** can be used to perform container changes.Because the complexness of such configuration set can be very high, it seams not very usefull to update the undelying configuration layer on every container change request immediatly. 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 possibelity, that interested changes listener can be registered too.
*/ [optional] interface com::sun::star::util::XFlushable; }; //============================================================================= }; }; }; }; #endif