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