1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
|
<?xml version="1.0" standalone="no"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<refentry id="class-atkrelationset">
<refnamediv>
<refname>atk.RelationSet</refname>
<refpurpose>a set of <link
linkend="class-atkrelation"><classname>atk.Relation</classname></link>
objects, normally the set of <link
linkend="class-atkrelation"><classname>atk.Relation</classname></link>
objects that an <link
linkend="class-atkobject"><classname>atk.Object</classname></link>
has.</refpurpose>
</refnamediv>
<refsect1>
<title>Synopsis</title>
<classsynopsis language="python">
<ooclass><classname>atk.RelationSet</classname></ooclass>
<ooclass><classname><link linkend="class-gobject">gobject.GObject</link></classname></ooclass>
<constructorsynopsis language="python">
<methodname><link linkend="constructor-atkrelationset">atk.RelationSet</link></methodname>
<methodparam></methodparam>
</constructorsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-atkrelationset--contains">contains</link></methodname>
<methodparam><parameter role="keyword">relationship</parameter></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-atkrelationset--remove">remove</link></methodname>
<methodparam><parameter role="keyword">relation</parameter></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-atkrelationset--add">add</link></methodname>
<methodparam><parameter role="keyword">relation</parameter></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-atkrelationset--get-n-relations">get_n_relations</link></methodname>
<methodparam></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-atkrelationset--get-relation">get_relation</link></methodname>
<methodparam><parameter role="keyword">i</parameter></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-atkrelationset--get-relation-by-type">get_relation_by_type</link></methodname>
<methodparam><parameter role="keyword">relationship</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
</refsect1>
<refsect1>
<title>Ancestry</title>
<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
+-- <link linkend="class-atkrelationset">atk.RelationSet</link>
</synopsis>
</refsect1>
<refsect1 id="signal-prototypes-atkrelationset">
<title>atk.RelationSet Signal Prototypes</title>
<para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
</refsect1>
<refsect1>
<title>Description</title>
<para>The <link
linkend="class-atkrelationset"><classname>atk.RelationSet</classname></link>
held by an object establishes its relationships with objects beyond the
normal "parent/child" hierarchical relationships that all user interface
objects have. <link
linkend="class-atkrelationset"><classname>atk.RelationSet</classname></link>
objects establish whether objects are labelled or controlled by other
components, share group membership with other components (for instance
within a radio-button group), or share content which "flows" between
them, among other types of possible relationships.</para>
</refsect1>
<refsect1>
<title>Constructor</title>
<refsect2 id="constructor-atkrelationset">
<title>atk.RelationSet</title>
<programlisting><constructorsynopsis language="python">
<methodname>atk.RelationSet</methodname>
<methodparam></methodparam>
</constructorsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>a new <link
linkend="class-atkrelationset"><classname>atk.RelationSet</classname></link></simpara></listitem>
</varlistentry>
</variablelist>
<para>Creates a new empty relation set.</para>
</refsect2>
</refsect1>
<refsect1>
<title>Methods</title>
<refsect2 id="method-atkrelationset--contains">
<title>atk.RelationSet.contains</title>
<programlisting><methodsynopsis language="python">
<methodname>contains</methodname>
<methodparam><parameter role="keyword">relationship</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">relationship</parameter> :</term>
<listitem><simpara>one of the <xref
linkend="atk-relation-type-constants"
endterm="atk-relation-type-constants-title"></xref>.</simpara></listitem>
</varlistentry>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara><literal>True</literal> if
<parameter>relationship</parameter> is the relationship
type.</simpara></listitem>
</varlistentry>
</variablelist>
<para>Determines whether the relation set contains a relation that
matches the type specified by
<parameter>relationship</parameter>.</para>
</refsect2>
<refsect2 id="method-atkrelationset--remove">
<title>atk.RelationSet.remove</title>
<programlisting><methodsynopsis language="python">
<methodname>remove</methodname>
<methodparam><parameter role="keyword">relation</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">relation</parameter> :</term>
<listitem><simpara>an <link
linkend="class-atkrelation"><classname>atk.Relation</classname></link></simpara></listitem>
</varlistentry>
</variablelist>
<para>Removes a relation from the relation set.</para>
</refsect2>
<refsect2 id="method-atkrelationset--add">
<title>atk.RelationSet.add</title>
<programlisting><methodsynopsis language="python">
<methodname>add</methodname>
<methodparam><parameter role="keyword">relation</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">relation</parameter> :</term>
<listitem><simpara>an <link
linkend="class-atkrelation"><classname>atk.Relation</classname></link></simpara></listitem>
</varlistentry>
</variablelist>
<para>Add a new <link
linkend="class-atkrelation"><classname>atk.Relation</classname></link>
to the current relation set if it is not already present.</para>
</refsect2>
<refsect2 id="method-atkrelationset--get-n-relations">
<title>atk.RelationSet.get_n_relations</title>
<programlisting><methodsynopsis language="python">
<methodname>get_n_relations</methodname>
<methodparam></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>an integer representing the number of relations
in the set.</simpara></listitem>
</varlistentry>
</variablelist>
<para>Returns the number of relations in a relation set.</para>
</refsect2>
<refsect2 id="method-atkrelationset--get-relation">
<title>atk.RelationSet.get_relation</title>
<programlisting><methodsynopsis language="python">
<methodname>get_relation</methodname>
<methodparam><parameter role="keyword">i</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">i</parameter> :</term>
<listitem><simpara>an index representing a position in the set,
starting from 0.</simpara></listitem>
</varlistentry>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>the <link
linkend="class-atkrelation"><classname>atk.Relation</classname></link>,
that is the relation at position <parameter>i</parameter> in the
set.</simpara></listitem>
</varlistentry>
</variablelist>
<para>Determines the relation at the specified position in the relation set.</para>
</refsect2>
<refsect2 id="method-atkrelationset--get-relation-by-type">
<title>atk.RelationSet.get_relation_by_type</title>
<programlisting><methodsynopsis language="python">
<methodname>get_relation_by_type</methodname>
<methodparam><parameter role="keyword">relationship</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">relationship</parameter> :</term>
<listitem><simpara>one of the <xref
linkend="atk-relation-type-constants"
endterm="atk-relation-type-constants-title"></xref>.</simpara></listitem>
</varlistentry>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>an <link
linkend="class-atkrelation"><classname>atk.Relation</classname></link>,
which is a relation matching the specified
type.</simpara></listitem>
</varlistentry>
</variablelist>
<para>Finds a relation that matches the specified type.</para>
</refsect2>
</refsect1>
</refentry>
|
