summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/sdb/DatasourceAdministrationDialog.idl
blob: 5542ef544c3cf1ad5f7c513724a6f057dedac284 (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
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
/*************************************************************************
 *
 * 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: DatasourceAdministrationDialog.idl,v $
 * $Revision: 1.14 $
 *
 * 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_DatasourceAdministrationDialog_idl__ 
#define __com_sun_star_sdb_DatasourceAdministrationDialog_idl__ 
 
#ifndef __com_sun_star_ui_dialogs_XExecutableDialog_idl__ 
#include <com/sun/star/ui/dialogs/XExecutableDialog.idl> 
#endif 

#ifndef __com_sun_star_awt_XWindow_idl__ 
#include <com/sun/star/awt/XWindow.idl> 
#endif 

#ifndef __com_sun_star_lang_XInitialization_idl__ 
#include <com/sun/star/lang/XInitialization.idl> 
#endif 

#ifndef __com_sun_star_beans_XPropertySet_idl__ 
#include <com/sun/star/beans/XPropertySet.idl> 
#endif 

//============================================================================= 
 
module com {  module sun {  module star {  module sdb { 
 

/** provides a user interface for administrating the system wide registered data sources.
    <p>
    Here, <em>system wide registered</em> means registered on the (one and only) instance
    of the 
    <type scope="com::sun::star::sdb">
    DatabaseContext
    </type> 
    service.
    </p>
*/
published service DatasourceAdministrationDialog
{
    /** the title of the (dialog) window
    */
    [property] string Title;

    /** parent window to use for the administration dialog
        <p>
        This property can't be set while the dialog is being displayed.
        </p>
    */
    [property] com::sun::star::awt::XWindow ParentWindow;

    /** allows access to the properties of the object
    */
    interface com::sun::star::beans::XPropertySet;

    /** allows starting execution of the administration dialog
    */
    interface com::sun::star::ui::dialogs::XExecutableDialog;

    /** allows initializing the dialog
        <p>
        You do not need to call the initialize method directly, instead you may use the createInstanceWithArguments
        method of your 
        <type scope="com::sun::star::lang">XMultiServiceFactory</type>
        .
        </p>

        <p>
        You specify a parameter by passing one (or more) 
        <type scope="com::sun::star::beans">PropertyValue</type>
        object(s) to the initialize method, where the <em>Name</em> field contains a string describing which aspect
        you want to affect, and the <em>Value</em> field containing a value.
        <br/>
        Imagine the initialization values as if you use setPropertyValue of the 
        <type scope="com::sun::star::beans">XPropertySet</type>
        interface ...
        <br/>
        allowed parameters are
        <ul>
            <li><b>Title</b><br/>
                String describing the initial title of the dialog. 
                If not specified, a default title is used.
            </li>
            <li><b>ParentWindow</b><br/>
                <type scope="com::sun::star::awt">XWindow</type>
                describing the parent window to use for the dialog.
            </li>
            <li><b>InitialSelection</b><br/>
                String or XDataSource describing which data source should be selected initially. 
                This String name must be known to the
                <type scope="com::sun::star::sdb">
                DatabaseContext
                </type>
                .
            </li>
        </ul>
        </p>
    */
    interface com::sun::star::lang::XInitialization;
};
 
//============================================================================= 
 
}; }; }; }; 
 
#endif