michael@0: /************************************************************************* michael@0: * michael@0: * File Name (AccessibleValue.idl) michael@0: * michael@0: * IAccessible2 IDL Specification michael@0: * michael@0: * Copyright (c) 2007, 2010 Linux Foundation michael@0: * Copyright (c) 2006 IBM Corporation michael@0: * Copyright (c) 2000, 2006 Sun Microsystems, Inc. michael@0: * All rights reserved. michael@0: * michael@0: * michael@0: * Redistribution and use in source and binary forms, with or without michael@0: * modification, are permitted provided that the following conditions michael@0: * are met: michael@0: * michael@0: * 1. Redistributions of source code must retain the above copyright michael@0: * notice, this list of conditions and the following disclaimer. michael@0: * michael@0: * 2. Redistributions in binary form must reproduce the above michael@0: * copyright notice, this list of conditions and the following michael@0: * disclaimer in the documentation and/or other materials michael@0: * provided with the distribution. michael@0: * michael@0: * 3. Neither the name of the Linux Foundation nor the names of its michael@0: * contributors may be used to endorse or promote products michael@0: * derived from this software without specific prior written michael@0: * permission. michael@0: * michael@0: * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND michael@0: * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, michael@0: * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF michael@0: * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE michael@0: * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR michael@0: * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, michael@0: * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT michael@0: * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; michael@0: * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) michael@0: * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN michael@0: * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR michael@0: * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, michael@0: * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. michael@0: * michael@0: * This BSD License conforms to the Open Source Initiative "Simplified michael@0: * BSD License" as published at: michael@0: * http://www.opensource.org/licenses/bsd-license.php michael@0: * michael@0: * IAccessible2 is a trademark of the Linux Foundation. The IAccessible2 michael@0: * mark may be used in accordance with the Linux Foundation Trademark michael@0: * Policy to indicate compliance with the IAccessible2 specification. michael@0: * michael@0: ************************************************************************/ michael@0: michael@0: import "objidl.idl"; michael@0: import "oaidl.idl"; michael@0: import "oleacc.idl"; michael@0: michael@0: /** @brief This interface gives access to a single numerical value. michael@0: michael@0: The %IAccessibleValue interface represents a single numerical value and should michael@0: be implemented by any class that supports numerical value like progress bars michael@0: and spin boxes. This interface lets you access the value and its upper and michael@0: lower bounds. michael@0: */ michael@0: [object, uuid(35855B5B-C566-4fd0-A7B1-E65465600394)] michael@0: interface IAccessibleValue : IUnknown michael@0: { michael@0: michael@0: /** @brief Returns the value of this object as a number. michael@0: michael@0: The exact return type is implementation dependent. Typical types are long and michael@0: double. michael@0: @param [out] currentValue michael@0: Returns the current value represented by this object. See the section about michael@0: @ref _variants "VARIANTs" for additional information. michael@0: @retval S_OK michael@0: @retval S_FALSE if there is nothing to return, [out] value is a VARIANT with vt = VT_EMPTY michael@0: */ michael@0: [propget] HRESULT currentValue michael@0: ( michael@0: [out, retval] VARIANT *currentValue michael@0: ); michael@0: michael@0: /** @brief Sets the value of this object to the given number. michael@0: michael@0: The argument is clipped to the valid interval whose upper and lower michael@0: bounds are returned by the methods IAccessibleValue::maximumValue and michael@0: IAccessibleValue::minimumValue, i.e. if it is lower than the minimum michael@0: value the new value will be the minimum and if it is greater than the michael@0: maximum then the new value will be the maximum. michael@0: michael@0: @param [in] value michael@0: The new value represented by this object. The set of admissible types for michael@0: this argument is implementation dependent. michael@0: @retval S_OK michael@0: */ michael@0: HRESULT setCurrentValue michael@0: ( michael@0: [in] VARIANT value michael@0: ); michael@0: michael@0: /** @brief Returns the maximal value that can be represented by this object. michael@0: michael@0: The type of the returned value is implementation dependent. It does not have michael@0: to be the same type as that returned by method IAccessibleValue::currentValue. michael@0: michael@0: @param [out] maximumValue michael@0: Returns the maximal value in an implementation dependent type. If this object michael@0: has no upper bound then an empty object is returned. See the section about michael@0: @ref _variants "VARIANTs" for additional information. michael@0: @retval S_OK michael@0: @retval S_FALSE if there is nothing to return, [out] value is a VARIANT with vt = VT_EMPTY michael@0: */ michael@0: [propget] HRESULT maximumValue michael@0: ( michael@0: [out, retval] VARIANT *maximumValue michael@0: ); michael@0: michael@0: /** @brief Returns the minimal value that can be represented by this object. michael@0: michael@0: The type of the returned value is implementation dependent. It does not have michael@0: to be the same type as that returned by method IAccessibleValue::currentValue. michael@0: michael@0: @param [out] minimumValue michael@0: Returns the minimal value in an implementation dependent type. If this object michael@0: has no lower bound then an empty object is returned. See the section about michael@0: @ref _variants "VARIANTs" for additional information. michael@0: @retval S_OK michael@0: @retval S_FALSE if there is nothing to return, [out] value is a VARIANT with vt = VT_EMPTY michael@0: */ michael@0: [propget] HRESULT minimumValue michael@0: ( michael@0: [out, retval] VARIANT *minimumValue michael@0: ); michael@0: michael@0: };