xref: /aoo42x/main/offapi/com/sun/star/sdb/TableDesign.idl (revision c4dc0a1a)
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#ifndef __com_sun_star_sdb_TableDesign_idl__
24#define __com_sun_star_sdb_TableDesign_idl__
25
26#ifndef __com_sun_star_frame_XController_idl__
27#include <com/sun/star/frame/XController.idl>
28#endif
29#ifndef __com_sun_star_lang_XInitialization_idl__
30#include <com/sun/star/lang/XInitialization.idl>
31#endif
32#ifndef __com_sun_star_frame_XDispatchProvider_idl__
33#include <com/sun/star/frame/XDispatchProvider.idl>
34#endif
35#ifndef __com_sun_star_form_FormController_idl__
36#include <com/sun/star/form/FormController.idl>
37#endif
38
39module com {  module sun {  module star {  module sdb {
40
41//=============================================================================
42/** implements a component which allows the creation of tables.
43
44	<p>This service implements a user interface for creating tables through a graphical design interface.</p>
45
46	<p>The design view of the TableDesign is divided into two parts. The first part contains the rows
47	where columns can be defined for the table. The second part contains the properties of the selected column.</p>
48
49	@see com::sun::star::sdb::ContentLoader
50	@see com::sun::star::frame::XDispatch
51	@see com::sun::star::frame::XDispatchProviderInterceptor
52
53    @since OpenOffice 1.1.2
54*/
55
56published service TableDesign
57{
58	/** allows the component to be plugged into frames.
59	*/
60	interface com::sun::star::frame::XController;
61
62	/** is used to initialize the TableDesign.
63
64		<p>Parameters (passed to the method
65		<member scope="com::sun::star::lang">XInitialization::initialize</member>)
66		have to be instances of <type scope="com::sun::star::beans">PropertyValue</type>, where the
67		<member scope="com::sun::star::beans">PropertyValue::Name</member> member specifies what the parameter controls,
68		with the <member scope="com::sun::star::beans">PropertyValue::Value</member> member containing the value
69		to be used.<br>
70		Recognized parameters are:
71		<ul>
72			<li><b>Frame</b><br>
73			has to be an <type scope="com::sun::star::frame">XFrame</type> interface specifying the frame to plug the
74			TableDesign component into.
75			</li>
76			<li><b>DataSourceName</b><br>
77			The name of the globally registered <type>DataSource</type> to be used for initial display. It is only
78			meaningful together with the other parameters specifying the object to display.
79			</li>
80			<li><b>CurrentTable</b><br>
81			This is a string giving the name of the object to display initially.
82			</li>
83		</ul>
84		</p>
85	*/
86	interface com::sun::star::lang::XInitialization;
87};
88
89//=============================================================================
90}; }; }; };
91
92#endif
93