LibreOffice
LibreOffice 24.2 SDK API Reference

Implement this interface to give access to a single numerical value. More...
import"XAccessibleValue.idl";
Public Member Functions  
any  getCurrentValue () 
Returns the value of this object as a number. More...  
boolean  setCurrentValue ([in] any aNumber) 
Sets the value of this object to the given number. More...  
any  getMaximumValue () 
Returns the maximum value that can be represented by this object. More...  
any  getMinimumValue () 
Returns the minimum value that can be represented by this object. More...  
any  getMinimumIncrement () 
Returns the minimum increment by which the value represented by this object can be adjusted. More...  
Public Member Functions inherited from XInterface  
any  queryInterface ([in] type aType) 
queries for a new interface to an existing UNO object. More...  
void  acquire () 
increases the reference counter by one. More...  
void  release () 
decreases the reference counter by one. More...  
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.
any getCurrentValue  (  ) 
Returns the value of this object as a number.
The exact return type is implementation dependent. Typical types are long and double.
any getMaximumValue  (  ) 
Returns the maximum 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 getCurrentValue().
any getMinimumIncrement  (  ) 
Returns the minimum increment by which the value represented by this object can be adjusted.
The type of the returned value is implementation dependent. It does not have to be the same type as that returned by getCurrentValue().
any getMinimumValue  (  ) 
Returns the minimum 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 getCurrentValue().
boolean setCurrentValue  (  [in] any  aNumber  ) 
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 getMaximumValue() and getMinimumValue(), 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.
aNumber  The new value represented by this object. The set of admissible types for this argument is implementation dependent. 
TRUE
if the new value could successfully be set and FALSE
otherwise.