1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27#ifndef __com_sun_star_frame_FrameLoaderFactory_idl__
28#define __com_sun_star_frame_FrameLoaderFactory_idl__
29
30#ifndef __com_sun_star_lang_XMultiServiceFactory_idl__
31#include <com/sun/star/lang/XMultiServiceFactory.idl>
32#endif
33
34#ifndef __com_sun_star_container_XNameAccess_idl__
35#include <com/sun/star/container/XNameAccess.idl>
36#endif
37
38#ifndef __com_sun_star_container_XContainerQuery_idl__
39#include <com/sun/star/container/XContainerQuery.idl>
40#endif
41
42//=============================================================================
43
44module com { module sun { module star { module frame {
45
46//=============================================================================
47/** factory to create frame loader
48
49    <p>
50    With this factory it's possible to
51    <ul>
52        <li>have access on configuration of set of registered frame laoder objects</li>
53        <li>create a frame laoder by his internal name</li>
54        <li>query for a frame laoder by using special query or property description.</li>
55    </ul>
56    </p>
57 */
58published service FrameLoaderFactory
59{
60	//-------------------------------------------------------------------------
61    /** interface to create loader objects by using his internal name
62
63		<p>
64        Returned objects must support the service specification of a <type>FrameLoader</type>
65        or <type>SynchronousFrameLoader</type>. (Note: last one will be prefered if both ones
66        are available)
67        They can be created by using of his internal name, which must be unambigous everytime, only.
68        To get this name use further specified interfaces of this factory for access on
69        the flat configuration.
70        </p>
71	*/
72	interface com::sun::star::lang::XMultiServiceFactory;
73
74	//-------------------------------------------------------------------------
75    /** provides access to the whole frame loader configuration
76
77	<p>This interface supports an access to the internal configuration of all accessible loader objects.
78        The return value of <member scope="com::sun::star::container">XNameAccess::getByName()</member>
79	is a property sequence packed in an any.  </p>
80        <table border=1>
81            <tr>
82                <td><b>Types<b></td>
83                <td>[string]</td>
84                <td>file types which loader is registered for</td>
85            </tr>
86            <tr>
87                <td><b>UIName<b></td>
88                <td>[string]</td>
89                <td>UI representable and localized name</td>
90            </tr>
91        </table>
92    */
93	interface com::sun::star::container::XNameAccess;
94
95	//-------------------------------------------------------------------------
96    /** supports query mode for configuration access
97
98        <p>
99        This interface can be used to get sub sets of current configuration entries
100        which represent given search parameters.
101        </p>
102     */
103    interface com::sun::star::container::XContainerQuery;
104};
105
106//=============================================================================
107
108}; }; }; };
109
110#endif
111