LibreOffice
LibreOffice 6.2 SDK API Reference
Public Member Functions | List of all members
XAccessibleValue Interface Reference

Implement this interface to give access to a single numerical value. More...

import"XAccessibleValue.idl";

Inheritance diagram for XAccessibleValue:
XInterface AccessibleButton AccessibleCheckBox AccessibleMenu AccessibleMenuItem AccessibleRadioButton AccessibleScrollBar AccessibleToolBoxItem AccessibleCell AccessibleCellView

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 maximal value that can be represented by this object. More...
 
any getMinimumValue ()
 Returns the minimal value that can be represented by this object. 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...
 

Detailed 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

Member Function Documentation

any getCurrentValue ( )

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.
any getMaximumValue ( )

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.
any getMinimumValue ( )

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.
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 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.

Parameters
aNumberThe 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.

The documentation for this interface was generated from the following file: