Public Member Functions | Public Attributes

nsIAccessibleRelation Interface Reference

This interface gives access to an accessible's set of relations. More...

import "nsIAccessibleRelation.idl";

List of all members.

Public Member Functions

nsIAccessible getTarget (in unsigned long index)
 Returns one accessible relation target.
nsIArray getTargets ()
 Returns multiple accessible relation targets.

Public Attributes

const unsigned long RELATION_NUL = 0x00
const unsigned long RELATION_CONTROLLED_BY = 0x01
 Some attribute of this object is affected by a target object.
const unsigned long RELATION_FIRST = RELATION_CONTROLLED_BY
const unsigned long RELATION_CONTROLLER_FOR = 0x02
 This object is interactive and controls some attribute of a target object.
const unsigned long RELATION_LABEL_FOR = 0x03
 This object is label for a target object.
const unsigned long RELATION_LABELLED_BY = 0x04
 This object is labelled by a target object.
const unsigned long RELATION_MEMBER_OF = 0x05
 This object is a member of a group of one or more objects.
const unsigned long RELATION_NODE_CHILD_OF = 0x06
 This object is a child of a target object.
const unsigned long RELATION_FLOWS_TO = 0x07
 Content flows from this object to a target object, i.e.
const unsigned long RELATION_FLOWS_FROM = 0x08
 Content flows to this object from a target object, i.e.
const unsigned long RELATION_SUBWINDOW_OF = 0x09
 This object is a sub window of a target object.
const unsigned long RELATION_EMBEDS = 0x0a
 This object embeds a target object.
const unsigned long RELATION_EMBEDDED_BY = 0x0b
 This object is embedded by a target object.
const unsigned long RELATION_POPUP_FOR = 0x0c
 This object is a transient component related to the target object.
const unsigned long RELATION_PARENT_WINDOW_OF = 0x0d
 This object is a parent window of the target object.
const unsigned long RELATION_DESCRIBED_BY = 0x0e
 This object is described by the target object.
const unsigned long RELATION_DESCRIPTION_FOR = 0x0f
 This object is describes the target object.
const unsigned long RELATION_LAST = RELATION_DESCRIPTION_FOR
const unsigned long RELATION_DEFAULT_BUTTON = 0x4000
 Part of a form/dialog with a related default button.
readonly attribute unsigned long relationType
 Returns the type of the relation.
readonly attribute unsigned long targetsCount
 Returns the number of targets for this relation.

Detailed Description

This interface gives access to an accessible's set of relations.

Be carefull, do not change constants until ATK has a structure to map gecko constants into ATK constants.


Member Function Documentation

nsIAccessible nsIAccessibleRelation::getTarget ( in unsigned long  index  ) 

Returns one accessible relation target.

Parameters:
index - 0 based index of relation target.
nsIArray nsIAccessibleRelation::getTargets (  ) 

Returns multiple accessible relation targets.


Member Data Documentation

Some attribute of this object is affected by a target object.

This object is interactive and controls some attribute of a target object.

const unsigned long nsIAccessibleRelation::RELATION_DEFAULT_BUTTON = 0x4000

Part of a form/dialog with a related default button.

It is used for MSAA only, no for IA2 nor ATK.

This object is described by the target object.

This object is describes the target object.

const unsigned long nsIAccessibleRelation::RELATION_EMBEDDED_BY = 0x0b

This object is embedded by a target object.

const unsigned long nsIAccessibleRelation::RELATION_EMBEDS = 0x0a

This object embeds a target object.

This relation can be used on the OBJID_CLIENT accessible for a top level window to show where the content areas are.

const unsigned long nsIAccessibleRelation::RELATION_FLOWS_FROM = 0x08

Content flows to this object from a target object, i.e.

has content that flows logically from another object in a sequential way, e.g. text flow.

const unsigned long nsIAccessibleRelation::RELATION_FLOWS_TO = 0x07

Content flows from this object to a target object, i.e.

has content that flows logically to another object in a sequential way, e.g. text flow.

const unsigned long nsIAccessibleRelation::RELATION_LABEL_FOR = 0x03

This object is label for a target object.

const unsigned long nsIAccessibleRelation::RELATION_LABELLED_BY = 0x04

This object is labelled by a target object.

const unsigned long nsIAccessibleRelation::RELATION_MEMBER_OF = 0x05

This object is a member of a group of one or more objects.

When there is more than one object in the group each member may have one and the same target, e.g. a grouping object. It is also possible that each member has multiple additional targets, e.g. one for every other member in the group.

This object is a child of a target object.

const unsigned long nsIAccessibleRelation::RELATION_NUL = 0x00

This object is a parent window of the target object.

const unsigned long nsIAccessibleRelation::RELATION_POPUP_FOR = 0x0c

This object is a transient component related to the target object.

When this object is activated the target object doesn't lose focus.

This object is a sub window of a target object.

readonly attribute unsigned long nsIAccessibleRelation::relationType

Returns the type of the relation.

readonly attribute unsigned long nsIAccessibleRelation::targetsCount

Returns the number of targets for this relation.


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