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_BindableDatabaseCheckBox_idl__
25#define __com_sun_star_form_binding_BindableDatabaseCheckBox_idl__
26
27#ifndef __com_sun_star_form_component_DatabaseCheckBox_idl__
28#include <com/sun/star/form/component/DatabaseCheckBox.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 check box 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>The <type scope="com::sun::star::form::binding">XValueBinding</type> instance which
45    can be associated with a <type>BindableDatabaseCheckBox</type> must support exchanging
46    boolean values. The following mapping between external values and control states apply:
47    <ul><li><TRUE/> will be mapped to the box being checked, and vice versa</li>
48        <li><FALSE/> will be mapped to it being unchecked, and vice versa</li>
49        <li><NULL/> will be mapped to it being in indetermined state, if the box currently supports
50        this, or being unchecked else. The indetermined of the check box will always be
51        mapped to <NULL/> when writing the external value.</li>
52    </ul></p>
53
54    <p>If the value binding associated with a <type>BindableDatabaseCheckBox</type>
55    supports exchanging string values, <em>and</em> the <member scope="com::sun::star::form::component">CheckBox::RefValue</member>
56    is <em>not</em> empty, then the radio button will exchange it's value as string:
57    <ul><li>A string equal to the reference value will be mapped to the button being checked, and vice versa</li>
58        <li>A string not equal to the reference value will be mapped to the button being unchecked, and vice versa</li>
59        <li><NULL/> will be mapped to it being in indetermined state</li>
60    </ul></p>
61
62    @see com::sun::star::form::binding::XValueBinding::supportsType
63    @see com::sun::star::awt::UnoControlCheckBoxModel::State
64    @see com::sun::star::awt::UnoControlCheckBoxModel::TriState
65    @see com::sun::star::form::component::CheckBox::RefValue
66 */
67service BindableDatabaseCheckBox
68{
69	service com::sun::star::form::component::DatabaseCheckBox;
70
71    /** specifies the interaction between an internal binding to a database column,
72        and an external value binding.</p>
73    */
74    service com::sun::star::form::binding::BindableDataAwareControlModel;
75
76    /** specifies a value which is to be associated with the control when it's <em>not</em>
77        checked.
78
79        <p><member scope="com::sun::star::form::component">CheckBox::RefValue</member> is transferred to
80        possible external value bindings as soon as the check box is checked. With the member
81        <member>SecondaryRefValue</member>, clients of the check box can also associate a value with
82        the <em>not checked</em> state of the control.</p>
83    */
84    [property] string SecondaryRefValue;
85};
86
87//=============================================================================
88
89}; }; }; }; };
90
91#endif
92