1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/other-licenses/ia2/AccessibleValue.idl Wed Dec 31 06:09:35 2014 +0100
1.3 @@ -0,0 +1,136 @@
1.4 +/*************************************************************************
1.5 + *
1.6 + * File Name (AccessibleValue.idl)
1.7 + *
1.8 + * IAccessible2 IDL Specification
1.9 + *
1.10 + * Copyright (c) 2007, 2010 Linux Foundation
1.11 + * Copyright (c) 2006 IBM Corporation
1.12 + * Copyright (c) 2000, 2006 Sun Microsystems, Inc.
1.13 + * All rights reserved.
1.14 + *
1.15 + *
1.16 + * Redistribution and use in source and binary forms, with or without
1.17 + * modification, are permitted provided that the following conditions
1.18 + * are met:
1.19 + *
1.20 + * 1. Redistributions of source code must retain the above copyright
1.21 + * notice, this list of conditions and the following disclaimer.
1.22 + *
1.23 + * 2. Redistributions in binary form must reproduce the above
1.24 + * copyright notice, this list of conditions and the following
1.25 + * disclaimer in the documentation and/or other materials
1.26 + * provided with the distribution.
1.27 + *
1.28 + * 3. Neither the name of the Linux Foundation nor the names of its
1.29 + * contributors may be used to endorse or promote products
1.30 + * derived from this software without specific prior written
1.31 + * permission.
1.32 + *
1.33 + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
1.34 + * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
1.35 + * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
1.36 + * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
1.37 + * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
1.38 + * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
1.39 + * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
1.40 + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
1.41 + * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
1.42 + * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
1.43 + * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
1.44 + * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
1.45 + * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
1.46 + *
1.47 + * This BSD License conforms to the Open Source Initiative "Simplified
1.48 + * BSD License" as published at:
1.49 + * http://www.opensource.org/licenses/bsd-license.php
1.50 + *
1.51 + * IAccessible2 is a trademark of the Linux Foundation. The IAccessible2
1.52 + * mark may be used in accordance with the Linux Foundation Trademark
1.53 + * Policy to indicate compliance with the IAccessible2 specification.
1.54 + *
1.55 + ************************************************************************/
1.56 +
1.57 +import "objidl.idl";
1.58 +import "oaidl.idl";
1.59 +import "oleacc.idl";
1.60 +
1.61 +/** @brief This interface gives access to a single numerical value.
1.62 +
1.63 + The %IAccessibleValue interface represents a single numerical value and should
1.64 + be implemented by any class that supports numerical value like progress bars
1.65 + and spin boxes. This interface lets you access the value and its upper and
1.66 + lower bounds.
1.67 +*/
1.68 +[object, uuid(35855B5B-C566-4fd0-A7B1-E65465600394)]
1.69 +interface IAccessibleValue : IUnknown
1.70 +{
1.71 +
1.72 + /** @brief Returns the value of this object as a number.
1.73 +
1.74 + The exact return type is implementation dependent. Typical types are long and
1.75 + double.
1.76 + @param [out] currentValue
1.77 + Returns the current value represented by this object. See the section about
1.78 + @ref _variants "VARIANTs" for additional information.
1.79 + @retval S_OK
1.80 + @retval S_FALSE if there is nothing to return, [out] value is a VARIANT with vt = VT_EMPTY
1.81 + */
1.82 + [propget] HRESULT currentValue
1.83 + (
1.84 + [out, retval] VARIANT *currentValue
1.85 + );
1.86 +
1.87 + /** @brief Sets the value of this object to the given number.
1.88 +
1.89 + The argument is clipped to the valid interval whose upper and lower
1.90 + bounds are returned by the methods IAccessibleValue::maximumValue and
1.91 + IAccessibleValue::minimumValue, i.e. if it is lower than the minimum
1.92 + value the new value will be the minimum and if it is greater than the
1.93 + maximum then the new value will be the maximum.
1.94 +
1.95 + @param [in] value
1.96 + The new value represented by this object. The set of admissible types for
1.97 + this argument is implementation dependent.
1.98 + @retval S_OK
1.99 + */
1.100 + HRESULT setCurrentValue
1.101 + (
1.102 + [in] VARIANT value
1.103 + );
1.104 +
1.105 + /** @brief Returns the maximal value that can be represented by this object.
1.106 +
1.107 + The type of the returned value is implementation dependent. It does not have
1.108 + to be the same type as that returned by method IAccessibleValue::currentValue.
1.109 +
1.110 + @param [out] maximumValue
1.111 + Returns the maximal value in an implementation dependent type. If this object
1.112 + has no upper bound then an empty object is returned. See the section about
1.113 + @ref _variants "VARIANTs" for additional information.
1.114 + @retval S_OK
1.115 + @retval S_FALSE if there is nothing to return, [out] value is a VARIANT with vt = VT_EMPTY
1.116 + */
1.117 + [propget] HRESULT maximumValue
1.118 + (
1.119 + [out, retval] VARIANT *maximumValue
1.120 + );
1.121 +
1.122 + /** @brief Returns the minimal value that can be represented by this object.
1.123 +
1.124 + The type of the returned value is implementation dependent. It does not have
1.125 + to be the same type as that returned by method IAccessibleValue::currentValue.
1.126 +
1.127 + @param [out] minimumValue
1.128 + Returns the minimal value in an implementation dependent type. If this object
1.129 + has no lower bound then an empty object is returned. See the section about
1.130 + @ref _variants "VARIANTs" for additional information.
1.131 + @retval S_OK
1.132 + @retval S_FALSE if there is nothing to return, [out] value is a VARIANT with vt = VT_EMPTY
1.133 + */
1.134 + [propget] HRESULT minimumValue
1.135 + (
1.136 + [out, retval] VARIANT *minimumValue
1.137 + );
1.138 +
1.139 +};
