mozilla
Your Search Results

    Gecko Relations

    « AT APIs Support Page

    Introduction

    Below you will find a list of supported relations by Gecko. Relation constants are defined in nsIAccessibleRelations interface (

    Please add a summary to this article.
      Last changed in Gecko 1.9 (Firefox 3)
    )

    Refer to the following methods to get relations:

    Relations List

    RELATION_CONTROLLED_BY
    Some attribute of this object is affected by a target object.
    Applied to: ???
    Opposite relation: RELATION_CONTROLLER_FOR
    RELATION_CONTROLLER_FOR
    This object is interactive and controls some attribute of a target object.
    Applied to: ???
    Opposite relation: RELATION_CONTROLLED_BY
    RELATION_LABEL_FOR
    This object is label for a target object.
    Applied to: ???
    Opposite relation: RELATION_LABELLED_BY
    RELATION_LABELLED_BY
    This object is labelled by a target object. If the accessible has an nsIAccessible.name, you can get the nsIAccessible that it was labelled by in order to get more formatting information. Note that the label and description (see RELATION_DESCRIBED_BY) relations may be used to prevent redundant information from being presented by the screen reader, since the label and description can occur both on their own, and in the name or description fields of an nsIAccessible.
    Applied to: ???
    Opposite relation: RELATION_LABEL_FOR
    RELATION_MEMBER_OF
    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.
    Applied to: ???
     
    RELATION_NODE_CHILD_OF
    This object is a child of a target object.
    Applied to: ???
     
    RELATION_FLOWS_TO
    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.
    Applied to: ???
    Opposite relation: RELATION_FLOWS_FROM
    RELATION_FLOWS_FROM
    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.
    Applied to: ???
    Opposite relation: RELATION_FLOWS_TO
    RELATION_SUBWINDOW_OF
    This object is a sub window of a target object.
    Applied to: ???
     
    RELATION_EMBEDS
    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. It points to the accessible object corresponding to the root of content in that window. This relation is very useful for finding the content quickly, and is the proper method for finding content in Firefox 3 and beyond.
    Applied to: ???
    Opposite relation: RELATION_EMBEDDED_BY
    RELATION_EMBEDDED_BY
    This object is embedded by a target object.
    Applied to: ???
    Opposite relation: RELATION_EMBEDS
    RELATION_POPUP_FOR
    This object is a transient component related to the target object. When this object is activated the target object doesn't loose focus.
    Applied to: ???
     
    RELATION_PARENT_WINDOW_OF
    This object is a parent window of the target object.
    Applied to: ???
     
    RELATION_DESCRIBED_BY
    This object is described by the target object. If the accessible has an nsIAccessible.description, you can get the nsIAccessible that it was described by in order to get more formatting information. Note that the label (see RELATION_LABELLED_BY) and description relations may be used to prevent redundant information from being presented by the screen reader, since the label and description can occur both on their own, and in the name or description fields of an nsIAccessible.
    Applied to: ???
    Opposite relation: RELATION_DESCRIPTION_FOR
    RELATION_DESCRIPTION_FOR
    This object is describes the target object.
    Applied to: ???
    Opposite relation: RELATION_DESCRIBED_BY
    RELATION_DEFAULT_BUTTON
    Part of a form/dialog with a related default button. It is used for MSAA only, no for IA2 nor ATK/AT-SPI.
    Applied to: ???
     

    Document Tags and Contributors

    Contributors to this page: Sheppy, Fredchat, fscholz, Surkov.alexander
    Last updated by: Fredchat,