ReactOS 0.4.16-dev-2491-g3dc6630
IAccessible2_2 Interface Reference

This interface exposes the primary set of information about an IAccessible2 enabled accessible object. More...

Inheritance diagram for IAccessible2_2:
Collaboration diagram for IAccessible2_2:

Properties

VARIANT attribute ([in] BSTR name) [get]
 Returns the attribute value of a specified attribute specific to this object.
 
long accessibleWithCaret ([out] IUnknown accessible) [get]
 Returns the deepest hypertext accessible in the subtree of this object, and the caret offset within it.
 
long relationTargetsOfType ([in] BSTR type,[in] long maxTargets,[out, size_is(, *nTargets)] IUnknown targets) [get]
 Returns relation targets for a specified target type.
 
- Properties inherited from IAccessible2
long nRelations [get]
 Returns the number of accessible relations for this object.
 
IAccessibleRelation relation ([in] long relationIndex) [get]
 Returns one accessible relation for this object.
 
long relations ([in] long maxRelations,[out, size_is(maxRelations), length_is(*nRelations)] IAccessibleRelation relations) [get]
 Returns multiple accessible relations for this object.
 
long groupPosition ([out] long groupLevel,[out] long similarItemsInGroup) [get]
 Returns grouping information.
 
AccessibleStates states [get]
 Returns the bit strip containing any IAccessible2 states.
 
BSTR extendedRole [get]
 Returns the extended role.
 
BSTR localizedExtendedRole [get]
 Returns the localized extended role.
 
long nExtendedStates [get]
 Returns the number of extended states.
 
long extendedStates ([in] long maxExtendedStates,[out, size_is(, maxExtendedStates), length_is(, *nExtendedStates)] BSTR extendedStates) [get]
 Returns the extended states (array of strings).
 
long localizedExtendedStates ([in] long maxLocalizedExtendedStates,[out, size_is(, maxLocalizedExtendedStates), length_is(, *nLocalizedExtendedStates)] BSTR localizedExtendedStates) [get]
 Returns the localized extended states (array of strings).
 
long uniqueID [get]
 Returns the unique ID.
 
HWND windowHandle [get]
 Returns the window handle for the parent window which contains this object.
 
long indexInParent [get]
 Returns the index of this object in its parent object.
 
IA2Locale locale [get]
 Returns the IA2Locale of the accessible object.
 
BSTR attributes [get]
 Returns the attributes specific to this object, such as a cell's formula.
 
- Properties inherited from IAccessible
IDispatch accParent [get]
 
long accChildCount [get]
 
IDispatch accChild ([in] VARIANT varChildID) [get]
 
BSTR accName ([in, optional] VARIANT varID) [get, set]
 
BSTR accValue ([in, optional] VARIANT varID) [get, set]
 
BSTR accDescription ([in, optional] VARIANT varID) [get]
 
VARIANT accRole ([in, optional] VARIANT varID) [get]
 
VARIANT accState ([in, optional] VARIANT varID) [get]
 
BSTR accHelp ([in, optional] VARIANT varID) [get]
 
long accHelpTopic ([out] BSTR helpfile,[in, optional] VARIANT varID) [get]
 
BSTR accKeyboardShortcut ([in, optional] VARIANT varID) [get]
 
VARIANT accFocus [get]
 
VARIANT accSelection [get]
 
BSTR accDefaultAction ([in, optional] VARIANT varID) [get]
 

Additional Inherited Members

- Public Types inherited from IAccessible
typedef IAccessibleLPACCESSIBLE
 
- Public Types inherited from IDispatch
typedef IDispatchLPDISPATCH
 
- Public Types inherited from IUnknown
typedef IUnknownLPUNKNOWN
 
- Public Member Functions inherited from IAccessible2
HRESULT role ([out, retval] long *role)
 Returns the role of an IAccessible2 object.
 
HRESULT scrollTo ([in] enum IA2ScrollType scrollType)
 Makes an object visible on the screen.
 
HRESULT scrollToPoint ([in] enum IA2CoordinateType coordinateType, [in] long x, [in] long y)
 Moves the top left of an object to a specified location.
 
- Public Member Functions inherited from IAccessible
HRESULT accSelect ([in] long flagsSelect, [in, optional] VARIANT varID)
 
HRESULT accLocation ([out] long *left, [out] long *top, [out] long *width, [out] long *height, [in, optional] VARIANT varID)
 
HRESULT accNavigate ([in] long dir, [in, optional] VARIANT varStart, [out, retval] VARIANT *pvarEnd)
 
HRESULT accHitTest ([in] long left, [in] long top, [out, retval] VARIANT *pvarID)
 
HRESULT accDoDefaultAction ([in, optional] VARIANT varID)
 
- Public Member Functions inherited from IDispatch
HRESULT GetTypeInfoCount ([out] UINT *pctinfo)
 
HRESULT GetTypeInfo ([in] UINT iTInfo, [in] LCID lcid, [out] ITypeInfo **ppTInfo)
 
HRESULT GetIDsOfNames ([in] REFIID riid, [in, size_is(cNames)] LPOLESTR *rgszNames, [in] UINT cNames, [in] LCID lcid, [out, size_is(cNames)] DISPID *rgDispId)
 
HRESULT Invoke ([in] DISPID dispIdMember, [in] REFIID riid, [in] LCID lcid, [in] WORD wFlags, [in, out] DISPPARAMS *pDispParams, [out] VARIANT *pVarResult, [out] EXCEPINFO *pExcepInfo, [out] UINT *puArgErr)
 
HRESULT RemoteInvoke ([in] DISPID dispIdMember, [in] REFIID riid, [in] LCID lcid, [in] DWORD dwFlags, [in] DISPPARAMS *pDispParams, [out] VARIANT *pVarResult, [out] EXCEPINFO *pExcepInfo, [out] UINT *pArgErr, [in] UINT cVarRef, [in, size_is(cVarRef)] UINT *rgVarRefIdx, [in, out, size_is(cVarRef)] VARIANTARG *rgVarRef)
 
- Public Member Functions inherited from IUnknown
HRESULT QueryInterface ([in] REFIID riid, [out, iid_is(riid)] void **ppvObject)
 
ULONG AddRef ()
 
ULONG Release ()
 
- Public Attributes inherited from IAccessible
const long DISPID_ACC_PARENT = -5000
 
const long DISPID_ACC_CHILDCOUNT = -5001
 
const long DISPID_ACC_CHILD = -5002
 
const long DISPID_ACC_NAME = -5003
 
const long DISPID_ACC_VALUE = -5004
 
const long DISPID_ACC_DESCRIPTION = -5005
 
const long DISPID_ACC_ROLE = -5006
 
const long DISPID_ACC_STATE = -5007
 
const long DISPID_ACC_HELP = -5008
 
const long DISPID_ACC_HELPTOPIC = -5009
 
const long DISPID_ACC_KEYBOARDSHORTCUT = -5010
 
const long DISPID_ACC_FOCUS = -5011
 
const long DISPID_ACC_SELECTION = -5012
 
const long DISPID_ACC_DEFAULTACTION = -5013
 
const long DISPID_ACC_SELECT = -5014
 
const long DISPID_ACC_LOCATION = -5015
 
const long DISPID_ACC_NAVIGATE = -5016
 
const long DISPID_ACC_HITTEST = -5017
 
const long DISPID_ACC_DODEFAULTACTION = -5018
 
- Public Attributes inherited from IDispatch
const DISPID DISPID_UNKNOWN = -1
 
const DISPID DISPID_VALUE = 0
 
const DISPID DISPID_PROPERTYPUT = -3
 
const DISPID DISPID_NEWENUM = -4
 
const DISPID DISPID_EVALUATE = -5
 
const DISPID DISPID_CONSTRUCTOR = -6
 
const DISPID DISPID_DESTRUCTOR = -7
 
const DISPID DISPID_COLLECT = -8
 

Detailed Description

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 Changing between Accessible Interfaces for special considerations related to use of the MSAA IAccessible interface and the set of IAccessible2 interfaces.

Definition at line 1963 of file iaccessible2.idl.

Property Documentation

◆ accessibleWithCaret

long IAccessible2_2::accessibleWithCaret([out] IUnknown accessible)
get

Returns the deepest hypertext accessible in the subtree of this object, and the caret offset within it.

Parameters
[out]accessible
[out]caretOffset
Return values
S_OK
S_FALSEreturned if there is no caret in any of the objects in the subtree, [out] accessible is NULL and [out] caretOffset is -1.

◆ attribute

VARIANT IAccessible2_2::attribute([in] BSTR name)
get

Returns the attribute value of a specified attribute specific to this object.

Parameters
[in]name
[out]attribute
Return values
S_OK
S_FALSEreturned if there is nothing to return, [out] value is NULL.
E_INVALIDARGif 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 Object Attributes specification for more information.

◆ relationTargetsOfType

long IAccessible2_2::relationTargetsOfType([in] BSTR type, [in] long maxTargets, [out, size_is(,*nTargets)] IUnknown targets)
get

Returns relation targets for a specified target type.

Parameters
[in]typeThe requested relation type.
[in]maxTargetsThe number of targets requested. 0 indicates that all targets should be returned.
[out]targetsThis array is allocated by the server. The client must free it with CoTaskMemFree.
[out]nTargetsThe number of targets returned; the size of the returned array.
Return values
S_OK
S_FALSEif there are no targets, [out] values are NULL and 0 respectively.
E_INVALIDARGif bad [in] passed.

The documentation for this interface was generated from the following file: