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