:: com :: sun :: star :: accessibility ::
|
interface XAccessibleValue |
|
- Description
- Implement this interface to give access to a single numerical value.
The XAccessibleValue interface represents a single
numerical value and should be implemented by any class that supports
numerical value like scroll bars and spin boxes. This interface lets
you access the value and its upper and lower bounds.
- Since
- OOo 1.1.2
- Developers Guide
- Accessibility - XAccessibleValue
|
Methods' Summary |
getCurrentValue |
Returns the value of this object as a number.
|
setCurrentValue |
Sets the value of this object to the given number.
|
getMaximumValue |
Returns the maximal value that can be represented by this object.
|
getMinimumValue |
Returns the minimal value that can be represented by this object.
|
Methods' Details |
getCurrentValue
- Description
- Returns the value of this object as a number.
The exact return type is implementation dependent. Typical types
are long and double.
- Returns
- Returns the current value represented by this object.
|
|
setCurrentValue
boolean |
setCurrentValue( |
[in] any |
aNumber ); |
- Description
- Sets the value of this object to the given number.
The argument is clipped to the valid interval whose upper and
lower bounds are returned by the methods
getMaximumAccessibleValue and
getMinimumAccessibleValue, i.e. if it is lower than
the minimum value the new value will be the minimum and if it is
greater than the maximum then the new value will be the maximum.
- Parameter aNumber
- The new value represented by this object. The set of admissible
types for this argument is implementation dependent.
- Returns
- Returns true if the new value could successfully be set and
false otherwise.
|
|
getMaximumValue
- Description
- Returns the maximal value that can be represented by this object.
The type of the returned value is implementation dependent. It
does not have to be the same type as that returned by
getCurrentAccessibleValue.
- Returns
- Returns the maximal value in an implementation dependent type.
If this object has no upper bound then an empty object is
returned.
|
|
getMinimumValue
- Description
- Returns the minimal value that can be represented by this object.
The type of the returned value is implementation dependent. It
does not have to be the same type as that returned by
getCurrentAccessibleValue.
- Returns
- Returns the minimal value in an implementation dependent type.
If this object has no upper bound then an empty object is
returned.
|
|
Top of Page
Copyright © 2013, The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache, the Apache feather logo, Apache OpenOffice and OpenOffice.org are trademarks of The Apache Software Foundation. Other names may be trademarks of their respective owners.