1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/accessible/public/nsIAccessibleRelation.idl Wed Dec 31 06:09:35 2014 +0100
1.3 @@ -0,0 +1,147 @@
1.4 +/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
1.5 +/* This Source Code Form is subject to the terms of the Mozilla Public
1.6 + * License, v. 2.0. If a copy of the MPL was not distributed with this
1.7 + * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
1.8 +
1.9 +#include "nsISupports.idl"
1.10 +#include "nsIArray.idl"
1.11 +
1.12 +interface nsIAccessible;
1.13 +
1.14 +/**
1.15 + * This interface gives access to an accessible's set of relations.
1.16 + */
1.17 +[scriptable, uuid(55b308c4-2ae4-46bc-b4cd-4d4370e0a660)]
1.18 +interface nsIAccessibleRelation : nsISupports
1.19 +{
1.20 + /**
1.21 + * This object is labelled by a target object.
1.22 + */
1.23 + const unsigned long RELATION_LABELLED_BY = 0x00;
1.24 +
1.25 + /**
1.26 + * This object is label for a target object.
1.27 + */
1.28 + const unsigned long RELATION_LABEL_FOR = 0x01;
1.29 +
1.30 + /**
1.31 + * This object is described by the target object.
1.32 + */
1.33 + const unsigned long RELATION_DESCRIBED_BY = 0x02;
1.34 +
1.35 + /**
1.36 + * This object is describes the target object.
1.37 + */
1.38 + const unsigned long RELATION_DESCRIPTION_FOR = 0x3;
1.39 +
1.40 + /**
1.41 + * This object is a child of a target object.
1.42 + */
1.43 + const unsigned long RELATION_NODE_CHILD_OF = 0x4;
1.44 +
1.45 + /**
1.46 + * This object is a parent of a target object. A dual relation to
1.47 + * RELATION_NODE_CHILD_OF
1.48 + */
1.49 + const unsigned long RELATION_NODE_PARENT_OF = 0x5;
1.50 +
1.51 + /**
1.52 + * Some attribute of this object is affected by a target object.
1.53 + */
1.54 + const unsigned long RELATION_CONTROLLED_BY = 0x06;
1.55 +
1.56 + /**
1.57 + * This object is interactive and controls some attribute of a target object.
1.58 + */
1.59 + const unsigned long RELATION_CONTROLLER_FOR = 0x07;
1.60 +
1.61 + /**
1.62 + * Content flows from this object to a target object, i.e. has content that
1.63 + * flows logically to another object in a sequential way, e.g. text flow.
1.64 + */
1.65 + const unsigned long RELATION_FLOWS_TO = 0x08;
1.66 +
1.67 + /**
1.68 + * Content flows to this object from a target object, i.e. has content that
1.69 + * flows logically from another object in a sequential way, e.g. text flow.
1.70 + */
1.71 + const unsigned long RELATION_FLOWS_FROM = 0x09;
1.72 +
1.73 + /**
1.74 + * This object is a member of a group of one or more objects. When there is
1.75 + * more than one object in the group each member may have one and the same
1.76 + * target, e.g. a grouping object. It is also possible that each member has
1.77 + * multiple additional targets, e.g. one for every other member in the group.
1.78 + */
1.79 + const unsigned long RELATION_MEMBER_OF = 0x0a;
1.80 +
1.81 + /**
1.82 + * This object is a sub window of a target object.
1.83 + */
1.84 + const unsigned long RELATION_SUBWINDOW_OF = 0x0b;
1.85 +
1.86 + /**
1.87 + * This object embeds a target object. This relation can be used on the
1.88 + * OBJID_CLIENT accessible for a top level window to show where the content
1.89 + * areas are.
1.90 + */
1.91 + const unsigned long RELATION_EMBEDS = 0x0c;
1.92 +
1.93 + /**
1.94 + * This object is embedded by a target object.
1.95 + */
1.96 + const unsigned long RELATION_EMBEDDED_BY = 0x0d;
1.97 +
1.98 + /**
1.99 + * This object is a transient component related to the target object. When
1.100 + * this object is activated the target object doesn't lose focus.
1.101 + */
1.102 + const unsigned long RELATION_POPUP_FOR = 0x0e;
1.103 +
1.104 + /**
1.105 + * This object is a parent window of the target object.
1.106 + */
1.107 + const unsigned long RELATION_PARENT_WINDOW_OF = 0x0f;
1.108 +
1.109 + /**
1.110 + * Part of a form/dialog with a related default button. It is used for
1.111 + * MSAA/XPCOM, it isn't for IA2 or ATK.
1.112 + */
1.113 + const unsigned long RELATION_DEFAULT_BUTTON = 0x10;
1.114 +
1.115 + /**
1.116 + * The target object is the containing document object.
1.117 + */
1.118 + const unsigned long RELATION_CONTAINING_DOCUMENT = 0x11;
1.119 +
1.120 + /**
1.121 + * The target object is the topmost containing document object in the tab pane.
1.122 + */
1.123 + const unsigned long RELATION_CONTAINING_TAB_PANE = 0x12;
1.124 +
1.125 + /**
1.126 + * The target object is the containing application object.
1.127 + */
1.128 + const unsigned long RELATION_CONTAINING_APPLICATION = 0x14;
1.129 +
1.130 + /**
1.131 + * Returns the type of the relation.
1.132 + */
1.133 + readonly attribute unsigned long relationType;
1.134 +
1.135 + /**
1.136 + * Returns the number of targets for this relation.
1.137 + */
1.138 + readonly attribute unsigned long targetsCount;
1.139 +
1.140 + /**
1.141 + * Returns one accessible relation target.
1.142 + * @param index - 0 based index of relation target.
1.143 + */
1.144 + nsIAccessible getTarget(in unsigned long index);
1.145 +
1.146 + /**
1.147 + * Returns multiple accessible relation targets.
1.148 + */
1.149 + nsIArray getTargets();
1.150 +};
