idl/Accessibility_Value.idl

   1 /*
   2  * AT-SPI - Assistive Technology Service Provider Interface
   3  * (Gnome Accessibility Project; http://developer.gnome.org/projects/gap)
   4  *
   5  * Copyright 2001 Sun Microsystems, Inc.
   6  *
   7  * This library is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU Library General Public
   9  * License as published by the Free Software Foundation; either
  10  * version 2 of the License, or (at your option) any later version.
  11  *
  12  * This library is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * Library General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Library General Public
  18  * License along with this library; if not, write to the
  19  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  20  * Boston, MA 02111-1307, USA.
  21  */
  22
  23 module Accessibility {
  24
  25    /**
  26     * An interface supporting controls which allow a
  27     * one-dimensional, scalar quantity to be modified or which
  28     * reflect a scalar quantity. (If STATE_EDITABLE is not present,
  29     * the valuator is treated as "read only".
  30     *
  31     * @note Events generated by Image instances include:
  32     * \li \c "object:value-changed"
  33     */
  34   interface Value : Bonobo::Unknown {
  35     /**
  36      * The minimum value allowed by this valuator.
  37      */
  38     readonly attribute double minimumValue;
  39     /**
  40      * The maximum value allowed by this valuator.
  41      */
  42     readonly attribute double maximumValue;
  43     /**
  44      * The smallest incremental change which this valuator allows.
  45      * If 0, the incremental changes to the valuator are
  46      * limited only by the precision of a double precision value
  47      * on the platform.
  48      */
  49     readonly attribute double minimumIncrement;
  50     /**
  51      * The current value of the valuator.
  52      */
  53     attribute double currentValue;
  54
  55     /** \cond
  56      * unImplemented:
  57      *
  58      * placeholders for future expansion.
  59      */
  60     void unImplemented ();
  61     void unImplemented2 ();
  62     void unImplemented3 ();
  63     void unImplemented4 ();
  64     /** \endcond */
  65   };
  66 };