other-licenses/ia2/AccessibleValue.idl@925c144e1f1f (annotated)
other-licenses/ia2/AccessibleValue.idl
Fri, 16 Jan 2015 18:13:44 +0100
- author
- Michael Schloh von Bennewitz <michael@schloh.com>
- date
- Fri, 16 Jan 2015 18:13:44 +0100
- branch
- TOR_BUG_9701
- changeset 14
- 925c144e1f1f
- permissions
- -rw-r--r--
Integrate suggestion from review to improve consistency with existing code.
| michael@0 | 1 | /************************************************************************* |
| michael@0 | 2 | * |
| michael@0 | 3 | * File Name (AccessibleValue.idl) |
| michael@0 | 4 | * |
| michael@0 | 5 | * IAccessible2 IDL Specification |
| michael@0 | 6 | * |
| michael@0 | 7 | * Copyright (c) 2007, 2010 Linux Foundation |
| michael@0 | 8 | * Copyright (c) 2006 IBM Corporation |
| michael@0 | 9 | * Copyright (c) 2000, 2006 Sun Microsystems, Inc. |
| michael@0 | 10 | * All rights reserved. |
| michael@0 | 11 | * |
| michael@0 | 12 | * |
| michael@0 | 13 | * Redistribution and use in source and binary forms, with or without |
| michael@0 | 14 | * modification, are permitted provided that the following conditions |
| michael@0 | 15 | * are met: |
| michael@0 | 16 | * |
| michael@0 | 17 | * 1. Redistributions of source code must retain the above copyright |
| michael@0 | 18 | * notice, this list of conditions and the following disclaimer. |
| michael@0 | 19 | * |
| michael@0 | 20 | * 2. Redistributions in binary form must reproduce the above |
| michael@0 | 21 | * copyright notice, this list of conditions and the following |
| michael@0 | 22 | * disclaimer in the documentation and/or other materials |
| michael@0 | 23 | * provided with the distribution. |
| michael@0 | 24 | * |
| michael@0 | 25 | * 3. Neither the name of the Linux Foundation nor the names of its |
| michael@0 | 26 | * contributors may be used to endorse or promote products |
| michael@0 | 27 | * derived from this software without specific prior written |
| michael@0 | 28 | * permission. |
| michael@0 | 29 | * |
| michael@0 | 30 | * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND |
| michael@0 | 31 | * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, |
| michael@0 | 32 | * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF |
| michael@0 | 33 | * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE |
| michael@0 | 34 | * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR |
| michael@0 | 35 | * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
| michael@0 | 36 | * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT |
| michael@0 | 37 | * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; |
| michael@0 | 38 | * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) |
| michael@0 | 39 | * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN |
| michael@0 | 40 | * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR |
| michael@0 | 41 | * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, |
| michael@0 | 42 | * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| michael@0 | 43 | * |
| michael@0 | 44 | * This BSD License conforms to the Open Source Initiative "Simplified |
| michael@0 | 45 | * BSD License" as published at: |
| michael@0 | 46 | * http://www.opensource.org/licenses/bsd-license.php |
| michael@0 | 47 | * |
| michael@0 | 48 | * IAccessible2 is a trademark of the Linux Foundation. The IAccessible2 |
| michael@0 | 49 | * mark may be used in accordance with the Linux Foundation Trademark |
| michael@0 | 50 | * Policy to indicate compliance with the IAccessible2 specification. |
| michael@0 | 51 | * |
| michael@0 | 52 | ************************************************************************/ |
| michael@0 | 53 | |
| michael@0 | 54 | import "objidl.idl"; |
| michael@0 | 55 | import "oaidl.idl"; |
| michael@0 | 56 | import "oleacc.idl"; |
| michael@0 | 57 | |
| michael@0 | 58 | /** @brief This interface gives access to a single numerical value. |
| michael@0 | 59 | |
| michael@0 | 60 | The %IAccessibleValue interface represents a single numerical value and should |
| michael@0 | 61 | be implemented by any class that supports numerical value like progress bars |
| michael@0 | 62 | and spin boxes. This interface lets you access the value and its upper and |
| michael@0 | 63 | lower bounds. |
| michael@0 | 64 | */ |
| michael@0 | 65 | [object, uuid(35855B5B-C566-4fd0-A7B1-E65465600394)] |
| michael@0 | 66 | interface IAccessibleValue : IUnknown |
| michael@0 | 67 | { |
| michael@0 | 68 | |
| michael@0 | 69 | /** @brief Returns the value of this object as a number. |
| michael@0 | 70 | |
| michael@0 | 71 | The exact return type is implementation dependent. Typical types are long and |
| michael@0 | 72 | double. |
| michael@0 | 73 | @param [out] currentValue |
| michael@0 | 74 | Returns the current value represented by this object. See the section about |
| michael@0 | 75 | @ref _variants "VARIANTs" for additional information. |
| michael@0 | 76 | @retval S_OK |
| michael@0 | 77 | @retval S_FALSE if there is nothing to return, [out] value is a VARIANT with vt = VT_EMPTY |
| michael@0 | 78 | */ |
| michael@0 | 79 | [propget] HRESULT currentValue |
| michael@0 | 80 | ( |
| michael@0 | 81 | [out, retval] VARIANT *currentValue |
| michael@0 | 82 | ); |
| michael@0 | 83 | |
| michael@0 | 84 | /** @brief Sets the value of this object to the given number. |
| michael@0 | 85 | |
| michael@0 | 86 | The argument is clipped to the valid interval whose upper and lower |
| michael@0 | 87 | bounds are returned by the methods IAccessibleValue::maximumValue and |
| michael@0 | 88 | IAccessibleValue::minimumValue, i.e. if it is lower than the minimum |
| michael@0 | 89 | value the new value will be the minimum and if it is greater than the |
| michael@0 | 90 | maximum then the new value will be the maximum. |
| michael@0 | 91 | |
| michael@0 | 92 | @param [in] value |
| michael@0 | 93 | The new value represented by this object. The set of admissible types for |
| michael@0 | 94 | this argument is implementation dependent. |
| michael@0 | 95 | @retval S_OK |
| michael@0 | 96 | */ |
| michael@0 | 97 | HRESULT setCurrentValue |
| michael@0 | 98 | ( |
| michael@0 | 99 | [in] VARIANT value |
| michael@0 | 100 | ); |
| michael@0 | 101 | |
| michael@0 | 102 | /** @brief Returns the maximal value that can be represented by this object. |
| michael@0 | 103 | |
| michael@0 | 104 | The type of the returned value is implementation dependent. It does not have |
| michael@0 | 105 | to be the same type as that returned by method IAccessibleValue::currentValue. |
| michael@0 | 106 | |
| michael@0 | 107 | @param [out] maximumValue |
| michael@0 | 108 | Returns the maximal value in an implementation dependent type. If this object |
| michael@0 | 109 | has no upper bound then an empty object is returned. See the section about |
| michael@0 | 110 | @ref _variants "VARIANTs" for additional information. |
| michael@0 | 111 | @retval S_OK |
| michael@0 | 112 | @retval S_FALSE if there is nothing to return, [out] value is a VARIANT with vt = VT_EMPTY |
| michael@0 | 113 | */ |
| michael@0 | 114 | [propget] HRESULT maximumValue |
| michael@0 | 115 | ( |
| michael@0 | 116 | [out, retval] VARIANT *maximumValue |
| michael@0 | 117 | ); |
| michael@0 | 118 | |
| michael@0 | 119 | /** @brief Returns the minimal value that can be represented by this object. |
| michael@0 | 120 | |
| michael@0 | 121 | The type of the returned value is implementation dependent. It does not have |
| michael@0 | 122 | to be the same type as that returned by method IAccessibleValue::currentValue. |
| michael@0 | 123 | |
| michael@0 | 124 | @param [out] minimumValue |
| michael@0 | 125 | Returns the minimal value in an implementation dependent type. If this object |
| michael@0 | 126 | has no lower bound then an empty object is returned. See the section about |
| michael@0 | 127 | @ref _variants "VARIANTs" for additional information. |
| michael@0 | 128 | @retval S_OK |
| michael@0 | 129 | @retval S_FALSE if there is nothing to return, [out] value is a VARIANT with vt = VT_EMPTY |
| michael@0 | 130 | */ |
| michael@0 | 131 | [propget] HRESULT minimumValue |
| michael@0 | 132 | ( |
| michael@0 | 133 | [out, retval] VARIANT *minimumValue |
| michael@0 | 134 | ); |
| michael@0 | 135 | |
| michael@0 | 136 | }; |
