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
  21 module com {  module sun {  module star {  module form {  module binding {
  22
  23
  24 /** This service specifies a check box which is data-aware and thus can be bound to a
  25     database field, and additionally supports binding to arbitrary external values.
  26
  27     <p>The com::sun::star::form::binding::XValueBinding instance which
  28     can be associated with a BindableDatabaseCheckBox must support exchanging
  29     boolean values. The following mapping between external values and control states apply:
  30     <ul><li>`TRUE` will be mapped to the box being checked, and vice versa</li>
  31         <li>`FALSE` will be mapped to it being unchecked, and vice versa</li>
  32         <li>`NULL` will be mapped to it being in undetermined state, if the box currently supports
  33         this, or being unchecked else. The undetermined of the check box will always be
  34         mapped to `NULL` when writing the external value.</li>
  35     </ul></p>
  36
  37     <p>If the value binding associated with a BindableDatabaseCheckBox
  38     supports exchanging string values, <em>and</em> the com::sun::star::form::component::CheckBox::RefValue
  39     is <em>not</em> empty, then the radio button will exchange its value as string:
  40     <ul><li>A string equal to the reference value will be mapped to the button being checked, and vice versa</li>
  41         <li>A string not equal to the reference value will be mapped to the button being unchecked, and vice versa</li>
  42         <li>`NULL` will be mapped to it being in undetermined state</li>
  43     </ul></p>
  44
  45     @see com::sun::star::form::binding::XValueBinding::supportsType
  46     @see com::sun::star::awt::UnoControlCheckBoxModel::State
  47     @see com::sun::star::awt::UnoControlCheckBoxModel::TriState
  48     @see com::sun::star::form::component::CheckBox::RefValue
  49  */
  50 service BindableDatabaseCheckBox
  51 {
  52     service com::sun::star::form::component::DatabaseCheckBox;
  53
  54     /** specifies the interaction between an internal binding to a database column,
  55         and an external value binding.</p>
  56     */
  57     service com::sun::star::form::binding::BindableDataAwareControlModel;
  58
  59     /** specifies a value which is to be associated with the control when it's <em>not</em>
  60         checked.
  61
  62         <p>com::sun::star::form::component::CheckBox::RefValue is transferred to
  63         possible external value bindings as soon as the check box is checked. With the member
  64         #SecondaryRefValue, clients of the check box can also associate a value with
  65         the <em>not checked</em> state of the control.</p>
  66     */
  67     [property] string SecondaryRefValue;
  68 };
  69
  70
  71 }; }; }; }; };
  72
  73 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */