1*b1cdbd2cSJim Jagielski/************************************************************** 2*b1cdbd2cSJim Jagielski * 3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one 4*b1cdbd2cSJim Jagielski * or more contributor license agreements. See the NOTICE file 5*b1cdbd2cSJim Jagielski * distributed with this work for additional information 6*b1cdbd2cSJim Jagielski * regarding copyright ownership. The ASF licenses this file 7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the 8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance 9*b1cdbd2cSJim Jagielski * with the License. You may obtain a copy of the License at 10*b1cdbd2cSJim Jagielski * 11*b1cdbd2cSJim Jagielski * http://www.apache.org/licenses/LICENSE-2.0 12*b1cdbd2cSJim Jagielski * 13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing, 14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an 15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*b1cdbd2cSJim Jagielski * KIND, either express or implied. See the License for the 17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations 18*b1cdbd2cSJim Jagielski * under the License. 19*b1cdbd2cSJim Jagielski * 20*b1cdbd2cSJim Jagielski *************************************************************/ 21*b1cdbd2cSJim Jagielski 22*b1cdbd2cSJim Jagielski 23*b1cdbd2cSJim Jagielski 24*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_form_binding_BindableDatabaseCheckBox_idl__ 25*b1cdbd2cSJim Jagielski#define __com_sun_star_form_binding_BindableDatabaseCheckBox_idl__ 26*b1cdbd2cSJim Jagielski 27*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_form_component_DatabaseCheckBox_idl__ 28*b1cdbd2cSJim Jagielski#include <com/sun/star/form/component/DatabaseCheckBox.idl> 29*b1cdbd2cSJim Jagielski#endif 30*b1cdbd2cSJim Jagielski 31*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_form_binding_BindableDataAwareControlModel_idl__ 32*b1cdbd2cSJim Jagielski#include <com/sun/star/form/binding/BindableDataAwareControlModel.idl> 33*b1cdbd2cSJim Jagielski#endif 34*b1cdbd2cSJim Jagielski 35*b1cdbd2cSJim Jagielski//============================================================================= 36*b1cdbd2cSJim Jagielski 37*b1cdbd2cSJim Jagielskimodule com { module sun { module star { module form { module binding { 38*b1cdbd2cSJim Jagielski 39*b1cdbd2cSJim Jagielski//============================================================================= 40*b1cdbd2cSJim Jagielski 41*b1cdbd2cSJim Jagielski/** This service specifies a check box which is data-aware and thus can be bound to a 42*b1cdbd2cSJim Jagielski database field, and additionally supports binding to arbitrary external values. 43*b1cdbd2cSJim Jagielski 44*b1cdbd2cSJim Jagielski <p>The <type scope="com::sun::star::form::binding">XValueBinding</type> instance which 45*b1cdbd2cSJim Jagielski can be associated with a <type>BindableDatabaseCheckBox</type> must support exchanging 46*b1cdbd2cSJim Jagielski boolean values. The following mapping between external values and control states apply: 47*b1cdbd2cSJim Jagielski <ul><li><TRUE/> will be mapped to the box being checked, and vice versa</li> 48*b1cdbd2cSJim Jagielski <li><FALSE/> will be mapped to it being unchecked, and vice versa</li> 49*b1cdbd2cSJim Jagielski <li><NULL/> will be mapped to it being in indetermined state, if the box currently supports 50*b1cdbd2cSJim Jagielski this, or being unchecked else. The indetermined of the check box will always be 51*b1cdbd2cSJim Jagielski mapped to <NULL/> when writing the external value.</li> 52*b1cdbd2cSJim Jagielski </ul></p> 53*b1cdbd2cSJim Jagielski 54*b1cdbd2cSJim Jagielski <p>If the value binding associated with a <type>BindableDatabaseCheckBox</type> 55*b1cdbd2cSJim Jagielski supports exchanging string values, <em>and</em> the <member scope="com::sun::star::form::component">CheckBox::RefValue</member> 56*b1cdbd2cSJim Jagielski is <em>not</em> empty, then the radio button will exchange it's value as string: 57*b1cdbd2cSJim Jagielski <ul><li>A string equal to the reference value will be mapped to the button being checked, and vice versa</li> 58*b1cdbd2cSJim Jagielski <li>A string not equal to the reference value will be mapped to the button being unchecked, and vice versa</li> 59*b1cdbd2cSJim Jagielski <li><NULL/> will be mapped to it being in indetermined state</li> 60*b1cdbd2cSJim Jagielski </ul></p> 61*b1cdbd2cSJim Jagielski 62*b1cdbd2cSJim Jagielski @see com::sun::star::form::binding::XValueBinding::supportsType 63*b1cdbd2cSJim Jagielski @see com::sun::star::awt::UnoControlCheckBoxModel::State 64*b1cdbd2cSJim Jagielski @see com::sun::star::awt::UnoControlCheckBoxModel::TriState 65*b1cdbd2cSJim Jagielski @see com::sun::star::form::component::CheckBox::RefValue 66*b1cdbd2cSJim Jagielski */ 67*b1cdbd2cSJim Jagielskiservice BindableDatabaseCheckBox 68*b1cdbd2cSJim Jagielski{ 69*b1cdbd2cSJim Jagielski service com::sun::star::form::component::DatabaseCheckBox; 70*b1cdbd2cSJim Jagielski 71*b1cdbd2cSJim Jagielski /** specifies the interaction between an internal binding to a database column, 72*b1cdbd2cSJim Jagielski and an external value binding.</p> 73*b1cdbd2cSJim Jagielski */ 74*b1cdbd2cSJim Jagielski service com::sun::star::form::binding::BindableDataAwareControlModel; 75*b1cdbd2cSJim Jagielski 76*b1cdbd2cSJim Jagielski /** specifies a value which is to be associated with the control when it's <em>not</em> 77*b1cdbd2cSJim Jagielski checked. 78*b1cdbd2cSJim Jagielski 79*b1cdbd2cSJim Jagielski <p><member scope="com::sun::star::form::component">CheckBox::RefValue</member> is transferred to 80*b1cdbd2cSJim Jagielski possible external value bindings as soon as the check box is checked. With the member 81*b1cdbd2cSJim Jagielski <member>SecondaryRefValue</member>, clients of the check box can also associate a value with 82*b1cdbd2cSJim Jagielski the <em>not checked</em> state of the control.</p> 83*b1cdbd2cSJim Jagielski */ 84*b1cdbd2cSJim Jagielski [property] string SecondaryRefValue; 85*b1cdbd2cSJim Jagielski}; 86*b1cdbd2cSJim Jagielski 87*b1cdbd2cSJim Jagielski//============================================================================= 88*b1cdbd2cSJim Jagielski 89*b1cdbd2cSJim Jagielski}; }; }; }; }; 90*b1cdbd2cSJim Jagielski 91*b1cdbd2cSJim Jagielski#endif 92