1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23
24#ifndef __com_sun_star_sdb_DatasourceAdministrationDialog_idl__
25#define __com_sun_star_sdb_DatasourceAdministrationDialog_idl__
26
27#ifndef __com_sun_star_ui_dialogs_XExecutableDialog_idl__
28#include <com/sun/star/ui/dialogs/XExecutableDialog.idl>
29#endif
30
31#ifndef __com_sun_star_awt_XWindow_idl__
32#include <com/sun/star/awt/XWindow.idl>
33#endif
34
35#ifndef __com_sun_star_lang_XInitialization_idl__
36#include <com/sun/star/lang/XInitialization.idl>
37#endif
38
39#ifndef __com_sun_star_beans_XPropertySet_idl__
40#include <com/sun/star/beans/XPropertySet.idl>
41#endif
42
43//=============================================================================
44
45module com {  module sun {  module star {  module sdb {
46
47
48/** provides a user interface for administrating the system wide registered data sources.
49	<p>
50	Here, <em>system wide registered</em> means registered on the (one and only) instance
51	of the
52	<type scope="com::sun::star::sdb">
53	DatabaseContext
54	</type>
55	service.
56	</p>
57*/
58published service DatasourceAdministrationDialog
59{
60	/** the title of the (dialog) window
61	*/
62	[property] string Title;
63
64	/** parent window to use for the administration dialog
65		<p>
66		This property can't be set while the dialog is being displayed.
67		</p>
68	*/
69	[property] com::sun::star::awt::XWindow ParentWindow;
70
71	/** allows access to the properties of the object
72	*/
73	interface com::sun::star::beans::XPropertySet;
74
75	/** allows starting execution of the administration dialog
76	*/
77	interface com::sun::star::ui::dialogs::XExecutableDialog;
78
79	/** allows initializing the dialog
80		<p>
81		You do not need to call the initialize method directly, instead you may use the createInstanceWithArguments
82		method of your
83		<type scope="com::sun::star::lang">XMultiServiceFactory</type>
84		.
85		</p>
86
87		<p>
88		You specify a parameter by passing one (or more)
89		<type scope="com::sun::star::beans">PropertyValue</type>
90		object(s) to the initialize method, where the <em>Name</em> field contains a string describing which aspect
91		you want to affect, and the <em>Value</em> field containing a value.
92		<br/>
93		Imagine the initialization values as if you use setPropertyValue of the
94		<type scope="com::sun::star::beans">XPropertySet</type>
95		interface ...
96		<br/>
97		allowed parameters are
98		<ul>
99			<li><b>Title</b><br/>
100				String describing the initial title of the dialog.
101				If not specified, a default title is used.
102			</li>
103			<li><b>ParentWindow</b><br/>
104				<type scope="com::sun::star::awt">XWindow</type>
105				describing the parent window to use for the dialog.
106			</li>
107			<li><b>InitialSelection</b><br/>
108				String or XDataSource describing which data source should be selected initially.
109				This String name must be known to the
110				<type scope="com::sun::star::sdb">
111				DatabaseContext
112				</type>
113				.
114			</li>
115		</ul>
116		</p>
117	*/
118	interface com::sun::star::lang::XInitialization;
119};
120
121//=============================================================================
122
123}; }; }; };
124
125#endif
126