offapi/com/sun/star/form/binding/BindableIntegerValueRange.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_BindableIntegerValueRange_idl__
  21 #define __com_sun_star_form_binding_BindableIntegerValueRange_idl__
  22
  23 #include <com/sun/star/form/binding/BindableControlModel.idl>
  24
  25
  26 module com {  module sun {  module star {  module form {  module binding {
  27
  28
  29 /** this service specifies a <type>BindableControlModel</type> which reflects
  30     an integer value, out of a range of permitted integer values.
  31
  32     <p><type>BindableIntegerValueRange</type>s have a value property, a minimum, and a maximum,
  33     all of type integer.</p>
  34 */
  35 service BindableIntegerValueRange
  36 {
  37     /** specifies that the control can be bound to external values
  38
  39         <p>Any binding used with the control model (see <member>XBindableValue::setValueBinding</member>)
  40         must support exchanging double values.</p>
  41
  42         <p>When the (integer) value reflected by the control model is changed, it's converted
  43         into an double value and propagated to the binding.</p>
  44
  45         <p>When the external (double) value changes, it's converted as follows to an integer
  46         value:
  47         <ul><li>If the external value is <NULL/>, the current value of the control model
  48                 will be set to it's minimum.</li>
  49             <li>If the external value is the <em>infinite</em> value, the control value will
  50                 be set to its maximum or minimum, depending on the sign of the external value.</li>
  51             <li>If none of the aforementioned conditions is met, the external value will be simply
  52                 rounded.</li>
  53         </ul>
  54     */
  55     service com::sun::star::form::binding::BindableControlModel;
  56
  57 };
  58
  59
  60 }; }; }; }; };
  61
  62 #endif
  63
  64 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */