Previous
Contents
Index
Next
| Package com.ms.com |
Previous |
Contents |
Index |
Next |
public interface IAccessible extends IUnknown {
// Fields
public static final com.ms.com._Guid iid = new com.ms.com._Guid((int)0x618736e0, (short)0x3c3d, (short)0x11cf, (byte)0x81, (byte)0xc, (byte)0x0, (byte)0xaa, (byte)0x0, (byte)0x38, (byte)0x9b, (byte)0x71);
// Methods
public Object getAccParent();
public int getAccChildCount();
public Object getAccChild(Variant varChild);
public String getAccName(Variant varChild);
public String getAccValue(Variant varChild);
public String getAccDescription(Variant varChild);
public Variant getAccRole(Variant varChild);
public Variant getAccState(Variant varChild);
public String getAccHelp(Variant varChild);
public String getAccKeyboardShortcut(Variant varChild);
public Variant getAccFocus();
public String getAccDefaultAction(Variant varChild);
public void accSelect(int flagsSelect, Variant varChild);
public void accLocation(int[] pxLeft, int[] pyTop, int[] pcxWidth, int[] pcyHeight, Variant varChild);
public Variant accNavigate(int navDir, Variant varStart);
public Variant accHitTest(int xLeft, int yTop);
public void accDoDefaultAction(Variant varChild);
public void setAccName(Variant varChild, String pszName);
public void setAccValue(Variant varChild, String pszValue);
}
The IAccessible interface provides methods that enable clients to request selection and focus information, perform hit tests, and navigate using object and child identifiers.
Accessible objects maintain pieces of information (that is, properties) that help describe the object's appearance, nature, and purpose. The IAccessible interface extends methods that enable a client application to retrieve these properties. Using the information that these properties provide, an accessibility aid can determine useful information and convey it as needed.
public void accDoDefaultAction(Variant varChild);Performs the object's default action.
Return Value:
No return value.
Parameter Description varChild A Variant child.
public Variant accHitTest(int xLeft, int yTop);Retrieves a child object at a given point on the screen.
Return Value:
A Variant class.
Parameter Description xLeft The x coordinate of the screen point to be hit-tested. yTop The y coordinate of the screen point to be hit-tested.
public void accLocation(int[] pxLeft, int[] pyTop, int[] pcxWidth, int[] pcyHeight, Variant varChild);Retrieves an Active Accessibility object's screen location and its child element.
Return Value:
No return value.
Parameter Description pxLeft The x coordinate of the object's screen location. pyTop The y coordinate of the object's screen location. pcxWidth The width, in pixels, of the object. pcyHeight The height, in pixels, of the object. varChild The Variant child contained within the object.
public Variant accNavigate(int navDir, Variant varStart);Retrieves the object navigated to in the given direction.
Return Value:
Returns the Variant object navigated to.
Parameter Description navDir The navigation code. varStart The Variant object navigated from.
public void accSelect(int flagsSelect, Variant varChild);Changes focus and selection according to the selection flags.
Return Value:
No return value.
Parameter Description flagsSelect The selection flags. varChild The Variant child that is selected.
public Object getAccChild(Variant varChild);Retrieves the child at the specified one-based index.
Return Value:
Returns the requested child object.
Parameter Description varChild The Variant that contains the index.
public int getAccChildCount();Retrieves the number of components in the parent container.
Return Value:
Returns the number of components in the parent container.
public String getAccDefaultAction(Variant varChild);Performs the default action for the varChild object.
Return Value:
Returns a string describing the default action of the varChild object.
Parameter Description varChild The specified Variant child object.
public String getAccDescription(Variant varChild);Retrieves a description of the object.
Return Value:
Returns a description of the current object.
Parameter Description varChild The currently selected object.
public Variant getAccFocus();Retrieves the child object that currently has focus within its container or retrieves the container object itself.
Return Value:
Returns the Variant object that currently has focus.
public String getAccHelp(Variant varChild);Provides Help text for the object.
Return Value:
Returns a string describing the object's function.
Parameter Description varChild The selected Variant object that Help text is requested for.
public String getAccKeyboardShortcut(Variant varChild);Retrieves the keyboard shortcut to select the desired object.
Return Value:
Returns a string describing a sequence of keystrokes. Throws a ComFailException error if the specified varChild is not valid.
Parameter Description varChild The selected Variant object.
public String getAccName(Variant varChild);Retrieves the object's displayed name.
Return Value:
Returns the string displayed as the object's name.
Parameter Description varChild The specified child object.
public Object getAccParent();Retrieves the parent object or container of the child object.
Return Value:
Returns the parent object of the current object.
public Variant getAccRole(Variant varChild);Retrieves the role of the specified object.
Return Value:
Returns a Variant with the role code of the specified varChild.
Parameter Description varChild The Variant object that the role code is requested for.
public Variant getAccState(Variant varChild);Retrieves the state code of the specified Variant object.
Return Value:
Returns a Variant describing the state of the currently selected object.
Parameter Description varChild The object that the state code is requested for.
public String getAccValue(Variant varChild);Provides edit field value text for the object.
Return Value:
Returns the contents of an object's edit field.
Parameter Description varChild The object that the value text is requested for.
public void setAccName(Variant varChild, String pszName);Sets the displayed name for the specified child object.
Return Value:
No return value.
Parameter Description varChild The named child object. pszName The string set as the object's name.
public void setAccValue(Variant varChild, String pszValue);Sets the value of an edit field for the specified object.
Return Value:
No return value.
Parameter Description varChild The object that the value text is set for. pszValue The value for the edit field.
© 1997 Microsoft Corporation. All rights reserved. Legal Notices.