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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: BindableIntegerValueRange.idl,v $
  10  * $Revision: 1.4 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef __com_sun_star_form_binding_BindableIntegerValueRange_idl__
  32 #define __com_sun_star_form_binding_BindableIntegerValueRange_idl__
  33
  34 #ifndef __com_sun_star_form_binding_BindableControlModel_idl__
  35 #include <com/sun/star/form/binding/BindableControlModel.idl>
  36 #endif
  37
  38 //=============================================================================
  39
  40 module com {  module sun {  module star {  module form {  module binding {
  41
  42 //=============================================================================
  43
  44 /** this service specifies a <type>BindableControlModel</type> which reflects
  45     an integer value, out of a range of permitted integer values.
  46
  47     <p><type>BindableIntegerValueRange</type>s have a value property, a minimum, and a maximum,
  48     all of type integer.</p>
  49 */
  50 service BindableIntegerValueRange
  51 {
  52     /** specifies that the control can be bound to external values
  53
  54         <p>Any binding used with the control model (see <member>XBindableValue::setValueBinding</member>)
  55         must support exchanging double values.</p>
  56
  57         <p>When the (integer) value reflected by the control model is changed, it's converted
  58         into an double value and propagated to the binding.</p>
  59
  60         <p>When the external (double) value changes, it's converted as follows to an integer
  61         value:
  62         <ul><li>If the external value is <NULL/>, the current value of the control model
  63                 will be set to it's minimum.</li>
  64             <li>If the external value is the <em>infinite</em> value, the control value will
  65                 be set to its maximum or minimum, depending on the sign of the external value.</li>
  66             <li>If none of the aforementioned conditions is met, the external value will be simply
  67                 rounded.</li>
  68         </ul>
  69     */
  70     service com::sun::star::form::binding::BindableControlModel;
  71
  72 };
  73
  74 //=============================================================================
  75
  76 }; }; }; }; };
  77
  78 #endif