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