Skip to content

Commit

Permalink
Updates for 1.3pre from 20120917.
Browse files Browse the repository at this point in the history
  • Loading branch information
jcsteh committed Sep 25, 2012
1 parent 51ad09d commit a1dd84c
Show file tree
Hide file tree
Showing 19 changed files with 826 additions and 249 deletions.
84 changes: 64 additions & 20 deletions api/Accessible2.idl
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
*
* IAccessible2 IDL Specification
*
* Copyright (c) 2007, 2010 Linux Foundation
* Copyright (c) 2007, 2012 Linux Foundation
* Copyright (c) 2006 IBM Corporation
* Copyright (c) 2000, 2006 Sun Microsystems, Inc.
* All rights reserved.
Expand Down Expand Up @@ -54,19 +54,22 @@
/** @mainpage

@section _interfaces Interfaces
IAccessible2\n
IAccessible2_2\n
IAccessibleAction\n
IAccessibleApplication\n
IAccessibleComponent\n
IAccessibleHypertext\n
IAccessibleDocument\n
IAccessibleEditableText\n
IAccessibleHypertext [Deprecated]\n
IAccessibleHypertext2\n
IAccessibleHyperlink\n
IAccessibleImage\n
IAccessibleRelation\n
IAccessibleRelation [Deprecated]\n
IAccessibleTable [Deprecated]\n
IAccessibleTable2\n
IAccessibleTableCell\n
IAccessibleText\n
IAccessibleEditableText\n
IAccessibleText [Deprecated]\n
IAccessibleText2\n
IAccessibleValue

@section _structs Structs
Expand Down Expand Up @@ -209,9 +212,9 @@
CoTaskMemAlloc and any BSTRs with SysAllocString. The client must use CoTaskMemFree
to free the array and any BSTRs must be freed with SysFreeString.

Also, the IDL for those six methods includes an extraneous [in] parameter for the
caller to specify the max size of the array. This parameter will be ignored by
the COM server.
Also, the IDL for IAccessible2::extendedStates, IAccessible2::localizedExtendedStates,
and IAccessibleAction::keyBinding includes an extraneous [in] parameter for the caller
to specify the max size of the array. This parameter will be ignored by the COM server.

@section _indexes Zero and One Based Indexes
Unless otherwise specified all offsets and indexes are 0 based.
Expand Down Expand Up @@ -372,6 +375,7 @@ interface IAccessible2 : IAccessible
/** @brief Returns the number of accessible relations for this object.
@param [out] nRelations
@retval S_OK
@deprecated
*/
[propget] HRESULT nRelations
(
Expand All @@ -384,6 +388,7 @@ interface IAccessible2 : IAccessible
@param [out] relation
@retval S_OK
@retval E_INVALIDARG if bad [in] passed
@deprecated
*/
[propget] HRESULT relation
(
Expand All @@ -402,6 +407,7 @@ interface IAccessible2 : IAccessible
actual number of relations in the returned array (not more than maxRelations)
@retval S_OK
@retval S_FALSE if there are no relations, nRelations is set to 0
@deprecated
*/
[propget] HRESULT relations
(
Expand Down Expand Up @@ -543,9 +549,6 @@ interface IAccessible2 : IAccessible
An extended state is a state which is dynamically generated by the application.
It is not predefined by the %IAccessible2 specification.

@param [in] maxExtendedStates
This parameter is ignored. Refer to @ref _arrayConsideration
"Special Consideration when using Arrays" for more details.
@param [out] extendedStates
This array is allocated by the server. Free it with CoTaskMemFree.
@param [out] nExtendedStates
Expand All @@ -555,15 +558,11 @@ interface IAccessible2 : IAccessible
*/
[propget] HRESULT extendedStates
(
[in] long maxExtendedStates,
[out, size_is(,maxExtendedStates), length_is(,*nExtendedStates)] BSTR **extendedStates,
[out, size_is(,*nExtendedStates)] BSTR **extendedStates,
[out, retval] long *nExtendedStates
);

/** @brief Returns the localized extended states (array of strings).
@param [in] maxLocalizedExtendedStates
This parameter is ignored. Refer to @ref _arrayConsideration
"Special Consideration when using Arrays" for more details.
@param [out] localizedExtendedStates
This array is allocated by the server. Free it with CoTaskMemFree.
@param [out] nLocalizedExtendedStates
Expand All @@ -573,8 +572,7 @@ interface IAccessible2 : IAccessible
*/
[propget] HRESULT localizedExtendedStates
(
[in] long maxLocalizedExtendedStates,
[out, size_is(,maxLocalizedExtendedStates), length_is(,*nLocalizedExtendedStates)] BSTR **localizedExtendedStates,
[out, size_is(,*nLocalizedExtendedStates)] BSTR **localizedExtendedStates,
[out, retval] long *nLocalizedExtendedStates
);

Expand Down Expand Up @@ -665,7 +663,7 @@ interface IAccessible2 : IAccessible
[out, retval] IA2Locale *locale
);

/** @brief Returns the attributes specific to this %IAccessible2 object, such as a cell's formula.
/** @brief Returns the attributes specific to this object, such as a cell's formula.
@param [out] attributes
@retval S_OK
@retval S_FALSE returned if there is nothing to return, [out] value is NULL
Expand All @@ -675,5 +673,51 @@ interface IAccessible2 : IAccessible
[out, retval] BSTR *attributes
);

/** @brief Returns the attribute value of a specified attribute specific to this object.
@param [in] name
@param [out] attribute
@retval S_OK
@retval S_FALSE returned if there is nothing to return, [out] value is NULL.
@retval E_INVALIDARG if bad [in] passed.
*/
[propget] HRESULT attribute
(
[in] BSTR name,
[out, retval] BSTR *attribute
);

/** @brief Returns the hypertext accessible in the subtree of this object, and the caret offset within it.
@param [out] accessible
@param [out] caretOffset
@retval S_OK
@retval S_FALSE returned if there is no caret in any of the objects in the subtree, [out] accessible is NULL and [out] caretOffset is -1.
*/
[propget] HRESULT accessibleWithCaret
(
[out] IUnknown **accessible,
[out, retval] long *caretOffset
);

/** @brief Returns relation targets for a specified target type.
@param [in] type
The requested relation type.
@param [in] maxTargets
The number of targets requested. 0 indicates that all targets should be returned.
@param [out] targets
This array is allocated by the server. Free it with CoTaskMemFree.
@param [out] nTargets
The number of targets returned; the size of the returned array.
@retval S_OK
@retval S_FALSE if there are no targets, [out] values are NULL and 0 respectively.
@retval E_INVALIDARG if bad [in] passed.
*/
[propget] HRESULT relationTargetsOfType
(
[in] BSTR type,
[in] long maxTargets,
[out, size_is(,*nTargets)] IUnknown ***targets,
[out, retval] long *nTargets
);

}

123 changes: 123 additions & 0 deletions api/Accessible2_2.idl
Original file line number Diff line number Diff line change
@@ -0,0 +1,123 @@
/*************************************************************************
*
* File Name (Accessible2_2.idl)
*
* IAccessible2 IDL Specification
*
* Copyright (c) 2007, 2012 Linux Foundation
* Copyright (c) 2006 IBM Corporation
* Copyright (c) 2000, 2006 Sun Microsystems, Inc.
* All rights reserved.
*
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above
* copyright notice, this list of conditions and the following
* disclaimer in the documentation and/or other materials
* provided with the distribution.
*
* 3. Neither the name of the Linux Foundation nor the names of its
* contributors may be used to endorse or promote products
* derived from this software without specific prior written
* permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
* CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
* INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
* MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
* OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
* EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
* This BSD License conforms to the Open Source Initiative "Simplified
* BSD License" as published at:
* http://www.opensource.org/licenses/bsd-license.php
*
* IAccessible2 is a trademark of the Linux Foundation. The IAccessible2
* mark may be used in accordance with the Linux Foundation Trademark
* Policy to indicate compliance with the IAccessible2 specification.
*
************************************************************************/

import "objidl.idl";
import "oaidl.idl";
import "oleacc.idl";
import "Accessible2.idl";

/** @brief This interface exposes the primary set of information about an
IAccessible2 enabled accessible object.

This interface must always be provided for objects that support some
portion of the collection of the %IAccessible2 interfaces.

Please refer to @ref _changingInterfaces "Changing between Accessible Interfaces"
for special considerations related to use of the MSAA IAccessible interface and
the set of %IAccessible2 interfaces.
*/
[object, uuid(6C9430E9-299D-4E6F-BD01-A82A1E88D3FF)]
interface IAccessible2_2 : IAccessible2
{
/** @brief Returns the attribute value of a specified attribute specific to this object.
@param [in] name
@param [out] attribute
@retval S_OK
@retval S_FALSE returned if there is nothing to return, [out] value is NULL.
@retval E_INVALIDARG if bad [in] passed.
@note The output value is a VARIANT. Typically it will be a VT_BSTR, but there
are some cases where it will be a VT_I4 or VT_BOOL. Refer to the <a href=
"http://www.linuxfoundation.org/collaborate/workgroups/accessibility/iaccessible2/objectattributesIAccessible2">
Object Attributes specification</a> for more information.
*/
[propget] HRESULT attribute
(
[in] BSTR name,
[out, retval] VARIANT *attribute
);

/** @brief Returns the hypertext accessible in the subtree of this object, and the caret offset within it.
@param [out] accessible
@param [out] caretOffset
@retval S_OK
@retval S_FALSE returned if there is no caret in any of the objects in the subtree, [out] accessible is NULL and [out] caretOffset is -1.
*/
[propget] HRESULT accessibleWithCaret
(
[out] IUnknown **accessible,
[out, retval] long *caretOffset
);

/** @brief Returns relation targets for a specified target type.
@param [in] type
The requested relation type.
@param [in] maxTargets
The number of targets requested. 0 indicates that all targets should be returned.
@param [out] targets
This array is allocated by the server. Free it with CoTaskMemFree.
@param [out] nTargets
The number of targets returned; the size of the returned array.
@retval S_OK
@retval S_FALSE if there are no targets, [out] values are NULL and 0 respectively.
@retval E_INVALIDARG if bad [in] passed.
*/
[propget] HRESULT relationTargetsOfType
(
[in] BSTR type,
[in] long maxTargets,
[out, size_is(,*nTargets)] IUnknown ***targets,
[out, retval] long *nTargets
);

}

77 changes: 77 additions & 0 deletions api/AccessibleDocument.idl
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
/*************************************************************************
*
* File Name (AccessibleDocument.idl)
*
* IAccessible2 IDL Specification
*
* Copyright (c) 2012 Linux Foundation
* All rights reserved.
*
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above
* copyright notice, this list of conditions and the following
* disclaimer in the documentation and/or other materials
* provided with the distribution.
*
* 3. Neither the name of the Linux Foundation nor the names of its
* contributors may be used to endorse or promote products
* derived from this software without specific prior written
* permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
* CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
* INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
* MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
* OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
* EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
* This BSD License conforms to the Open Source Initiative "Simplified
* BSD License" as published at:
* http://www.opensource.org/licenses/bsd-license.php
*
* IAccessible2 is a trademark of the Linux Foundation. The IAccessible2
* mark may be used in accordance with the Linux Foundation Trademark
* Policy to indicate compliance with the IAccessible2 specification.
*
************************************************************************/

import "objidl.idl";
import "oaidl.idl";
import "oleacc.idl";

/** @brief This interface represents documents.

This interface is used for a representation of documents.
*/
[object, uuid(C48C7FCF-4AB5-4056-AFA6-902D6E1D1149)]
interface IAccessibleDocument : IUnknown
{
/** @brief Returns the most recently used anchor target within an HTML document.

Anchor targets are those which has been defined with the <a> tag. An HTML page's
most recently targeted in-page anchor is returned.

@param [out] accessible
@retval S_OK
@retval S_FALSE if there are no existing valid anchor targets, [out] value is NULL.
*/
[propget] HRESULT anchorTarget
(
[out, retval] IUnknown **accessible
);

}
Loading

0 comments on commit a1dd84c

Please sign in to comment.