offapi/com/sun/star/form/binding/BindableDatabaseCheckBox.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /**
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef __com_sun_star_form_binding_BindableDatabaseCheckBox_idl__
  21 #define __com_sun_star_form_binding_BindableDatabaseCheckBox_idl__
  22
  23 #include <com/sun/star/form/component/DatabaseCheckBox.idl>
  24 #include <com/sun/star/form/binding/BindableDataAwareControlModel.idl>
  25
  26
  27 module com {  module sun {  module star {  module form {  module binding {
  28
  29
  30 /** This service specifies a check box which is data-aware and thus can be bound to a
  31     database field, and additionally supports binding to arbitrary external values.
  32
  33     <p>The <type scope="com::sun::star::form::binding">XValueBinding</type> instance which
  34     can be associated with a <type>BindableDatabaseCheckBox</type> must support exchanging
  35     boolean values. The following mapping between external values and control states apply:
  36     <ul><li><TRUE/> will be mapped to the box being checked, and vice versa</li>
  37         <li><FALSE/> will be mapped to it being unchecked, and vice versa</li>
  38         <li><NULL/> will be mapped to it being in undetermined state, if the box currently supports
  39         this, or being unchecked else. The undetermined of the check box will always be
  40         mapped to <NULL/> when writing the external value.</li>
  41     </ul></p>
  42
  43     <p>If the value binding associated with a <type>BindableDatabaseCheckBox</type>
  44     supports exchanging string values, <em>and</em> the <member scope="com::sun::star::form::component">CheckBox::RefValue</member>
  45     is <em>not</em> empty, then the radio button will exchange it's value as string:
  46     <ul><li>A string equal to the reference value will be mapped to the button being checked, and vice versa</li>
  47         <li>A string not equal to the reference value will be mapped to the button being unchecked, and vice versa</li>
  48         <li><NULL/> will be mapped to it being in undetermined state</li>
  49     </ul></p>
  50
  51     @see com::sun::star::form::binding::XValueBinding::supportsType
  52     @see com::sun::star::awt::UnoControlCheckBoxModel::State
  53     @see com::sun::star::awt::UnoControlCheckBoxModel::TriState
  54     @see com::sun::star::form::component::CheckBox::RefValue
  55  */
  56 service BindableDatabaseCheckBox
  57 {
  58     service com::sun::star::form::component::DatabaseCheckBox;
  59
  60     /** specifies the interaction between an internal binding to a database column,
  61         and an external value binding.</p>
  62     */
  63     service com::sun::star::form::binding::BindableDataAwareControlModel;
  64
  65     /** specifies a value which is to be associated with the control when it's <em>not</em>
  66         checked.
  67
  68         <p><member scope="com::sun::star::form::component">CheckBox::RefValue</member> is transferred to
  69         possible external value bindings as soon as the check box is checked. With the member
  70         <member>SecondaryRefValue</member>, clients of the check box can also associate a value with
  71         the <em>not checked</em> state of the control.</p>
  72     */
  73     [property] string SecondaryRefValue;
  74 };
  75
  76
  77 }; }; }; }; };
  78
  79 #endif
  80
  81 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */