offapi/com/sun/star/accessibility/XAccessibleValue.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: XAccessibleValue.idl,v $
  10  * $Revision: 1.7 $
  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_accessibility_XAccessibleValue_idl__
  32 #define __com_sun_star_accessibility_XAccessibleValue_idl__
  33
  34 #ifndef __com_sun_star_uno_XInterface_idl__
  35 #include <com/sun/star/uno/XInterface.idl>
  36 #endif
  37
  38 module com { module sun { module star { module accessibility {
  39
  40 /** Implement this interface to give access to a single numerical value.
  41
  42     <p>The <type>XAccessibleValue</type> interface represents a single
  43     numerical value and should be implemented by any class that supports
  44     numerical value like scroll bars and spin boxes.  This interface lets
  45     you access the value and its upper and lower bounds.</p>
  46
  47     @since OOo 1.1.2
  48 */
  49 published interface XAccessibleValue : ::com::sun::star::uno::XInterface
  50 {
  51     /** Returns the value of this object as a number.
  52
  53         <p>The exact return type is implementation dependent.  Typical types
  54         are long and double.</p>
  55
  56         @return
  57             Returns the current value represented by this object.
  58     */
  59     any getCurrentValue ();
  60
  61     /** Sets the value of this object to the given number.
  62
  63         <p>The argument is clipped to the valid interval whose upper and
  64         lower bounds are returned by the methods
  65         <member>getMaximumAccessibleValue</member> and
  66         <member>getMinimumAccessibleValue</member>, i.e. if it is lower than
  67         the minimum value the new value will be the minimum and if it is
  68         greater than the maximum then the new value will be the maximum.</p>
  69
  70         @param aNumber
  71             The new value represented by this object.  The set of admissible
  72             types for this argument is implementation dependent.
  73
  74         @return
  75             Returns <TRUE/> if the new value could successfully be set and
  76             <FALSE/> otherwise.
  77     */
  78     boolean setCurrentValue ([in] any aNumber);
  79
  80     /** Returns the maximal value that can be represented by this object.
  81
  82         <p>The type of the returned value is implementation dependent.  It
  83         does not have to be the same type as that returned by
  84         <member>getCurrentAccessibleValue</member>.</p>
  85
  86         @return
  87             Returns the maximal value in an implementation dependent type.
  88             If this object has no upper bound then an empty object is
  89             returned.
  90     */
  91     any getMaximumValue ();
  92
  93     /** Returns the minimal value that can be represented by this object.
  94
  95         <p>The type of the returned value is implementation dependent.  It
  96         does not have to be the same type as that returned by
  97         <member>getCurrentAccessibleValue</member>.</p>
  98
  99         @return
 100             Returns the minimal value in an implementation dependent type.
 101             If this object has no upper bound then an empty object is
 102             returned.
 103     */
 104     any getMinimumValue ();
 105 };
 106
 107 }; }; }; };
 108
 109 #endif