Interface IAccessibleDefault

public interface IAccessibleDefault extends IAccessible
{
  // Fields
  public static final _Guid iid;

  // Methods
  public void accDoDefaultAction(Variant varChild);
  public Variant accHitTest(int xLeft, int yTop);
  public void accLocation(int[] pxLeft, int[] pyTop,
        int[] pcxWidth, int[] pcyHeight, Variant varChild);
  public Variant accNavigate(int navDir, Variant varStart);
  public void accSelect(int flagsSelect, Variant varChild);
  public Object getAccChild(Variant varChild);
  public int getAccChildCount();
  public String getAccDefaultAction(Variant varChild);
  public String getAccDescription(Variant varChild);
  public Variant getAccFocus();
  public String getAccHelp(Variant varChild);
  public int getAccHelpTopic(String[] pszHelpFile,
        Variant varChild);
  public String getAccKeyboardShortcut(Variant varChild);
  public String getAccName(Variant varChild);
  public Object getAccParent();
  public Variant getAccRole(Variant varChild);
  public Variant getAccSelection();
  public Variant getAccState(Variant varChild);
  public String getAccValue(Variant varChild);
  public void setAccName(Variant varChild, String pszName);
  public void setAccValue(Variant varChild, String pszValue);
}

This interface provides methods that enable users to request selection and focus information, perform hit tests, and navigate by using object and child identifiers. IAccessibleDefault extends the IAccessible interface.

In the following methods, the Variant object varChild identifies a child of the IAccessible object or indicates the object itself. This value of this parameter can be the child ID value (provided by the object), CHILDID_SELF for the object itself, or a string identifying the child (such as "A1").

If a container object does not support the IEnumVariant interface, its child ID numbers must be sequential positive integers starting with 1. If the object supports IEnumVariant, it can use any method to assign its child ID numbers.

IUnknown
  |
  +--IAccessible
    |
    +--IAccessibleDefault

Methods

accDoDefaultAction

public void accDoDefaultAction(Variant varChild);

Performs the object's default action.

Return Value:

No return value.

Parameter	Description
varChild	A value that identifies the child object whose default action is performed.

Overrides:

accDoDefaultAction(Variant) in IAccessible.

accHitTest

public Variant accHitTest(int xLeft, int yTop);

Retrieves the child object at a specified location on the screen. That is, a point on the screen is tested to see if there is a child object (a hit) located at that point.

Return Value:

Returns a Variant object that describes the child object located at the specified coordinates.

Parameter	Description
xLeft	The x coordinate of the point on the screen that is hit-tested.
yTop	The y coordinate of the point on the screen that is hit-tested

Overrides:

accHitTest(int,int) in IAccessible.

accLocation

public void accLocation(int[] pxLeft, int[] pyTop, int[] pcxWidth,
        int[] pcyHeight, Variant varChild);

Retrieves the screen location of an accessibility object. The varChild parameter indicates whether this method will retrieve the coordinates of the container itself or of one of its children.

Return Value:

No return value.

Parameter	Description
pxLeft	The retrieved x coordinate of the object's screen location.
pyTop	The retrieved y coordinate of the object's screen location.
pcxWidth	The object's retrieved width, measured in pixels.
pcyHeight	The object's retrieved height, measured in pixels.
varChild	A value that identifies the child object whose location is retrieved.

Overrides:

accLocation(int[],int[],int[],int[],Variant) in IAccessible.

accNavigate

public Variant accNavigate(int navDir, Variant varStart);

Retrieves the sibling or child object that is navigated to in a specified direction.

Return Value:

Returns a Variant object that contains information about the object that is navigated to.

Parameter	Description
navDir	The navigation code that specifies the navigation direction.
varStart	The Variant object that specifies the type of navigation needed. If the variant type is VT_EMPTY, the method retrieves a sibling object. If the variant type is VT_I4 and the value is CHILDID_SELF, the method retrieves a child object.

Overrides:

accNavigate(int,Variant) in IAccessible.

accSelect

public void accSelect(int flagsSelect, Variant varChild);

Changes focus and modifies selection according to specified flags.

Return Value:

No return value.

Parameter	Description
flagsSelect	The selection flags, which indicate how to change the focus and selection. They must be set to some combination of the following: SELFLAG_NONE, SELFLAG_TAKEFOCUS, SELFLAG_TAKESELECTION, SELFLAG_EXTENDSELECTION, SELFLAG_ADDSELECTION, and SELFLAG_REMOVESELECTION.
varChild	A value that identifies the child object that is selected.

Overrides:

accSelect(int,Variant) in IAccessible.

getAccChild

public Object getAccChild(Variant varChild);

Retrieves a specified child object.

Return Value:

Returns the requested child object.

Parameter	Description
varChild	A Variant object that identifies the child to retrieve.

Overrides:

getAccChild(Variant) in IAccessible.

getAccChildCount

public int getAccChildCount();

Retrieves the number of components in the parent container.

Return Value:

Returns the number of components in the parent container.

Overrides:

getAccChildCount() in IAccessible.

getAccDefaultAction

public String getAccDefaultAction(Variant varChild);

Retrieves the default action for a specified child object.

Return Value:

Returns a string that describes the default action of the child object.

Parameter	Description
varChild	A value that identifies the child object that the default action is requested for.

Overrides:

getAccDefaultAction(Variant) in IAccessible.

getAccDescription

public String getAccDescription(Variant varChild);

Retrieves a description of the child object.

Return Value:

Returns a description of the child object.

Parameter	Description
varChild	The value that identifies the child whose description is retrieved.

Overrides:

getAccDescription(Variant) in IAccessible.

getAccFocus

public Variant getAccFocus();

Retrieves the child object that currently has the keyboard focus. If the object itself has the keyboard focus, this method returns zero as a VT_14 type. If a child has the focus but isn't an accessible object, it returns the child ID as a VT_14 type. If a child has the focus and is an accessible object, this method returns its IDispatch interface.

Return Value:

Returns the Variant object that contains information about the retrieved child object.

Overrides:

getAccFocus() in IAccessible.

getAccHelp

public String getAccHelp(Variant varChild);

Provides Help text associated with the object.

Return Value:

Returns a string that describes the object's function.

Parameter	Description
varChild	A value that identifies the child object that the Help text is requested for.

Overrides:

getAccHelp(Variant) in IAccessible.

getAccHelpTopic

public int getAccHelpTopic(String[] pszHelpFile, Variant varChild);

Retrieves the full path of the Help file associated with the object, as well as a value that identifies the Help file topic. This method is not implemented at this time.

Return Value:

Returns a value that identifies the object's Help topic.

Parameter	Description
pszHelpFile	The retrieved Help file path for the object.
varChild	A value that identifies the child object that the Help topic is requested for.

Overrides:

getAccHelpTopic(String[],Variant) in IAccessible.

getAccKeyboardShortcut

public String getAccKeyboardShortcut(Variant varChild);

Retrieves the keyboard shortcut that selects the object.

Return Value:

Returns a string that describes a sequence of keystrokes for selecting the object.

Parameter	Description
varChild	A value that identifies the child object that the keyboard shortcut is requested for.

Overrides:

getAccKeyboardShortcut(Variant) in IAccessible.

Exceptions:

com.ms.com.ComFailException if the specified object is not valid.

getAccName

public String getAccName(Variant varChild);

Retrieves the name property of the child object.

Return Value:

Returns the name of the child object.

Parameter	Description
varChild	The value that identifies the child whose name is retrieved.

Overrides:

getAccName(Variant) in IAccessible.

getAccParent

public Object getAccParent();

Retrieves the parent object (the container) of the child object.

Return Value:

Returns the parent of the object.

Overrides:

getAccParent() in IAccessible.

getAccRole

public Variant getAccRole(Variant varChild);

Retrieves the role property of a specified child object.

Return Value:

Returns a Variant object that contains a role constant or a string that describes the object's role.

Parameter	Description
varChild	The value that identifies the child object whose role is requested.

Overrides:

getAccRole(Variant) in IAccessible.

getAccSelection

public Variant getAccSelection();

Retrieves the selected children of the object.

Return Value:

Returns a Variant object that identifies the object or objects that are selected.

Overrides:

getAccSelection() in IAccessible.

getAccState

public Variant getAccState(Variant varChild);

Retrieves the current state code of the object.

Return Value:

Returns a Variant that describes the state of the object, either a string or a value equal to one or more of the object state constants.

Parameter	Description
varChild	The value that identifies the child object that the state code is requested for.

Overrides:

getAccState(Variant) in IAccessible.

getAccValue

public String getAccValue(Variant varChild);

Retrieves the value property of the child object.

Return Value:

Returns the value of the child object.

Parameter	Description
varChild	The Variant object that identifies the child whose value is retrieved.

Overrides:

getAccValue(Variant) in IAccessible.

setAccName

public void setAccName(Variant varChild, String pszName);

Sets the name of a child object.

Return Value:

No return value.

Parameter	Description
varChild	A value that identifies the child object whose name is set by this method.
pszName	The child object's new name.

Overrides:

setAccName(Variant,String) in IAccessible.

setAccValue

public void setAccValue(Variant varChild, String pszValue);

Sets the value of a child object.

Return Value:

No return value.

Parameter	Description
varChild	The Variant object that identifies the child whose value is set by this method.
pszValue	The new value.

Overrides:

setAccValue(Variant,String) in IAccessible.

Fields

iid

The interface identifier.