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_form_binding_BindableDatabaseListBox_idl__
25#define __com_sun_star_form_binding_BindableDatabaseListBox_idl__
26
27#ifndef __com_sun_star_form_component_DatabaseListBox_idl__
28#include <com/sun/star/form/component/DatabaseListBox.idl>
29#endif
30
31#ifndef __com_sun_star_form_binding_BindableDataAwareControlModel_idl__
32#include <com/sun/star/form/binding/BindableDataAwareControlModel.idl>
33#endif
34
35//=============================================================================
36
37module com {  module sun {  module star {  module form {  module binding {
38
39//=============================================================================
40
41/** This service specifies a list box model which is data-aware and thus can be bound to a
42    database field, and additionally supports binding to arbitrary external values.
43
44    <p>There are four possible ways how a <type>BindableDatabaseListBox</type> exchanges
45    values with an external binding, the following lists explains all of them. If a new binding
46    is set at a <type>BindableDatabaseListBox</type>, the types from the following list are
47    tried in descending order: The first type supported by the binding is used for data exchange.
48    <ol><li><em>sequences of integers</em>: When used, the integers in the sequence will represent
49            the indexes of the selected entries of the list box.</li>
50        <li><em>integer values</em>: When used, the value will represent the index of the selected entry.
51            If no entry is selected, -1 will be transferred. If more than one entry is selected, <NULL/>
52            will be transferred.</li>
53        <li><em>sequences of strings</em>: When used, the strings in the sequence present the texts
54            of the selected entries of the list box.</li>
55        <li><em>string values</em>: When used. the value will represent the text of the selected entry.
56            If no entry is selected, an empty string will be transferred. If more than one entry is selected,
57            <NULL/> will be transferred.</li>
58    </ol></p>
59
60    @see com::sun::star::form::binding::XValueBinding::supportsType
61 */
62service BindableDatabaseListBox
63{
64	service com::sun::star::form::component::DatabaseListBox;
65
66    /** specifies the interaction between an internal binding to a database column,
67        and an external value binding.</p>
68    */
69    service com::sun::star::form::binding::BindableDataAwareControlModel;
70
71};
72
73//=============================================================================
74
75}; }; }; }; };
76
77#endif
78