1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
|
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2008 by Sun Microsystems, Inc.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* $RCSfile: BindableDatabaseCheckBox.idl,v $
* $Revision: 1.5 $
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
*
************************************************************************/
#ifndef __com_sun_star_form_binding_BindableDatabaseCheckBox_idl__
#define __com_sun_star_form_binding_BindableDatabaseCheckBox_idl__
#ifndef __com_sun_star_form_component_DatabaseCheckBox_idl__
#include <com/sun/star/form/component/DatabaseCheckBox.idl>
#endif
#ifndef __com_sun_star_form_binding_BindableDataAwareControlModel_idl__
#include <com/sun/star/form/binding/BindableDataAwareControlModel.idl>
#endif
//=============================================================================
module com { module sun { module star { module form { module binding {
//=============================================================================
/** This service specifies a check box which is data-aware and thus can be bound to a
database field, and additionally supports binding to arbitrary external values.
<p>The <type scope="com::sun::star::form::binding">XValueBinding</type> instance which
can be associated with a <type>BindableDatabaseCheckBox</type> must support exchanging
boolean values. The following mapping between external values and control states apply:
<ul><li><TRUE/> will be mapped to the box being checked, and vice versa</li>
<li><FALSE/> will be mapped to it being unchecked, and vice versa</li>
<li><NULL/> will be mapped to it being in indetermined state, if the box currently supports
this, or being unchecked else. The indetermined of the check box will always be
mapped to <NULL/> when writing the external value.</li>
</ul></p>
<p>If the value binding associated with a <type>BindableDatabaseCheckBox</type>
supports exchanging string values, <em>and</em> the <member scope="com::sun::star::form::component">CheckBox::RefValue</member>
is <em>not</em> empty, then the radio button will exchange it's value as string:
<ul><li>A string equal to the reference value will be mapped to the button being checked, and vice versa</li>
<li>A string not equal to the reference value will be mapped to the button being unchecked, and vice versa</li>
<li><NULL/> will be mapped to it being in indetermined state</li>
</ul></p>
@see com::sun::star::form::binding::XValueBinding::supportsType
@see com::sun::star::awt::UnoControlCheckBoxModel::State
@see com::sun::star::awt::UnoControlCheckBoxModel::TriState
@see com::sun::star::form::component::CheckBox::RefValue
*/
service BindableDatabaseCheckBox
{
service com::sun::star::form::component::DatabaseCheckBox;
/** specifies the interaction between an internal binding to a database column,
and an external value binding.</p>
*/
service com::sun::star::form::binding::BindableDataAwareControlModel;
/** specifies a value which is to be associated with the control when it's <em>not</em>
checked.
<p><member scope="com::sun::star::form::component">CheckBox::RefValue</member> is transferred to
possible external value bindings as soon as the check box is checked. With the member
<member>SecondaryRefValue</member>, clients of the check box can also associate a value with
the <em>not checked</em> state of the control.</p>
*/
[property] string SecondaryRefValue;
};
//=============================================================================
}; }; }; }; };
#endif
|
