IAccessibleValue

by 2 contributors:

This interface gives access to a single numerical value.
1.0
28
Introduced
Gecko 1.9
Inherits from: IUnknown Last changed in Gecko 1.9 (Firefox 3)

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.

Method overview

[propget] HRESULT currentValue([out] VARIANT currentValue );
[propget] HRESULT maximumValue([out] VARIANT maximumValue );
[propget] HRESULT minimumValue([out] VARIANT minimumValue );
HRESULT setCurrentValue([in] VARIANT value );

Methods

currentValue()

Returns the value of this object as a number. The exact return type is implementation dependent. Typical types are long and double.

[propget] HRESULT currentValue(
  [out] VARIANT currentValue 
);
Parameters
currentValue
Returns the current value represented by this object. See the section about.
Return value

S_FALSE if there is nothing to return, [out] value is null. S_OK.

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 currentValue().

[propget] HRESULT maximumValue(
  [out] VARIANT maximumValue 
);
Parameters
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.
Return value

S_OK.

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 currentValue().

[propget] HRESULT minimumValue(
  [out] VARIANT minimumValue 
);
Parameters
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.
Return value

S_OK.

setCurrentValue()

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 maximumValue() and minimumValue(), that is 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.

HRESULT setCurrentValue(
  [in] VARIANT value 
);
Parameters
value
The new value represented by this object. The set of admissible types for this argument is implementation dependent.
Return value

S_OK.

Document Tags and Contributors

Contributors to this page: Sheppy, trevorh
Last updated by: Sheppy,