other-licenses/ia2/AccessibleStates.idl@6474c204b198 (annotated)
other-licenses/ia2/AccessibleStates.idl
Wed, 31 Dec 2014 06:09:35 +0100
- author
- Michael Schloh von Bennewitz <michael@schloh.com>
- date
- Wed, 31 Dec 2014 06:09:35 +0100
- changeset 0
- 6474c204b198
- permissions
- -rw-r--r--
Cloned upstream origin tor-browser at tor-browser-31.3.0esr-4.5-1-build1
revision ID fc1c9ff7c1b2defdbc039f12214767608f46423f for hacking purpose.
| michael@0 | 1 | /************************************************************************* |
| michael@0 | 2 | * |
| michael@0 | 3 | * File Name (AccessibleStates.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 | |
| michael@0 | 56 | typedef long AccessibleStates; |
| michael@0 | 57 | |
| michael@0 | 58 | /** %IAccessible2 specific state bit constants |
| michael@0 | 59 | |
| michael@0 | 60 | This enum defines the state bits returned by IAccessible2::states. The |
| michael@0 | 61 | %IAccessible2 state bits are in addition to those returned by MSAA. |
| michael@0 | 62 | */ |
| michael@0 | 63 | enum IA2States { |
| michael@0 | 64 | |
| michael@0 | 65 | /** Indicates a window is currently the active window, or is an active subelement |
| michael@0 | 66 | within a container or table. |
| michael@0 | 67 | |
| michael@0 | 68 | This state can be used to indicate the current active item in a container, even |
| michael@0 | 69 | if the container itself is not currently active. In other words this would indicate |
| michael@0 | 70 | the item that will get focus if you tab to the container. |
| michael@0 | 71 | |
| michael@0 | 72 | This information is important for knowing what to report for trees and potentially |
| michael@0 | 73 | other containers in a virtual buffer. |
| michael@0 | 74 | |
| michael@0 | 75 | Also, see ::IA2_STATE_MANAGES_DESCENDANTS for more information. |
| michael@0 | 76 | */ |
| michael@0 | 77 | IA2_STATE_ACTIVE = 0x1, |
| michael@0 | 78 | |
| michael@0 | 79 | /** Indicates that the object is armed. |
| michael@0 | 80 | |
| michael@0 | 81 | Used to indicate that the control is "pressed" and will be invoked when the |
| michael@0 | 82 | actuator, e.g. a mouse button, is "released". An AT which either monitors the |
| michael@0 | 83 | mouse or synthesizes mouse events might need to know that, and possibly a talking |
| michael@0 | 84 | interface would even let the user know about it. It could also potentially be |
| michael@0 | 85 | useful to on screen keyboards or test tools since the information does indicate |
| michael@0 | 86 | something about the state of the interface, for example, code operating asynchronously |
| michael@0 | 87 | might need to wait for the armed state to change before doing something else. |
| michael@0 | 88 | |
| michael@0 | 89 | */ |
| michael@0 | 90 | IA2_STATE_ARMED = 0x2, |
| michael@0 | 91 | |
| michael@0 | 92 | /** Indicates the user interface object corresponding to this object no longer exists. */ |
| michael@0 | 93 | IA2_STATE_DEFUNCT = 0x4, |
| michael@0 | 94 | |
| michael@0 | 95 | /** An object with this state has a caret and implements the IAccessibleText interface. |
| michael@0 | 96 | |
| michael@0 | 97 | Such fields may be read-only, so STATE_SYSTEM_READONLY is valid in combination |
| michael@0 | 98 | with IA2_STATE_EDITABLE. |
| michael@0 | 99 | |
| michael@0 | 100 | */ |
| michael@0 | 101 | IA2_STATE_EDITABLE = 0x8, |
| michael@0 | 102 | |
| michael@0 | 103 | /** Indicates the orientation of this object is horizontal. */ |
| michael@0 | 104 | IA2_STATE_HORIZONTAL = 0x10, |
| michael@0 | 105 | |
| michael@0 | 106 | /** Indicates this object is minimized and is represented only by an icon. */ |
| michael@0 | 107 | IA2_STATE_ICONIFIED = 0x20, |
| michael@0 | 108 | |
| michael@0 | 109 | /** Indicates an input validation failure. */ |
| michael@0 | 110 | IA2_STATE_INVALID_ENTRY = 0x40, |
| michael@0 | 111 | |
| michael@0 | 112 | /** Indicates that this object manages its children. |
| michael@0 | 113 | |
| michael@0 | 114 | Note: Due to the fact that MSAA's WinEvents don't allow the active child index |
| michael@0 | 115 | to be passed on the IA2_EVENT_ACTIVE_DESCENDANT_CHANGED event, the manages |
| michael@0 | 116 | descendants scheme can't be used. Instead the active child object has to fire |
| michael@0 | 117 | MSAA's EVENT_OBJECT_FOCUS. In a future release a new event mechanism may be |
| michael@0 | 118 | added to provide for event specific data to be passed with the event. At that |
| michael@0 | 119 | time the IA2_EVENT_ACTIVE_DECENDENT_CHANGED event and |
| michael@0 | 120 | IA2_STATE_MANAGES_DESCENDANTS state would be useful. |
| michael@0 | 121 | */ |
| michael@0 | 122 | IA2_STATE_MANAGES_DESCENDANTS = 0x80, |
| michael@0 | 123 | |
| michael@0 | 124 | /** Indicates that an object is modal. |
| michael@0 | 125 | |
| michael@0 | 126 | Modal objects have the behavior that something must be done with the object |
| michael@0 | 127 | before the user can interact with an object in a different window. |
| michael@0 | 128 | */ |
| michael@0 | 129 | IA2_STATE_MODAL = 0x100, |
| michael@0 | 130 | |
| michael@0 | 131 | /** Indicates this text object can contain multiple lines of text. */ |
| michael@0 | 132 | IA2_STATE_MULTI_LINE = 0x200, |
| michael@0 | 133 | |
| michael@0 | 134 | /** Indicates this object paints every pixel within its rectangular region. */ |
| michael@0 | 135 | IA2_STATE_OPAQUE = 0x400, |
| michael@0 | 136 | |
| michael@0 | 137 | /** Indicates that user interaction is required. |
| michael@0 | 138 | |
| michael@0 | 139 | An example of when this state is used is when a field in a form must be filled |
| michael@0 | 140 | before a form can be processed. |
| michael@0 | 141 | */ |
| michael@0 | 142 | IA2_STATE_REQUIRED = 0x800, |
| michael@0 | 143 | |
| michael@0 | 144 | /** Indicates an object which supports text selection. |
| michael@0 | 145 | |
| michael@0 | 146 | Note: This is different than MSAA STATE_SYSTEM_SELECTABLE. |
| michael@0 | 147 | */ |
| michael@0 | 148 | IA2_STATE_SELECTABLE_TEXT = 0x1000, |
| michael@0 | 149 | |
| michael@0 | 150 | /** Indicates that this text object can contain only a single line of text. */ |
| michael@0 | 151 | IA2_STATE_SINGLE_LINE = 0x2000, |
| michael@0 | 152 | |
| michael@0 | 153 | /** Indicates that the accessible object is stale. |
| michael@0 | 154 | |
| michael@0 | 155 | This state is used when the accessible object no longer accurately |
| michael@0 | 156 | represents the state of the object which it is representing such as when an |
| michael@0 | 157 | object is transient or when an object has been or is in the process of being |
| michael@0 | 158 | destroyed or when the object's index in its parent has changed. |
| michael@0 | 159 | */ |
| michael@0 | 160 | IA2_STATE_STALE = 0x4000, |
| michael@0 | 161 | |
| michael@0 | 162 | /** Indicates that the object implements autocompletion. |
| michael@0 | 163 | |
| michael@0 | 164 | This state indicates that a text control will respond to the input of |
| michael@0 | 165 | one ore more characters and cause a sub-item to become selected. The |
| michael@0 | 166 | selection may also result in events fired on the parent object. |
| michael@0 | 167 | */ |
| michael@0 | 168 | IA2_STATE_SUPPORTS_AUTOCOMPLETION = 0x8000, |
| michael@0 | 169 | |
| michael@0 | 170 | /** Indicates this object is transient. |
| michael@0 | 171 | |
| michael@0 | 172 | An object has this state when its parent object has the state ::IA2_STATE_MANAGES_DESCENDANTS. |
| michael@0 | 173 | For example, a list item object may be managed by its parent list object and may only |
| michael@0 | 174 | exist as long as the object is actually rendered. Similarly a table cell's accessible |
| michael@0 | 175 | object may exist only while the cell has focus. However, from the perspective of an |
| michael@0 | 176 | assistive technology a transient object behaves like a non-transient object. As a |
| michael@0 | 177 | result it is likely that this state is not of use to an assistive technology, but it |
| michael@0 | 178 | is provided in case an assistive technology determines that knowledge of the transient |
| michael@0 | 179 | nature of the object is useful and also for harmony with the Linux accessibility API. |
| michael@0 | 180 | |
| michael@0 | 181 | Also, see ::IA2_STATE_MANAGES_DESCENDANTS for more information. |
| michael@0 | 182 | */ |
| michael@0 | 183 | IA2_STATE_TRANSIENT = 0x10000, |
| michael@0 | 184 | |
| michael@0 | 185 | /** Indicates the orientation of this object is vertical. */ |
| michael@0 | 186 | IA2_STATE_VERTICAL = 0x20000, |
| michael@0 | 187 | |
| michael@0 | 188 | /** Indicates this object is checkable. |
| michael@0 | 189 | |
| michael@0 | 190 | The standard checkable objects are check boxes, radio buttons, check box menu |
| michael@0 | 191 | items, radio menu items, and toggle buttons. Since assistive technology will |
| michael@0 | 192 | determine that these objects are checkable via the object's role the checkable |
| michael@0 | 193 | state is not required. However, this state is necessary in those cases where |
| michael@0 | 194 | an object has a role which is not one of the previously mentioned roles. An |
| michael@0 | 195 | example is a table cell which indicates whether or not an email has an attachment, |
| michael@0 | 196 | whether or not an mail is considered spam, and whether or not an email has been read. |
| michael@0 | 197 | */ |
| michael@0 | 198 | IA2_STATE_CHECKABLE = 0x40000, |
| michael@0 | 199 | |
| michael@0 | 200 | /** Indicates this object is pinned. |
| michael@0 | 201 | |
| michael@0 | 202 | This state indicates that an object is fixed at a certain location. One example |
| michael@0 | 203 | is a browser tab that when pinned cannot be moved until unpinned. Another example |
| michael@0 | 204 | is a movable or floating object that when pinned remains in its pinned location |
| michael@0 | 205 | until being unpinned. |
| michael@0 | 206 | */ |
| michael@0 | 207 | IA2_STATE_PINNED = 0x80000 |
| michael@0 | 208 | |
| michael@0 | 209 | }; |
