other-licenses/ia2/AccessibleRelation.idl

Tue, 06 Jan 2015 21:39:09 +0100

author
Michael Schloh von Bennewitz <michael@schloh.com>
date
Tue, 06 Jan 2015 21:39:09 +0100
branch
TOR_BUG_9701
changeset 8
97036ab72558
permissions
-rw-r--r--

Conditionally force memory storage according to privacy.thirdparty.isolate;
This solves Tor bug #9701, complying with disk avoidance documented in
https://www.torproject.org/projects/torbrowser/design/#disk-avoidance.

michael@0 1 /*************************************************************************
michael@0 2 *
michael@0 3 * File Name (AccessibleRelation.idl)
michael@0 4 *
michael@0 5 * IAccessible2 IDL Specification
michael@0 6 *
michael@0 7 * Copyright (c) 2007, 2013 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 /** @defgroup grpRelations Relations
michael@0 59 Use the following constants to compare against the BSTRs returned by
michael@0 60 IAccessibleRelation::relationType.
michael@0 61 */
michael@0 62 ///@{
michael@0 63
michael@0 64 /** The target object is the containing application object. */
michael@0 65 const WCHAR *const IA2_RELATION_CONTAINING_APPLICATION = L"containingApplication";
michael@0 66
michael@0 67 /** The target object is the containing document object. The target object implements
michael@0 68 the IAccessibleDocument interface.
michael@0 69 */
michael@0 70 const WCHAR *const IA2_RELATION_CONTAINING_DOCUMENT = L"containingDocument";
michael@0 71
michael@0 72 /** The target object is the containing tab pane object. */
michael@0 73 const WCHAR *const IA2_RELATION_CONTAINING_TAB_PANE = L"containingTabPane";
michael@0 74
michael@0 75 /** The target object is the containing window object. */
michael@0 76 const WCHAR *const IA2_RELATION_CONTAINING_WINDOW = L"containingWindow";
michael@0 77
michael@0 78 /** Some attribute of this object is affected by a target object. */
michael@0 79 const WCHAR *const IA2_RELATION_CONTROLLED_BY = L"controlledBy";
michael@0 80
michael@0 81 /** This object is interactive and controls some attribute of a target object. */
michael@0 82 const WCHAR *const IA2_RELATION_CONTROLLER_FOR = L"controllerFor";
michael@0 83
michael@0 84 /** This object is described by the target object. */
michael@0 85 const WCHAR *const IA2_RELATION_DESCRIBED_BY = L"describedBy";
michael@0 86
michael@0 87 /** This object is describes the target object. */
michael@0 88 const WCHAR *const IA2_RELATION_DESCRIPTION_FOR = L"descriptionFor";
michael@0 89
michael@0 90 /** This object is embedded by a target object. */
michael@0 91 const WCHAR *const IA2_RELATION_EMBEDDED_BY = L"embeddedBy";
michael@0 92
michael@0 93 /** This object embeds a target object. This relation can be used on the
michael@0 94 OBJID_CLIENT accessible for a top level window to show where the content
michael@0 95 areas are.
michael@0 96 */
michael@0 97 const WCHAR *const IA2_RELATION_EMBEDS = L"embeds";
michael@0 98
michael@0 99 /** Content flows to this object from a target object.
michael@0 100 This relation and IA2_RELATION_FLOWS_TO are useful to tie text and non-text
michael@0 101 objects together in order to allow assistive technology to follow the
michael@0 102 intended reading order.
michael@0 103 */
michael@0 104 const WCHAR *const IA2_RELATION_FLOWS_FROM = L"flowsFrom";
michael@0 105
michael@0 106 /** Content flows from this object to a target object. */
michael@0 107 const WCHAR *const IA2_RELATION_FLOWS_TO = L"flowsTo";
michael@0 108
michael@0 109 /** This object is label for a target object. */
michael@0 110 const WCHAR *const IA2_RELATION_LABEL_FOR = L"labelFor";
michael@0 111
michael@0 112 /** This object is labelled by a target object. Note that the double L spelling
michael@0 113 which follows is preferred. Please use it instead. This single L version may
michael@0 114 be removed in a later version.
michael@0 115 */
michael@0 116 const WCHAR *const IA2_RELATION_LABELED_BY = L"labelledBy";
michael@0 117
michael@0 118 /** This object is labelled by a target object. */
michael@0 119 const WCHAR *const IA2_RELATION_LABELLED_BY = L"labelledBy";
michael@0 120
michael@0 121 /** This object is a member of a group of one or more objects. When
michael@0 122 there is more than one object in the group each member may have one and the
michael@0 123 same target, e.g. a grouping object. It is also possible that each member has
michael@0 124 multiple additional targets, e.g. one for every other member in the group.
michael@0 125 */
michael@0 126 const WCHAR *const IA2_RELATION_MEMBER_OF = L"memberOf";
michael@0 127
michael@0 128 /** The target object is the next object in the tab order. */
michael@0 129 const WCHAR *const IA2_RELATION_NEXT_TABBABLE = L"nextTabbable";
michael@0 130
michael@0 131 /** This object is a logical child of a target object. This relation is the reciprocal
michael@0 132 of the IA2_RELATION_NODE_PARENT_OF relation. In some cases an application's accessible
michael@0 133 tree is such that objects can be in a logical parent-child relationship which is
michael@0 134 different from the hierarchy of the accessible tree. */
michael@0 135 const WCHAR *const IA2_RELATION_NODE_CHILD_OF = L"nodeChildOf";
michael@0 136
michael@0 137 /** This object is a logical parent of a target object. This relation is the reciprocal
michael@0 138 of the IA2_RELATION_NODE_CHILD_OF relation. In some cases an application's accessible
michael@0 139 tree is such that objects can be in a logical parent-child relationship which is
michael@0 140 different from the hierarchy of the accessible tree. */
michael@0 141 const WCHAR *const IA2_RELATION_NODE_PARENT_OF = L"nodeParentOf";
michael@0 142
michael@0 143 /** This object is a parent window of the target object. */
michael@0 144 const WCHAR *const IA2_RELATION_PARENT_WINDOW_OF = L"parentWindowOf";
michael@0 145
michael@0 146 /** This object is a transient component related to the target object.
michael@0 147 When this object is activated the target object doesn't lose focus.
michael@0 148 */
michael@0 149 const WCHAR *const IA2_RELATION_POPUP_FOR = L"popupFor";
michael@0 150
michael@0 151 /** The target object is the previous object in the tab order. */
michael@0 152 const WCHAR *const IA2_RELATION_PREVIOUS_TABBABLE = L"previousTabbable";
michael@0 153
michael@0 154 /** This object is a sub window of a target object. */
michael@0 155 const WCHAR *const IA2_RELATION_SUBWINDOW_OF = L"subwindowOf";
michael@0 156
michael@0 157 ///@}
michael@0 158
michael@0 159 /** This interface gives access to an object's set of relations.
michael@0 160 */
michael@0 161 [object, uuid(7CDF86EE-C3DA-496a-BDA4-281B336E1FDC)]
michael@0 162 interface IAccessibleRelation : IUnknown
michael@0 163 {
michael@0 164 /** @brief Returns the type of the relation.
michael@0 165 @param [out] relationType
michael@0 166 The strings returned are defined @ref grpRelations "in this section of the documentation".
michael@0 167 @retval S_OK
michael@0 168 */
michael@0 169 [propget] HRESULT relationType
michael@0 170 (
michael@0 171 [out, retval] BSTR *relationType
michael@0 172 );
michael@0 173
michael@0 174 /** @brief Returns a localized version of the relation type.
michael@0 175 @param [out] localizedRelationType
michael@0 176 @retval S_OK
michael@0 177 */
michael@0 178 [propget] HRESULT localizedRelationType
michael@0 179 (
michael@0 180 [out, retval] BSTR *localizedRelationType
michael@0 181 );
michael@0 182
michael@0 183 /** @brief Returns the number of targets for this relation.
michael@0 184 @param [out] nTargets
michael@0 185 @retval S_OK
michael@0 186 */
michael@0 187 [propget] HRESULT nTargets
michael@0 188 (
michael@0 189 [out, retval] long *nTargets
michael@0 190 );
michael@0 191
michael@0 192 /** @brief Returns one accessible relation target.
michael@0 193 @param [in] targetIndex
michael@0 194 0 based index
michael@0 195 @param [out] target
michael@0 196 @retval S_OK
michael@0 197 @retval E_INVALIDARG if bad [in] passed
michael@0 198 @note Use QueryInterface to get IAccessible2.
michael@0 199 */
michael@0 200 [propget] HRESULT target
michael@0 201 (
michael@0 202 [in] long targetIndex,
michael@0 203 [out, retval] IUnknown **target
michael@0 204 );
michael@0 205
michael@0 206 /** @brief Returns multiple accessible relation targets
michael@0 207 @param [in] maxTargets
michael@0 208 maximum size of the array allocated by the client
michael@0 209 @param [out] targets
michael@0 210 The array of target objects. Note that this array is to be allocated by the
michael@0 211 client and freed when no longer needed. Refer to @ref _arrayConsideration
michael@0 212 "Special Consideration when using Arrays" for more details. You will need to use
michael@0 213 QueryInterface on the IUnknown to get the IAccessible2.
michael@0 214 @param [out] nTargets
michael@0 215 actual number of targets in the returned array (not more than maxTargets)
michael@0 216 @retval S_OK
michael@0 217 @retval E_INVALIDARG if bad [in] passed, e.g. a negative value
michael@0 218 */
michael@0 219 [propget] HRESULT targets
michael@0 220 (
michael@0 221 [in] long maxTargets,
michael@0 222 [out, size_is(maxTargets), length_is(*nTargets)]
michael@0 223 IUnknown **targets,
michael@0 224 [out, retval] long *nTargets
michael@0 225 );
michael@0 226
michael@0 227 }

mercurial