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_frame_ContentHandlerFactory_idl__
24#define __com_sun_star_frame_ContentHandlerFactory_idl__
25
26#ifndef __com_sun_star_lang_XMultiServiceFactory_idl__
27#include <com/sun/star/lang/XMultiServiceFactory.idl>
28#endif
29
30#ifndef __com_sun_star_container_XNameAccess_idl__
31#include <com/sun/star/container/XNameAccess.idl>
32#endif
33
34#ifndef __com_sun_star_container_XContainerQuery_idl__
35#include <com/sun/star/container/XContainerQuery.idl>
36#endif
37
38//=============================================================================
39
40module com { module sun { module star { module frame {
41
42//=============================================================================
43/** factory to create content loader
44
45    <p>
46    With this factory it's possible to
47    <ul>
48        <li>have access on configuration of set of registered content handler objects</li>
49        <li>create a content handler by his internal name</li>
50        <li>query for a content handler by using special query or property description.</li>
51    </ul>
52    </p>
53 */
54published service ContentHandlerFactory
55{
56	//-------------------------------------------------------------------------
57    /** interface to create handler objects by using his internal name
58
59		<p>
60        Returned objects must support the service specification of a <type>ContentHandler</type>.
61        They can be created by using of his internal name, which must be unambigous everytime, only.
62        To get this name use further specified interfaces of this factory for access on
63        the flat configuration.
64        </p>
65	*/
66	interface com::sun::star::lang::XMultiServiceFactory;
67
68	//-------------------------------------------------------------------------
69    /** provides access to the whole content handler configuration
70
71		<p>
72        This interface supports an access to the internal configuration
73        of all accessible handler objects. The return value of
74        <member scope="com::sun::star::container">XNameAccess::getByName()</member> is a property sequence
75        packed in an any.
76        </p>
77        <table border=1>
78            <tr>
79                <td><b>Types<b></td>
80                <td>[string]</td>
81                <td>file types for which handler is registered</td>
82            </tr>
83            <tr>
84                <td><b>UIName<b></td>
85                <td>[string]</td>
86                <td>UI representable and localized name</td>
87            </tr>
88        </table>
89    */
90	interface com::sun::star::container::XNameAccess;
91
92	//-------------------------------------------------------------------------
93    /** supports query mode for configuration access
94
95        <p>
96        This interface can be used to get sub sets of current configuration entries
97        which represent given search parameters.
98        </p>
99     */
100    interface com::sun::star::container::XContainerQuery;
101};
102
103//=============================================================================
104
105}; }; }; };
106
107#endif
108