1d1766043SAndrew Rist/************************************************************** 2cdf0e10cSrcweir * 3d1766043SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one 4d1766043SAndrew Rist * or more contributor license agreements. See the NOTICE file 5d1766043SAndrew Rist * distributed with this work for additional information 6d1766043SAndrew Rist * regarding copyright ownership. The ASF licenses this file 7d1766043SAndrew Rist * to you under the Apache License, Version 2.0 (the 8d1766043SAndrew Rist * "License"); you may not use this file except in compliance 9d1766043SAndrew Rist * with the License. You may obtain a copy of the License at 10d1766043SAndrew Rist * 11d1766043SAndrew Rist * http://www.apache.org/licenses/LICENSE-2.0 12d1766043SAndrew Rist * 13d1766043SAndrew Rist * Unless required by applicable law or agreed to in writing, 14d1766043SAndrew Rist * software distributed under the License is distributed on an 15d1766043SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16d1766043SAndrew Rist * KIND, either express or implied. See the License for the 17d1766043SAndrew Rist * specific language governing permissions and limitations 18d1766043SAndrew Rist * under the License. 19d1766043SAndrew Rist * 20d1766043SAndrew Rist *************************************************************/ 21d1766043SAndrew Rist 22cdf0e10cSrcweir#ifndef __com_sun_star_accessibility_XAccessibleValue_idl__ 23cdf0e10cSrcweir#define __com_sun_star_accessibility_XAccessibleValue_idl__ 24cdf0e10cSrcweir 25cdf0e10cSrcweir#ifndef __com_sun_star_uno_XInterface_idl__ 26cdf0e10cSrcweir#include <com/sun/star/uno/XInterface.idl> 27cdf0e10cSrcweir#endif 28cdf0e10cSrcweir 29cdf0e10cSrcweirmodule com { module sun { module star { module accessibility { 30cdf0e10cSrcweir 31cdf0e10cSrcweir/** Implement this interface to give access to a single numerical value. 32cdf0e10cSrcweir 33cdf0e10cSrcweir <p>The <type>XAccessibleValue</type> interface represents a single 34cdf0e10cSrcweir numerical value and should be implemented by any class that supports 35cdf0e10cSrcweir numerical value like scroll bars and spin boxes. This interface lets 36cdf0e10cSrcweir you access the value and its upper and lower bounds.</p> 37cdf0e10cSrcweir 38*0d3a54ffSJürgen Schmidt @since OpenOffice 1.1.2 39cdf0e10cSrcweir*/ 40cdf0e10cSrcweirpublished interface XAccessibleValue : ::com::sun::star::uno::XInterface 41cdf0e10cSrcweir{ 42cdf0e10cSrcweir /** Returns the value of this object as a number. 43cdf0e10cSrcweir 44cdf0e10cSrcweir <p>The exact return type is implementation dependent. Typical types 45cdf0e10cSrcweir are long and double.</p> 46cdf0e10cSrcweir 47cdf0e10cSrcweir @return 48cdf0e10cSrcweir Returns the current value represented by this object. 49cdf0e10cSrcweir */ 50cdf0e10cSrcweir any getCurrentValue (); 51cdf0e10cSrcweir 52cdf0e10cSrcweir /** Sets the value of this object to the given number. 53cdf0e10cSrcweir 54cdf0e10cSrcweir <p>The argument is clipped to the valid interval whose upper and 55cdf0e10cSrcweir lower bounds are returned by the methods 56cdf0e10cSrcweir <member>getMaximumAccessibleValue</member> and 57cdf0e10cSrcweir <member>getMinimumAccessibleValue</member>, i.e. if it is lower than 58cdf0e10cSrcweir the minimum value the new value will be the minimum and if it is 59cdf0e10cSrcweir greater than the maximum then the new value will be the maximum.</p> 60cdf0e10cSrcweir 61cdf0e10cSrcweir @param aNumber 62cdf0e10cSrcweir The new value represented by this object. The set of admissible 63cdf0e10cSrcweir types for this argument is implementation dependent. 64cdf0e10cSrcweir 65cdf0e10cSrcweir @return 66cdf0e10cSrcweir Returns <TRUE/> if the new value could successfully be set and 67cdf0e10cSrcweir <FALSE/> otherwise. 68cdf0e10cSrcweir */ 69cdf0e10cSrcweir boolean setCurrentValue ([in] any aNumber); 70cdf0e10cSrcweir 71cdf0e10cSrcweir /** Returns the maximal value that can be represented by this object. 72cdf0e10cSrcweir 73cdf0e10cSrcweir <p>The type of the returned value is implementation dependent. It 74cdf0e10cSrcweir does not have to be the same type as that returned by 75cdf0e10cSrcweir <member>getCurrentAccessibleValue</member>.</p> 76cdf0e10cSrcweir 77cdf0e10cSrcweir @return 78cdf0e10cSrcweir Returns the maximal value in an implementation dependent type. 79cdf0e10cSrcweir If this object has no upper bound then an empty object is 80cdf0e10cSrcweir returned. 81cdf0e10cSrcweir */ 82cdf0e10cSrcweir any getMaximumValue (); 83cdf0e10cSrcweir 84cdf0e10cSrcweir /** Returns the minimal value that can be represented by this object. 85cdf0e10cSrcweir 86cdf0e10cSrcweir <p>The type of the returned value is implementation dependent. It 87cdf0e10cSrcweir does not have to be the same type as that returned by 88cdf0e10cSrcweir <member>getCurrentAccessibleValue</member>.</p> 89cdf0e10cSrcweir 90cdf0e10cSrcweir @return 91cdf0e10cSrcweir Returns the minimal value in an implementation dependent type. 92cdf0e10cSrcweir If this object has no upper bound then an empty object is 93cdf0e10cSrcweir returned. 94cdf0e10cSrcweir */ 95cdf0e10cSrcweir any getMinimumValue (); 96cdf0e10cSrcweir}; 97cdf0e10cSrcweir 98cdf0e10cSrcweir}; }; }; }; 99cdf0e10cSrcweir 100cdf0e10cSrcweir#endif 101