other-licenses/ia2/AccessibleValue.idl

   1 /*************************************************************************
   2  *
   3  *  File Name (AccessibleValue)
   4  *
   5  *  IAccessible2 IDL Specification
   6  *
   7  *  Copyright (c) IBM Corp. 2006
   8  *  Copyright (c) Sun Microsystems, Inc. 2000, 2006
   9  *
  10  *  This library is free software; you can redistribute it and/or
  11  *  modify it under the terms of the GNU Lesser General Public
  12  *  License version 2.1, as published by the Free Software Foundation; either
  13  *  version 2.1 of the License, or (at your option) any later version.
  14  *
  15  *  This library is distributed in the hope that it will be useful,
  16  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  18  *  Lesser General Public License for more details.
  19  *
  20  *  You should have received a copy of the GNU Lesser General Public
  21  *  License along with this library; if not, write to the Free Software
  22  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02110-1301  USA
  23  *
  24  ************************************************************************/
  25
  26 import "objidl.idl";
  27 import "oaidl.idl";
  28 import "oleacc.idl";
  29
  30 /** @brief This interface gives access to a single numerical value.
  31
  32  The IAccessibleValue interface represents a single numerical value and should
  33   be implemented by any class that supports numerical value like progress bars
  34   and spin boxes.  This interface lets you access the value and its upper and
  35   lower bounds.
  36 */
  37 [object, uuid(35855B5B-C566-4fd0-A7B1-E65465600394)]
  38 interface IAccessibleValue : IUnknown
  39 {
  40
  41   /** @brief Returns the value of this object as a number.
  42
  43    The exact return type is implementation dependent.  Typical types are long and
  44     double.
  45    @param [out] currentValue
  46     Returns the current value represented by this object.
  47   */
  48   [propget] HRESULT currentValue
  49     (
  50      [out, retval] VARIANT *currentValue
  51     );
  52
  53   /** @brief Sets the value of this object to the given number.
  54
  55    The argument is clipped to the valid interval whose upper and lower
  56     bounds are returned by the methods IAccessibleValue::maximumValue and
  57         IAccessibleValue::minimumValue, i.e. if it is   lower than the minimum
  58         value the new value will be the minimum and if it is greater than the
  59         maximum then the new value will be the maximum.
  60
  61    @param [out] value
  62     The new value represented by this object.  The set of admissible types for
  63     this argument is implementation dependent.
  64   */
  65   HRESULT setCurrentValue
  66     (
  67      [in] VARIANT value
  68     );
  69
  70   /** @brief Returns the maximal value that can be represented by this object.
  71
  72    The type of the returned value is implementation dependent.  It does not have
  73     to be the same type as that returned by method IAccessibleValue::currentValue.
  74
  75    @param [out] maximumValue
  76     Returns the maximal value in an implementation dependent type. If this object
  77     has no upper bound then an empty object is returned.
  78   */
  79   [propget] HRESULT maximumValue
  80     (
  81      [out, retval] VARIANT *maximumValue
  82     );
  83
  84   /** @brief Returns the minimal value that can be represented by this object.
  85
  86    The type of the returned value is implementation dependent.  It does not have
  87     to be the same type as that returned by method IAccessibleValue::currentValue.
  88
  89    @param [out] minimumValue
  90     Returns the minimal value in an implementation dependent type. If this object
  91     has no upper bound then an empty object is returned.
  92   */
  93   [propget] HRESULT minimumValue
  94     (
  95      [out, retval] VARIANT *minimumValue
  96     );
  97
  98 };