1d1766043SAndrew Rist/**************************************************************
2cdf0e10cSrcweir *
3d1766043SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one
4d1766043SAndrew Rist * or more contributor license agreements.  See the NOTICE file
5d1766043SAndrew Rist * distributed with this work for additional information
6d1766043SAndrew Rist * regarding copyright ownership.  The ASF licenses this file
7d1766043SAndrew Rist * to you under the Apache License, Version 2.0 (the
8d1766043SAndrew Rist * "License"); you may not use this file except in compliance
9d1766043SAndrew Rist * with the License.  You may obtain a copy of the License at
10d1766043SAndrew Rist *
11d1766043SAndrew Rist *   http://www.apache.org/licenses/LICENSE-2.0
12d1766043SAndrew Rist *
13d1766043SAndrew Rist * Unless required by applicable law or agreed to in writing,
14d1766043SAndrew Rist * software distributed under the License is distributed on an
15d1766043SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16d1766043SAndrew Rist * KIND, either express or implied.  See the License for the
17d1766043SAndrew Rist * specific language governing permissions and limitations
18d1766043SAndrew Rist * under the License.
19d1766043SAndrew Rist *
20d1766043SAndrew Rist *************************************************************/
21d1766043SAndrew Rist
22d1766043SAndrew Rist
23cdf0e10cSrcweir#ifndef __com_sun_star_frame_FrameLoaderFactory_idl__
24cdf0e10cSrcweir#define __com_sun_star_frame_FrameLoaderFactory_idl__
25cdf0e10cSrcweir
26cdf0e10cSrcweir#ifndef __com_sun_star_lang_XMultiServiceFactory_idl__
27cdf0e10cSrcweir#include <com/sun/star/lang/XMultiServiceFactory.idl>
28cdf0e10cSrcweir#endif
29cdf0e10cSrcweir
30cdf0e10cSrcweir#ifndef __com_sun_star_container_XNameAccess_idl__
31cdf0e10cSrcweir#include <com/sun/star/container/XNameAccess.idl>
32cdf0e10cSrcweir#endif
33cdf0e10cSrcweir
34cdf0e10cSrcweir#ifndef __com_sun_star_container_XContainerQuery_idl__
35cdf0e10cSrcweir#include <com/sun/star/container/XContainerQuery.idl>
36cdf0e10cSrcweir#endif
37cdf0e10cSrcweir
38cdf0e10cSrcweir//=============================================================================
39cdf0e10cSrcweir
40cdf0e10cSrcweirmodule com { module sun { module star { module frame {
41cdf0e10cSrcweir
42cdf0e10cSrcweir//=============================================================================
43cdf0e10cSrcweir/** factory to create frame loader
44cdf0e10cSrcweir
45cdf0e10cSrcweir    <p>
46cdf0e10cSrcweir    With this factory it's possible to
47cdf0e10cSrcweir    <ul>
48cdf0e10cSrcweir        <li>have access on configuration of set of registered frame laoder objects</li>
49cdf0e10cSrcweir        <li>create a frame laoder by his internal name</li>
50cdf0e10cSrcweir        <li>query for a frame laoder by using special query or property description.</li>
51cdf0e10cSrcweir    </ul>
52cdf0e10cSrcweir    </p>
53cdf0e10cSrcweir */
54cdf0e10cSrcweirpublished service FrameLoaderFactory
55cdf0e10cSrcweir{
56cdf0e10cSrcweir	//-------------------------------------------------------------------------
57cdf0e10cSrcweir    /** interface to create loader objects by using his internal name
58cdf0e10cSrcweir
59cdf0e10cSrcweir		<p>
60cdf0e10cSrcweir        Returned objects must support the service specification of a <type>FrameLoader</type>
61*a893be29SPedro Giffuni        or <type>SynchronousFrameLoader</type>. (Note: last one will be preferred if both ones
62cdf0e10cSrcweir        are available)
63*a893be29SPedro Giffuni        They can be created by using of his internal name, which must be unambigous every time, only.
64cdf0e10cSrcweir        To get this name use further specified interfaces of this factory for access on
65cdf0e10cSrcweir        the flat configuration.
66cdf0e10cSrcweir        </p>
67cdf0e10cSrcweir	*/
68cdf0e10cSrcweir	interface com::sun::star::lang::XMultiServiceFactory;
69cdf0e10cSrcweir
70cdf0e10cSrcweir	//-------------------------------------------------------------------------
71cdf0e10cSrcweir    /** provides access to the whole frame loader configuration
72cdf0e10cSrcweir
73cdf0e10cSrcweir	<p>This interface supports an access to the internal configuration of all accessible loader objects.
74cdf0e10cSrcweir        The return value of <member scope="com::sun::star::container">XNameAccess::getByName()</member>
75cdf0e10cSrcweir	is a property sequence packed in an any.  </p>
76cdf0e10cSrcweir        <table border=1>
77cdf0e10cSrcweir            <tr>
78cdf0e10cSrcweir                <td><b>Types<b></td>
79cdf0e10cSrcweir                <td>[string]</td>
80cdf0e10cSrcweir                <td>file types which loader is registered for</td>
81cdf0e10cSrcweir            </tr>
82cdf0e10cSrcweir            <tr>
83cdf0e10cSrcweir                <td><b>UIName<b></td>
84cdf0e10cSrcweir                <td>[string]</td>
85cdf0e10cSrcweir                <td>UI representable and localized name</td>
86cdf0e10cSrcweir            </tr>
87cdf0e10cSrcweir        </table>
88cdf0e10cSrcweir    */
89cdf0e10cSrcweir	interface com::sun::star::container::XNameAccess;
90cdf0e10cSrcweir
91cdf0e10cSrcweir	//-------------------------------------------------------------------------
92cdf0e10cSrcweir    /** supports query mode for configuration access
93cdf0e10cSrcweir
94cdf0e10cSrcweir        <p>
95cdf0e10cSrcweir        This interface can be used to get sub sets of current configuration entries
96cdf0e10cSrcweir        which represent given search parameters.
97cdf0e10cSrcweir        </p>
98cdf0e10cSrcweir     */
99cdf0e10cSrcweir    interface com::sun::star::container::XContainerQuery;
100cdf0e10cSrcweir};
101cdf0e10cSrcweir
102cdf0e10cSrcweir//=============================================================================
103cdf0e10cSrcweir
104cdf0e10cSrcweir}; }; }; };
105cdf0e10cSrcweir
106cdf0e10cSrcweir#endif
107