Struct xpcom::interfaces::nsIAccessibleRelation [] [src]

#[repr(C)]
pub struct nsIAccessibleRelation { /* fields omitted */ }

interface nsIAccessibleRelation : nsISupports

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

Methods

impl nsIAccessibleRelation
[src]

[src]

Cast this nsIAccessibleRelation to one of its base interfaces.

impl nsIAccessibleRelation
[src]

RELATION_LABELLED_BY: i64 = 0
/**
   * This object is labelled by a target object.
   */

RELATION_LABEL_FOR: i64 = 1
/**
   * This object is label for a target object.
   */

RELATION_DESCRIBED_BY: i64 = 2
/**
   * This object is described by the target object.
   */

RELATION_DESCRIPTION_FOR: i64 = 3
/**
   * This object is describes the target object.
   */

RELATION_NODE_CHILD_OF: i64 = 4
/**
   * This object is a child of a target object.
   */

RELATION_NODE_PARENT_OF: i64 = 5
/**
   * This object is a parent of a target object. A dual relation to
   * RELATION_NODE_CHILD_OF
   */

RELATION_CONTROLLED_BY: i64 = 6
/**
   * Some attribute of this object is affected by a target object.
   */

RELATION_CONTROLLER_FOR: i64 = 7
/**
   * This object is interactive and controls some attribute of a target object.
   */

RELATION_FLOWS_TO: i64 = 8
/**
   * 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.
   */

RELATION_FLOWS_FROM: i64 = 9
/**
   * 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.
   */

RELATION_MEMBER_OF: i64 = 10
/**
   * 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.
   */

RELATION_SUBWINDOW_OF: i64 = 11
/**
   * This object is a sub window of a target object.
   */

RELATION_EMBEDS: i64 = 12
/**
   * 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.
   */

RELATION_EMBEDDED_BY: i64 = 13
/**
   * This object is embedded by a target object.
   */

RELATION_POPUP_FOR: i64 = 14
/**
   * This object is a transient component related to the target object. When
   * this object is activated the target object doesn't lose focus.
   */

RELATION_PARENT_WINDOW_OF: i64 = 15
/**
   * This object is a parent window of the target object.
   */

RELATION_DEFAULT_BUTTON: i64 = 16
/**
   * Part of a form/dialog with a related default button. It is used for
   * MSAA/XPCOM, it isn't for IA2 or ATK.
   */

RELATION_CONTAINING_DOCUMENT: i64 = 17
/**
   * The target object is the containing document object.
   */

RELATION_CONTAINING_TAB_PANE: i64 = 18
/**
   * The target object is the topmost containing document object in the tab pane.
   */

RELATION_CONTAINING_WINDOW: i64 = 19
/**
   * The target object is the containing window object.
   */

RELATION_CONTAINING_APPLICATION: i64 = 20
/**
   * The target object is the containing application object.
   */

RELATION_DETAILS: i64 = 21
/**
   * The target object provides the detailed, extended description for this
   * object. It provides more detailed information than would normally be
   * provided using the DESCRIBED_BY relation. A common use for this relation is
   * in digital publishing where an extended description needs to be conveyed in
   * a book that requires structural markup or the embedding of other technology
   * to provide illustrative content.
   */

RELATION_DETAILS_FOR: i64 = 22
/**
   * This object provides the detailed, extended description for the target
   * object. See DETAILS relation.
   */

RELATION_ERRORMSG: i64 = 23
/**
   * The target object is the error message for this object.
   */

RELATION_ERRORMSG_FOR: i64 = 24
/**
   * This object is the error message for the target object.
   */

[src]

/**
   * Returns the type of the relation.
   */

readonly attribute unsigned long relationType;

[src]

/**
   * Returns the number of targets for this relation.
   */

readonly attribute unsigned long targetsCount;

[src]

/**
   * Returns one accessible relation target.
   * @param index - 0 based index of relation target.
   */

nsIAccessible getTarget (in unsigned long index);

[src]

/**
   * Returns multiple accessible relation targets.
   */

nsIArray getTargets ();

Methods from Deref<Target = nsISupports>

[src]

Cast this nsISupports to one of its base interfaces.

[src]

void QueryInterface (in nsIIDRef uuid, [iid_is (uuid), retval] out nsQIResult result);

[src]

[noscript,notxpcom] nsrefcnt AddRef ();

[src]

[noscript,notxpcom] nsrefcnt Release ();

Trait Implementations

impl XpCom for nsIAccessibleRelation
[src]

IID: nsIID = nsID(1437796548, 10980, 18108, [180, 205, 77, 67, 112, 224, 166, 96])

[src]

Perform a QueryInterface call on this object, attempting to dynamically cast it to the requested interface type. Returns Some(RefPtr) if the cast succeeded, and None otherwise. Read more

impl RefCounted for nsIAccessibleRelation
[src]

[src]

Increment the reference count.

[src]

Decrement the reference count, potentially freeing backing memory.

impl Deref for nsIAccessibleRelation
[src]

The resulting type after dereferencing.

[src]

Dereferences the value.