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
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
|
<?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-atkrelation">
<refnamediv>
<refname>atk.Relation</refname>
<refpurpose>an object used to describe a relation between a object and
one or more other objects. </refpurpose>
</refnamediv>
<refsect1>
<title>Synopsis</title>
<classsynopsis language="python">
<ooclass><classname>atk.Relation</classname></ooclass>
<ooclass><classname><link linkend="class-gobject">gobject.GObject</link></classname></ooclass>
<constructorsynopsis language="python">
<methodname><link linkend="constructor-atkrelation">atk.Relation</link></methodname>
<methodparam><parameter role="keyword">targets</parameter></methodparam>
<methodparam><parameter role="keyword">relationship</parameter></methodparam>
</constructorsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-atkrelation--get-relation-type">get_relation_type</link></methodname>
<methodparam></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-atkrelation--get-target">get_target</link></methodname>
<methodparam></methodparam>
</methodsynopsis>
</classsynopsis>
<programlisting>
<emphasis role="bold">Functions</emphasis>
<methodsynopsis language="python">
<methodname><link linkend="function-atk--relation-type-register">atk.relation_type_register</link></methodname>
<methodparam><parameter role="keyword">name</parameter></methodparam>
</methodsynopsis><methodsynopsis language="python">
<methodname><link linkend="function-atk--relation-type-get-name">atk.relation_type_get_name</link></methodname>
<methodparam><parameter role="keyword">relationship</parameter></methodparam>
</methodsynopsis><methodsynopsis language="python">
<methodname><link linkend="function-atk--relation-type-for-name">atk.relation_type_for_name</link></methodname>
<methodparam><parameter role="keyword">name</parameter></methodparam>
</methodsynopsis></programlisting>
</refsect1>
<refsect1>
<title>Ancestry</title>
<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
+-- <link linkend="class-atkrelation">atk.Relation</link>
</synopsis>
</refsect1>
<refsect1 id="properties-atkrelation">
<title>atk.Relation Properties</title>
<blockquote role="properties">
<informaltable pgwide="1" frame="none">
<tgroup cols="3">
<colspec column="1" colwidth="1in"/>
<colspec column="2" colwidth="1in"/>
<colspec column="3" colwidth="3.5in"/>
<tbody>
<row valign="top">
<entry>"relation-type"</entry>
<entry>Read-Write</entry>
<entry>The type of the relation - one of the <xref
linkend="atk-relation-type-constants"
endterm="atk-relation-type-constants-title"></xref>. Default
value: atk.RELATION_NULL.</entry>
</row>
<row valign="top">
<entry>"target"</entry>
<entry>Read-Write</entry>
<entry>An array of the targets for the relation. Default value:
None.</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</blockquote>
</refsect1>
<refsect1 id="signal-prototypes-atkrelation">
<title>atk.Relation Signal Prototypes</title>
<para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
</refsect1>
<refsect1>
<title>Description</title>
<para>An <link
linkend="class-atkrelation"><classname>atk.Relation</classname></link>
describes a relation between an object and one or more other
objects. The actual relations that an object has with other objects are
defined as an <link
linkend="class-atkrelationset"><classname>atk.RelationSet</classname></link>,
which contains a set of <link
linkend="class-atkrelation"><classname>atk.Relation</classname></link>
objects.
</para>
</refsect1>
<refsect1>
<title>Constructor</title>
<refsect2 id="constructor-atkrelation">
<title>atk.Relation</title>
<programlisting><constructorsynopsis language="python">
<methodname>atk.Relation</methodname>
<methodparam><parameter role="keyword">targets</parameter></methodparam>
<methodparam><parameter role="keyword">relationship</parameter></methodparam>
</constructorsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">targets</parameter> :</term>
<listitem><simpara>a sequence of <link
linkend="class-atkobject"><classname>atk.Object</classname>
objects</link></simpara></listitem>
</varlistentry>
<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> with which to
create the new <link
linkend="class-atkrelation"><classname>atk.Relation</classname></link></simpara></listitem>
</varlistentry>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>a new <link
linkend="class-atkrelation"><classname>atk.Relation</classname></link></simpara></listitem>
</varlistentry>
</variablelist>
<para>Create a new relation for the specified
<parameter>relationship</parameter> type and the specified sequence of
<parameter>targets</parameter>.</para>
</refsect2>
</refsect1>
<refsect1>
<title>Methods</title>
<refsect2 id="method-atkrelation--get-relation-type">
<title>atk.Relation.get_relation_type</title>
<programlisting><methodsynopsis language="python">
<methodname>get_relation_type</methodname>
<methodparam></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>the relation type - one of the <xref
linkend="atk-relation-type-constants"
endterm="atk-relation-type-constants-title"></xref>.</simpara></listitem>
</varlistentry>
</variablelist>
<para>Gets the relationship type.</para>
</refsect2>
<refsect2 id="method-atkrelation--get-target">
<title>atk.Relation.get_target</title>
<programlisting><methodsynopsis language="python">
<methodname>get_target</methodname>
<methodparam></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>the target list of <parameter>relation</parameter></simpara></listitem>
</varlistentry>
</variablelist>
<para>Gets the target list of <link
linkend="class-atkobject"><classname>atk.Object</classname></link>
objects.</para>
</refsect2>
</refsect1>
<refsect1>
<title>Functions</title>
<refsect2 id="function-atk--relation-type-register">
<title>atk.relation_type_register</title>
<programlisting><methodsynopsis language="python">
<methodname>atk.relation_type_register</methodname>
<methodparam><parameter
role="keyword">name</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">name</parameter> :</term>
<listitem><simpara>a name string</simpara></listitem>
</varlistentry>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>a new one of the <xref
linkend="atk-relation-type-constants"
endterm="atk-relation-type-constants-title"></xref> that is
associated with <parameter>name</parameter></simpara></listitem>
</varlistentry>
</variablelist>
<para>Associate <parameter>name</parameter> with a new one of the <xref
linkend="atk-relation-type-constants"
endterm="atk-relation-type-constants-title"></xref>.</para>
</refsect2>
<refsect2 id="function-atk--relation-type-get-name">
<title>atk.relation_type_get_name</title>
<programlisting><methodsynopsis language="python">
<methodname>atk.relation_type_get_name</methodname>
<methodparam><parameter
role="keyword">type</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">type</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>the string associated with
<parameter>relationship</parameter>.</simpara></listitem>
</varlistentry>
</variablelist>
<para>Gets the description string describing the relation type
specified by <parameter>type</parameter>.</para>
</refsect2>
<refsect2 id="function-atk--relation-type-for-name">
<title>atk.relation_type_for_name</title>
<programlisting><methodsynopsis language="python">
<methodname>atk.relation_type_for_name</methodname>
<methodparam><parameter
role="keyword">name</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">name</parameter> :</term>
<listitem><simpara>a string which is the (non-localized) name of
an ATK relation type.</simpara></listitem>
</varlistentry>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>the matching type of the <xref
linkend="atk-relation-type-constants"
endterm="atk-relation-type-constants-title"></xref> corresponding
to the specified <parameter>name</parameter>, or
<literal>atk.RELATION_NULL</literal> if no matching relation type
is found.</simpara></listitem>
</varlistentry>
</variablelist>
<para>Get the relation type corresponding to the specified
<parameter>name</parameter>.</para>
</refsect2>
</refsect1>
</refentry>
|
