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_form_component_DatabaseComboBox_idl__
24#define __com_sun_star_form_component_DatabaseComboBox_idl__
25
26#ifndef __com_sun_star_form_component_ComboBox_idl__
27#include <com/sun/star/form/component/ComboBox.idl>
28#endif
29
30#ifndef __com_sun_star_form_DataAwareControlModel_idl__
31#include <com/sun/star/form/DataAwareControlModel.idl>
32#endif
33
34#ifndef __com_sun_star_form_ListSourceType_idl__
35#include <com/sun/star/form/ListSourceType.idl>
36#endif
37
38
39//=============================================================================
40
41 module com {  module sun {  module star {  module form {  module component {
42
43//=============================================================================
44
45/** This service specifies a combo box which is data-aware, and can be bound to a database field.
46
47	<p>Like most other data aware controls, such a combo box will display the actual content
48	of the field it is bound to. In addition, as a combo box contains a list where the user
49	can choose items to fill into the control, this list can be filled with different data from
50	a database, too.</p>
51 */
52published service DatabaseComboBox
53{
54	service com::sun::star::form::component::ComboBox;
55
56	service com::sun::star::form::DataAwareControlModel;
57
58	//-------------------------------------------------------------------------
59
60	/** determines if an empty text should be treated as a <NULL/> value.
61
62		<p>When the user enters text into a combo box, and after this, the control
63		content is to be committed into the database field the control is bound to,
64		a decision must be made how to deal with empty strings.<br/>
65		This is controlled by <member>ConvertEmptyToNull</member>.</p>
66
67		<p>If the property is set to <TRUE/>, and an empty text is to be commited, this is
68		converted into <NULL/>, else it is written as empty string.</p>
69	 */
70	[property] boolean ConvertEmptyToNull;
71
72	/** describes the source of items in the combo box' list.
73
74		<p>The concrete meaning of this property depends on the value of <member>ListSourceType</member></p>
75	 */
76	[property] string ListSource;
77	//-------------------------------------------------------------------------
78
79	/** specifies the kind of list source.
80
81		<p>Note: A value of <member scope="com::sun::star::form">ListSourceType::VALUELIST</member>
82		is not valid for a combo box. It won't be rejected when setting it, but controls will usually ignore it
83		and leave the list empty.</p>
84	 */
85	[property] com::sun::star::form::ListSourceType ListSourceType;
86};
87
88//=============================================================================
89
90}; }; }; }; };
91
92#endif
93