summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/frame/FrameLoaderFactory.idl
blob: 7748c4c92c22b51fe64b9747d84451e7740f3913 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
/*************************************************************************
 *
 *  $RCSfile: FrameLoaderFactory.idl,v $
 *
 *  $Revision: 1.2 $
 *
 *  last change: $Author: mi $ $Date: 2001-11-01 10:29:29 $
 *
 *  The Contents of this file are made available subject to the terms of
 *  either of the following licenses
 *
 *         - GNU Lesser General Public License Version 2.1
 *         - Sun Industry Standards Source License Version 1.1
 *
 *  Sun Microsystems Inc., October, 2000
 *
 *  GNU Lesser General Public License Version 2.1
 *  =============================================
 *  Copyright 2000 by Sun Microsystems, Inc.
 *  901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License version 2.1, as published by the Free Software Foundation.
 *
 *  This library 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 for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *  MA  02111-1307  USA
 *
 *
 *  Sun Industry Standards Source License Version 1.1
 *  =================================================
 *  The contents of this file are subject to the Sun Industry Standards
 *  Source License Version 1.1 (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.openoffice.org/license.html.
 *
 *  Software provided under this License is provided on an "AS IS" basis,
 *  WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
 *  WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
 *  MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
 *  See the License for the specific provisions governing your rights and
 *  obligations concerning the Software.
 *
 *  The Initial Developer of the Original Code is: Sun Microsystems, Inc.
 *
 *  Copyright: 2000 by Sun Microsystems, Inc.
 *
 *  All Rights Reserved.
 *
 *  Contributor(s): _______________________________________
 *
 *
 ************************************************************************/
#ifndef __com_sun_star_frame_FrameLoaderFactory_idl__
#define __com_sun_star_frame_FrameLoaderFactory_idl__

#ifndef __com_sun_star_lang_XMultiServiceFactory_idl__
#include <com/sun/star/lang/XMultiServiceFactory.idl>
#endif

#ifndef __com_sun_star_container_XNameAccess_idl__
#include <com/sun/star/container/XNameAccess.idl>
#endif

//=============================================================================

module com { module sun { module star { module frame {

//=============================================================================

/** factory to create frame loader
 */
service FrameLoaderFactory
{
    //-------------------------------------------------------------------------
    /**interface to create the loader
        <p>
        After a <type>TypeDetection</type> you can use these interfaces to create the right loader to 
        load the document into a frame. Give it an internal type name and it creates a suitable 
        <type>XSynchronousFrameLoader</type> 	or <type>XFrameLoader</type> and returns it by calling 	
        XMultiServiceFactory::createInstance...()
         - casted to XInterface! Please check returned object for his supported interface!

        @attention	Method XMultiServiceFactory::getAvailableServiceNames() isn't supported!
        Please use XNameAcces of these service for access on loader configuration.
        </p>
    */
    interface com::sun::star::lang::XMultiServiceFactory;

    //-------------------------------------------------------------------------
    /**readonly access to loader configuration

        <p>
        These interface support a readonly access to our internal configuration of all accessible loader.
        The return value of XNameAccess::getByName() is a sequence<PropertyValue> packed in an Any!</p>
<pre>
Supported properties are:
<property name    value type of property     description/>
"Types"        	[sequence< string > ]      loader is registered for these types
"UIName"        [string            ]      localized name of loader to show it at UI
</pre> 	*/
    interface com::sun::star::container::XNameAccess;
};

//=============================================================================

}; }; }; };

#endif