gecko-dev/accessible/interfaces/nsIAccessibleRelation.idl
Birunthan Mohanathas 3111e08278 Bug 1028563 - Part 2: Rename accessible/{public => interfaces}/. rs=surkov
--HG--
rename : accessible/public/ia2/IA2Marshal.def => accessible/interfaces/ia2/IA2Marshal.def
rename : accessible/public/ia2/Makefile.in => accessible/interfaces/ia2/Makefile.in
rename : accessible/public/ia2/moz.build => accessible/interfaces/ia2/moz.build
rename : accessible/public/moz.build => accessible/interfaces/moz.build
rename : accessible/public/msaa/AccessibleMarshal.def => accessible/interfaces/msaa/AccessibleMarshal.def
rename : accessible/public/msaa/ISimpleDOMDocument.idl => accessible/interfaces/msaa/ISimpleDOMDocument.idl
rename : accessible/public/msaa/ISimpleDOMNode.idl => accessible/interfaces/msaa/ISimpleDOMNode.idl
rename : accessible/public/msaa/ISimpleDOMText.idl => accessible/interfaces/msaa/ISimpleDOMText.idl
rename : accessible/public/msaa/Makefile.in => accessible/interfaces/msaa/Makefile.in
rename : accessible/public/msaa/moz.build => accessible/interfaces/msaa/moz.build
rename : accessible/public/nsIAccessibilityService.h => accessible/interfaces/nsIAccessibilityService.h
rename : accessible/public/nsIAccessible.idl => accessible/interfaces/nsIAccessible.idl
rename : accessible/public/nsIAccessibleApplication.idl => accessible/interfaces/nsIAccessibleApplication.idl
rename : accessible/public/nsIAccessibleCaretMoveEvent.idl => accessible/interfaces/nsIAccessibleCaretMoveEvent.idl
rename : accessible/public/nsIAccessibleDocument.idl => accessible/interfaces/nsIAccessibleDocument.idl
rename : accessible/public/nsIAccessibleEditableText.idl => accessible/interfaces/nsIAccessibleEditableText.idl
rename : accessible/public/nsIAccessibleEvent.idl => accessible/interfaces/nsIAccessibleEvent.idl
rename : accessible/public/nsIAccessibleHideEvent.idl => accessible/interfaces/nsIAccessibleHideEvent.idl
rename : accessible/public/nsIAccessibleHyperLink.idl => accessible/interfaces/nsIAccessibleHyperLink.idl
rename : accessible/public/nsIAccessibleHyperText.idl => accessible/interfaces/nsIAccessibleHyperText.idl
rename : accessible/public/nsIAccessibleImage.idl => accessible/interfaces/nsIAccessibleImage.idl
rename : accessible/public/nsIAccessiblePivot.idl => accessible/interfaces/nsIAccessiblePivot.idl
rename : accessible/public/nsIAccessibleRelation.idl => accessible/interfaces/nsIAccessibleRelation.idl
rename : accessible/public/nsIAccessibleRetrieval.idl => accessible/interfaces/nsIAccessibleRetrieval.idl
rename : accessible/public/nsIAccessibleRole.idl => accessible/interfaces/nsIAccessibleRole.idl
rename : accessible/public/nsIAccessibleSelectable.idl => accessible/interfaces/nsIAccessibleSelectable.idl
rename : accessible/public/nsIAccessibleStateChangeEvent.idl => accessible/interfaces/nsIAccessibleStateChangeEvent.idl
rename : accessible/public/nsIAccessibleStates.idl => accessible/interfaces/nsIAccessibleStates.idl
rename : accessible/public/nsIAccessibleTable.idl => accessible/interfaces/nsIAccessibleTable.idl
rename : accessible/public/nsIAccessibleTableChangeEvent.idl => accessible/interfaces/nsIAccessibleTableChangeEvent.idl
rename : accessible/public/nsIAccessibleText.idl => accessible/interfaces/nsIAccessibleText.idl
rename : accessible/public/nsIAccessibleTextChangeEvent.idl => accessible/interfaces/nsIAccessibleTextChangeEvent.idl
rename : accessible/public/nsIAccessibleTextRange.idl => accessible/interfaces/nsIAccessibleTextRange.idl
rename : accessible/public/nsIAccessibleTypes.idl => accessible/interfaces/nsIAccessibleTypes.idl
rename : accessible/public/nsIAccessibleValue.idl => accessible/interfaces/nsIAccessibleValue.idl
rename : accessible/public/nsIAccessibleVirtualCursorChangeEvent.idl => accessible/interfaces/nsIAccessibleVirtualCursorChangeEvent.idl
rename : accessible/public/nsIXBLAccessible.idl => accessible/interfaces/nsIXBLAccessible.idl
2014-06-22 10:16:39 -07:00

148 lines
4.1 KiB
Plaintext

/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
#include "nsISupports.idl"
#include "nsIArray.idl"
interface nsIAccessible;
/**
* This interface gives access to an accessible's set of relations.
*/
[scriptable, uuid(55b308c4-2ae4-46bc-b4cd-4d4370e0a660)]
interface nsIAccessibleRelation : nsISupports
{
/**
* This object is labelled by a target object.
*/
const unsigned long RELATION_LABELLED_BY = 0x00;
/**
* This object is label for a target object.
*/
const unsigned long RELATION_LABEL_FOR = 0x01;
/**
* This object is described by the target object.
*/
const unsigned long RELATION_DESCRIBED_BY = 0x02;
/**
* This object is describes the target object.
*/
const unsigned long RELATION_DESCRIPTION_FOR = 0x3;
/**
* This object is a child of a target object.
*/
const unsigned long RELATION_NODE_CHILD_OF = 0x4;
/**
* This object is a parent of a target object. A dual relation to
* RELATION_NODE_CHILD_OF
*/
const unsigned long RELATION_NODE_PARENT_OF = 0x5;
/**
* Some attribute of this object is affected by a target object.
*/
const unsigned long RELATION_CONTROLLED_BY = 0x06;
/**
* This object is interactive and controls some attribute of a target object.
*/
const unsigned long RELATION_CONTROLLER_FOR = 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 RELATION_FLOWS_TO = 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 RELATION_FLOWS_FROM = 0x09;
/**
* 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.
*/
const unsigned long RELATION_MEMBER_OF = 0x0a;
/**
* This object is a sub window of a target object.
*/
const unsigned long RELATION_SUBWINDOW_OF = 0x0b;
/**
* 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 RELATION_EMBEDS = 0x0c;
/**
* This object is embedded by a target object.
*/
const unsigned long RELATION_EMBEDDED_BY = 0x0d;
/**
* This object is a transient component related to the target object. When
* this object is activated the target object doesn't lose focus.
*/
const unsigned long RELATION_POPUP_FOR = 0x0e;
/**
* This object is a parent window of the target object.
*/
const unsigned long RELATION_PARENT_WINDOW_OF = 0x0f;
/**
* Part of a form/dialog with a related default button. It is used for
* MSAA/XPCOM, it isn't for IA2 or ATK.
*/
const unsigned long RELATION_DEFAULT_BUTTON = 0x10;
/**
* The target object is the containing document object.
*/
const unsigned long RELATION_CONTAINING_DOCUMENT = 0x11;
/**
* The target object is the topmost containing document object in the tab pane.
*/
const unsigned long RELATION_CONTAINING_TAB_PANE = 0x12;
/**
* The target object is the containing application object.
*/
const unsigned long RELATION_CONTAINING_APPLICATION = 0x14;
/**
* Returns the type of the relation.
*/
readonly attribute unsigned long relationType;
/**
* Returns the number of targets for this relation.
*/
readonly attribute unsigned long targetsCount;
/**
* Returns one accessible relation target.
* @param index - 0 based index of relation target.
*/
nsIAccessible getTarget(in unsigned long index);
/**
* Returns multiple accessible relation targets.
*/
nsIArray getTargets();
};