summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/sdb/ContentLoader.idl
blob: 70a5cff2038c7c9c76ef27601d225bdceb6e8ac9 (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
/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 * 
 * Copyright 2008 by Sun Microsystems, Inc.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * $RCSfile: ContentLoader.idl,v $
 * $Revision: 1.9 $
 *
 * 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
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/


#ifndef __com_sun_star_sdb_ContentLoader_idl__ 
#define __com_sun_star_sdb_ContentLoader_idl__ 

#ifndef __com_sun_star_frame_Frame_idl__ 
#include <com/sun/star/frame/FrameLoader.idl>
#endif

module com {  module sun {  module star {  module sdb { 

//============================================================================= 
/** implements a loader for various datasource-related user interface components.

    <p>Usually, you don't deal with this loader directly. Instead, use an instance with
    the <type scope="com::sun::star::frame">XComponentLoader</type> interface, and pass
    one of the below-mentioned URLs to it.</p>

    @see com::sun::star::frame::XComponentLoader
    @see com::sun::star::frame::Desktop
*/
published service ContentLoader
{
    /** ensures the basic functionality.

        <p>
        Supporting this service ensures that you can plug any of the components
        the loader can create into an arbitrary frame.
        </p>

        The loader should be registered for the URL scheme 
        <b>
        .component:DB/ *
        </b>
        , the concrete URLs supported are:
        <ul>
            <li><b>.component:DB/DataSourceBrowser</b><br/>
                Using this URL creates an instance of the 
                <type scope="com::sun::star::sdb">DataSourceBrowser</type>
                service and plugs it into the frame passed to the loader.
            </li>
            <li><b>.component:DB/FormGridView</b><br/>
                Using this URL creates an instance of the 
                <type scope="com::sun::star::sdb">ExternalSourceBrowser</type>
                service and plugs it into the frame passed to the loader.
            </li>
            <li><b>.component:DB/QueryDesign</b><br/>
                Using this URL creates an instance of the 
                <type scope="com::sun::star::sdb">QueryDesign</type>
                service and plugs it into the frame passed to the loader.
            </li>
            <li><b>.component:DB/TableDesign</b><br/>
                Using this URL creates an instance of the 
                <type scope="com::sun::star::sdb">TableDesign</type>
                service and plugs it into the frame passed to the loader.
            </li>
            <li><b>.component:DB/RelationDesign</b><br/>
                Using this URL creates an instance of the 
                <type scope="com::sun::star::sdb">RelationDesign</type>
                service and plugs it into the frame passed to the loader.
            </li>
        </ul>

        The parameters passed to the 
        <member scope="com::sun::star::frame">XFrameLoader::load()</member>
        are forwarded to the object beeing created, 
        in particular to it's 
        <type scope="com::sun::star::lang">XInitialization</type>
        interface.
    **/
    service com::sun::star::frame::FrameLoader;
};
 
//============================================================================= 
}; }; }; }; 
 
#endif