/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2000, 2010 Oracle and/or its affiliates.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
*
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 behavior
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 it's internal filter name directly can be
reached by using createInstanceWithArguments() with an optional property "FilterName" only.
See the following example:
Proposed behavior
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 proposed implementation will throw an
Initialization of a filter component
Every filter, which was created by this factory can(!) be initialized 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 really means 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 addressed by his internal name,
and it must be an unambiguous 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 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.
*/ [optional] interface com::sun::star::util::XFlushable; }; //============================================================================= }; }; }; }; #endif /* vim:set shiftwidth=4 softtabstop=4 expandtab: */