diff options
Diffstat (limited to 'offapi/com/sun/star/form/binding/BindableDatabaseRadioButton.idl')
-rw-r--r-- | offapi/com/sun/star/form/binding/BindableDatabaseRadioButton.idl | 92 |
1 files changed, 92 insertions, 0 deletions
diff --git a/offapi/com/sun/star/form/binding/BindableDatabaseRadioButton.idl b/offapi/com/sun/star/form/binding/BindableDatabaseRadioButton.idl new file mode 100644 index 000000000000..d2779ba1ea8d --- /dev/null +++ b/offapi/com/sun/star/form/binding/BindableDatabaseRadioButton.idl @@ -0,0 +1,92 @@ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2000, 2010 Oracle and/or its affiliates. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * 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_BindableDatabaseRadioButton_idl__ +#define __com_sun_star_form_binding_BindableDatabaseRadioButton_idl__ + +#ifndef __com_sun_star_form_component_DatabaseRadioButton_idl__ +#include <com/sun/star/form/component/DatabaseRadioButton.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 radio button 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>BindableDatabaseRadioButton</type> must support exchanging + boolean values. The following mapping between external values and control states apply: + <ul><li><TRUE/> will be mapped to the button 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</li> + </ul></p> + + <p>If the value binding associated with a <type>BindableDatabaseRadioButton</type> + supports exchanging string values, <em>and</em> the <member scope="com::sun::star::form::component">RadioButton::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::UnoControlRadioButtonModel::State + @see com::sun::star::form::component::RadioButton::RefValue + */ +service BindableDatabaseRadioButton +{ + service com::sun::star::form::component::DatabaseRadioButton; + + /** 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> + selected. + + <p><member scope="com::sun::star::form::component">RadioButton::RefValue</member> is transferred to + possible external value bindings as soon as the radio button is selected. With the member + <member>SecondaryRefValue</member>, clients of the radio button can also associate a value with + the <em>not selected</em> state of the control.</p> + */ + [property] string SecondaryRefValue; +}; + +//============================================================================= + +}; }; }; }; }; + +#endif |