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
28#ifndef __com_sun_star_sdb_DatasourceAdministrationDialog_idl__
29#define __com_sun_star_sdb_DatasourceAdministrationDialog_idl__
30
31#ifndef __com_sun_star_ui_dialogs_XExecutableDialog_idl__
32#include <com/sun/star/ui/dialogs/XExecutableDialog.idl>
33#endif
34
35#ifndef __com_sun_star_awt_XWindow_idl__
36#include <com/sun/star/awt/XWindow.idl>
37#endif
38
39#ifndef __com_sun_star_lang_XInitialization_idl__
40#include <com/sun/star/lang/XInitialization.idl>
41#endif
42
43#ifndef __com_sun_star_beans_XPropertySet_idl__
44#include <com/sun/star/beans/XPropertySet.idl>
45#endif
46
47//=============================================================================
48
49module com {  module sun {  module star {  module sdb {
50
51
52/** provides a user interface for administrating the system wide registered data sources.
53	<p>
54	Here, <em>system wide registered</em> means registered on the (one and only) instance
55	of the
56	<type scope="com::sun::star::sdb">
57	DatabaseContext
58	</type>
59	service.
60	</p>
61*/
62published service DatasourceAdministrationDialog
63{
64	/** the title of the (dialog) window
65	*/
66	[property] string Title;
67
68	/** parent window to use for the administration dialog
69		<p>
70		This property can't be set while the dialog is being displayed.
71		</p>
72	*/
73	[property] com::sun::star::awt::XWindow ParentWindow;
74
75	/** allows access to the properties of the object
76	*/
77	interface com::sun::star::beans::XPropertySet;
78
79	/** allows starting execution of the administration dialog
80	*/
81	interface com::sun::star::ui::dialogs::XExecutableDialog;
82
83	/** allows initializing the dialog
84		<p>
85		You do not need to call the initialize method directly, instead you may use the createInstanceWithArguments
86		method of your
87		<type scope="com::sun::star::lang">XMultiServiceFactory</type>
88		.
89		</p>
90
91		<p>
92		You specify a parameter by passing one (or more)
93		<type scope="com::sun::star::beans">PropertyValue</type>
94		object(s) to the initialize method, where the <em>Name</em> field contains a string describing which aspect
95		you want to affect, and the <em>Value</em> field containing a value.
96		<br/>
97		Imagine the initialization values as if you use setPropertyValue of the
98		<type scope="com::sun::star::beans">XPropertySet</type>
99		interface ...
100		<br/>
101		allowed parameters are
102		<ul>
103			<li><b>Title</b><br/>
104				String describing the initial title of the dialog.
105				If not specified, a default title is used.
106			</li>
107			<li><b>ParentWindow</b><br/>
108				<type scope="com::sun::star::awt">XWindow</type>
109				describing the parent window to use for the dialog.
110			</li>
111			<li><b>InitialSelection</b><br/>
112				String or XDataSource describing which data source should be selected initially.
113				This String name must be known to the
114				<type scope="com::sun::star::sdb">
115				DatabaseContext
116				</type>
117				.
118			</li>
119		</ul>
120		</p>
121	*/
122	interface com::sun::star::lang::XInitialization;
123};
124
125//=============================================================================
126
127}; }; }; };
128
129#endif
130