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  )  [get]

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. See the section about VARIANTs for additional information.
Return values:
S_OK 
S_FALSE if there is nothing to return, [out] value is a VARIANT with vt = VT_EMPTY

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

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. See the section about VARIANTs for additional information.
Return values:
S_OK 
S_FALSE if there is nothing to return, [out] value is a VARIANT with vt = VT_EMPTY

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

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 lower bound then an empty object is returned. See the section about VARIANTs for additional information.
Return values:
S_OK 
S_FALSE if there is nothing to return, [out] value is a VARIANT with vt = VT_EMPTY

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:
[in] value The new value represented by this object. The set of admissible types for this argument is implementation dependent.
Return values:
S_OK 


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

To submit feedback on IAccessible2 API Version 1.2.1, please use the Bugzilla interface located at: http://bugs.linuxfoundation.org/. When using Bugzilla please be sure to select IAccessible2 from the list of components. Bugzilla is the preferred method for receiving feedback because it automatically logs one's feedback in the IAccessible2 tracking system without additional human intervention. One may also, however, send email to accessibility-rfc@a11y.org, a publicly archived emailing list. Please address any technical problems you encounter with this document or the resources to which it links, to the Open A11y Webmaster <webmaster@a11y.org>

A stable online reference version of the documentation for IAccessible2 API Version 1.2.1, is available at: http://a11y.org/ia2-spec. A list of known and reported errors in the documentation for IAccessible2 API Version 1.2.1 can be found at: http://a11y.org/ia2-errata


Generated on Fri Jan 21 14:02:46 2011 for IAccessible2 API Version 1.2.1 by  doxygen 1.5.6