IAccessibleAction Interface Reference

This interface gives access to actions that can be executed for accessible objects. More...

import "AccessibleAction.idl";

Inheritance diagram for IAccessibleAction:

List of all members.

Public Member Functions
HRESULT	nActions ([out, retval] long *nActions)
	Returns the number of accessible actions available in this object.
HRESULT	doAction ([in] long actionIndex)
	Performs the specified Action on the object.
HRESULT	description ([in] long actionIndex,[out, retval] BSTR *description)
	Returns a description of the specified action of the object.
HRESULT	keyBinding ([in] long actionIndex,[in] long nMaxBinding,[out, size_is(, nMaxBinding), length_is(,*nBinding)] BSTR **keyBinding,[out, retval] long *nBinding)
	Returns an array of BSTRs describing one or more key bindings, if there are any, associated with the specified action.
HRESULT	name ([in] long actionIndex,[out, retval] BSTR *name)
	Returns the non-localized name of specified action.
HRESULT	localizedName ([in] long actionIndex,[out, retval] BSTR *localizedName)
	Returns the localized name of specified action.

---

Detailed Description

This interface gives access to actions that can be executed for accessible objects.

Every accessible object that can be manipulated beyond its methods exported over the accessibility API should support this interface to expose all actions that it can perform. Each action can be performed or queried for a name, description or associated key bindings. Actions are needed more for ATs that assist the mobility impaired. By providing actions directly, the AT can present them to the user without the user having to perform the extra steps to navigate a context menu.

---

Member Function Documentation

HRESULT IAccessibleAction::description (  [in] long  actionIndex, [out, retval] BSTR *  description )

Returns a description of the specified action of the object. Parameters: [in]  actionIndex  This index specifies the action of which to return a description. If it lies outside the valid range an empty string is returned. [out]  description  The returned value is a localized string of the specified action.

HRESULT IAccessibleAction::doAction (  [in] long  actionIndex  )

Performs the specified Action on the object. Parameters: [in]  actionIndex  This index specifies the action to perform. If it lies outside the valid range no action is performed.

HRESULT IAccessibleAction::keyBinding (  [in] long  actionIndex, [in] long  nMaxBinding, [out, size_is(, nMaxBinding), length_is(,*nBinding)] BSTR **  keyBinding, [out, retval] long *  nBinding )

Returns an array of BSTRs describing one or more key bindings, if there are any, associated with the specified action. Note: the client allocates and passes in an array of pointers. The server allocates the BSTRs and passes back one or more pointers to these BSTRs into the array of pointers allocated by the client. The client is responsible for deallocating the BSTRs. Parameters: [in]  actionIndex  This index specifies the action of which to return the key bindings. [in]  nMaxBinding  The maximum number of keybindings requested, i.e. the size of the array allocated to hold the results. [out]  keyBinding  An array of BSTRs, one for each key binding. [out]  nBinding  The actual number of key bindings returned.

HRESULT IAccessibleAction::localizedName (  [in] long  actionIndex, [out, retval] BSTR *  localizedName )

Returns the localized name of specified action. Parameters: [in]  actionIndex  [out]  localizedName

HRESULT IAccessibleAction::nActions (  [out, retval] long *  nActions  )

Returns the number of accessible actions available in this object. If there are more than one, the first one is considered the "default" action of the object. Parameters: [out]  nActions  The returned value of the number of actions is zero if there are no actions.

HRESULT IAccessibleAction::name (  [in] long  actionIndex, [out, retval] BSTR *  name )

Returns the non-localized name of specified action. Parameters: [in]  actionIndex  [out]  name

---

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

• AccessibleAction.idl

---