IAccessibleValue Interface Reference

This interface gives access to a single numerical value. More...

import "AccessibleValue.idl";

List of all members.

Public Member Functions

HRESULT currentValue ([out, retval] VARIANT *currentValue)
 Returns the value of this object as a number.
HRESULT setCurrentValue ([in] VARIANT value)
 Sets the value of this object to the given number.
HRESULT maximumValue ([out, retval] VARIANT *maximumValue)
 Returns the maximal value that can be represented by this object.
HRESULT minimumValue ([out, retval] VARIANT *minimumValue)
 Returns the minimal value that can be represented by this object.


Detailed Description

This interface gives access to a single numerical value.

The IAccessibleValue interface represents a single numerical value and should be implemented by any class that supports numerical value like progress bars and spin boxes. This interface lets you access the value and its upper and lower bounds.


Member Function Documentation

HRESULT IAccessibleValue::currentValue [out, retval] VARIANT *  currentValue  ) 
 

Returns the value of this object as a number.

The exact return type is implementation dependent. Typical types are long and double.

Parameters:
[out] currentValue Returns the current value represented by this object.

HRESULT IAccessibleValue::maximumValue [out, retval] VARIANT *  maximumValue  ) 
 

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 method IAccessibleValue::currentValue.

Parameters:
[out] maximumValue Returns the maximal value in an implementation dependent type. If this object has no upper bound then an empty object is returned.

HRESULT IAccessibleValue::minimumValue [out, retval] VARIANT *  minimumValue  ) 
 

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 method IAccessibleValue::currentValue.

Parameters:
[out] minimumValue Returns the minimal value in an implementation dependent type. If this object has no upper bound then an empty object is returned.

HRESULT IAccessibleValue::setCurrentValue [in] VARIANT  value  ) 
 

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 IAccessibleValue::maximumValue and IAccessibleValue::minimumValue, 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:
[out] value The new value represented by this object. The set of admissible types for this argument is implementation dependent.


The documentation for this interface was generated from the following file:
Generated on Sat Dec 2 00:45:22 2006 for IAccessible2 API by  doxygen 1.4.6-NO