← Back to branch summary

~ubuntu-branches/ubuntu/precise/atk1.0/precise

« back to all changes in this revision

Viewing changes to docs/html/AtkRelation.html

  • Committer: Package Import Robot
  • Author(s): Luke Yelavich
  • Date: 2012-03-07 09:14:51 UTC
  • mfrom: (1.2.41)
  • Revision ID: package-import@ubuntu.com-20120307091451-lvrxjpc5wy2okfyt
Tags: 2.3.91-0ubuntu1
* New upstream release
  - Bug 665549: add sanity-check of atk_text_get_text
  - Bug 668441: atk_action_get_keybinding docs are confusing and need
    updating
  - Using abstract atk_object_get_name to check accessible-name
    notification
  - Updated Belarusian, Estonian, Hungarian, Turkish, Norwegian,
    Ukranian and Uyghur translations

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/html/AtkRelation.html
8
8
<link rel="up" href="atk.html" title="ATK Library">
9
9
<link rel="prev" href="AtkRegistry.html" title="AtkRegistry">
10
10
<link rel="next" href="AtkRelationSet.html" title="AtkRelationSet">
11
 
<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
 
11
<meta name="generator" content="GTK-Doc V1.18.1 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
13
</head>
14
14
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
44
44
<a name="AtkRelation.synopsis"></a><h2>Synopsis</h2>
45
45
<pre class="synopsis">struct              <a class="link" href="AtkRelation.html#AtkRelation-struct" title="struct AtkRelation">AtkRelation</a>;
46
46
enum                <a class="link" href="AtkRelation.html#AtkRelationType" title="enum AtkRelationType">AtkRelationType</a>;
47
 
<a class="link" href="AtkRelation.html#AtkRelationType" title="enum AtkRelationType"><span class="returnvalue">AtkRelationType</span></a>     <a class="link" href="AtkRelation.html#atk-relation-type-register" title="atk_relation_type_register ()">atk_relation_type_register</a>          (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>);
48
 
const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       <a class="link" href="AtkRelation.html#atk-relation-type-get-name" title="atk_relation_type_get_name ()">atk_relation_type_get_name</a>          (<em class="parameter"><code><a class="link" href="AtkRelation.html#AtkRelationType" title="enum AtkRelationType"><span class="type">AtkRelationType</span></a> type</code></em>);
49
 
<a class="link" href="AtkRelation.html#AtkRelationType" title="enum AtkRelationType"><span class="returnvalue">AtkRelationType</span></a>     <a class="link" href="AtkRelation.html#atk-relation-type-for-name" title="atk_relation_type_for_name ()">atk_relation_type_for_name</a>          (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>);
 
47
<a class="link" href="AtkRelation.html#AtkRelationType" title="enum AtkRelationType"><span class="returnvalue">AtkRelationType</span></a>     <a class="link" href="AtkRelation.html#atk-relation-type-register" title="atk_relation_type_register ()">atk_relation_type_register</a>          (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);
 
48
const <span class="returnvalue">gchar</span> *       <a class="link" href="AtkRelation.html#atk-relation-type-get-name" title="atk_relation_type_get_name ()">atk_relation_type_get_name</a>          (<em class="parameter"><code><a class="link" href="AtkRelation.html#AtkRelationType" title="enum AtkRelationType"><span class="type">AtkRelationType</span></a> type</code></em>);
 
49
<a class="link" href="AtkRelation.html#AtkRelationType" title="enum AtkRelationType"><span class="returnvalue">AtkRelationType</span></a>     <a class="link" href="AtkRelation.html#atk-relation-type-for-name" title="atk_relation_type_for_name ()">atk_relation_type_for_name</a>          (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);
50
50
<a class="link" href="AtkRelation.html" title="AtkRelation"><span class="returnvalue">AtkRelation</span></a> *       <a class="link" href="AtkRelation.html#atk-relation-new" title="atk_relation_new ()">atk_relation_new</a>                    (<em class="parameter"><code><a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> **targets</code></em>,
51
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> n_targets</code></em>,
 
51
                                                         <em class="parameter"><code><span class="type">gint</span> n_targets</code></em>,
52
52
                                                         <em class="parameter"><code><a class="link" href="AtkRelation.html#AtkRelationType" title="enum AtkRelationType"><span class="type">AtkRelationType</span></a> relationship</code></em>);
53
53
<a class="link" href="AtkRelation.html#AtkRelationType" title="enum AtkRelationType"><span class="returnvalue">AtkRelationType</span></a>     <a class="link" href="AtkRelation.html#atk-relation-get-relation-type" title="atk_relation_get_relation_type ()">atk_relation_get_relation_type</a>      (<em class="parameter"><code><a class="link" href="AtkRelation.html" title="AtkRelation"><span class="type">AtkRelation</span></a> *relation</code></em>);
54
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Pointer-Arrays.html#GPtrArray"><span class="returnvalue">GPtrArray</span></a> *         <a class="link" href="AtkRelation.html#atk-relation-get-target" title="atk_relation_get_target ()">atk_relation_get_target</a>             (<em class="parameter"><code><a class="link" href="AtkRelation.html" title="AtkRelation"><span class="type">AtkRelation</span></a> *relation</code></em>);
 
54
<span class="returnvalue">GPtrArray</span> *         <a class="link" href="AtkRelation.html#atk-relation-get-target" title="atk_relation_get_target ()">atk_relation_get_target</a>             (<em class="parameter"><code><a class="link" href="AtkRelation.html" title="AtkRelation"><span class="type">AtkRelation</span></a> *relation</code></em>);
55
55
<span class="returnvalue">void</span>                <a class="link" href="AtkRelation.html#atk-relation-add-target" title="atk_relation_add_target ()">atk_relation_add_target</a>             (<em class="parameter"><code><a class="link" href="AtkRelation.html" title="AtkRelation"><span class="type">AtkRelation</span></a> *relation</code></em>,
56
56
                                                         <em class="parameter"><code><a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> *target</code></em>);
57
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="AtkRelation.html#atk-relation-remove-target" title="atk_relation_remove_target ()">atk_relation_remove_target</a>          (<em class="parameter"><code><a class="link" href="AtkRelation.html" title="AtkRelation"><span class="type">AtkRelation</span></a> *relation</code></em>,
 
57
<span class="returnvalue">gboolean</span>            <a class="link" href="AtkRelation.html#atk-relation-remove-target" title="atk_relation_remove_target ()">atk_relation_remove_target</a>          (<em class="parameter"><code><a class="link" href="AtkRelation.html" title="AtkRelation"><span class="type">AtkRelation</span></a> *relation</code></em>,
58
58
                                                         <em class="parameter"><code><a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> *target</code></em>);
59
59
</pre>
60
60
</div>
61
61
<div class="refsect1">
62
62
<a name="AtkRelation.object-hierarchy"></a><h2>Object Hierarchy</h2>
63
63
<pre class="synopsis">
64
 
  <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
 
64
  GObject
65
65
   +----AtkRelation
66
66
</pre>
67
67
</div>
69
69
<a name="AtkRelation.properties"></a><h2>Properties</h2>
70
70
<pre class="synopsis">
71
71
  "<a class="link" href="AtkRelation.html#AtkRelation--relation-type" title='The "relation-type" property'>relation-type</a>"            <a class="link" href="AtkRelation.html#AtkRelationType" title="enum AtkRelationType"><span class="type">AtkRelationType</span></a>       : Read / Write
72
 
  "<a class="link" href="AtkRelation.html#AtkRelation--target" title='The "target" property'>target</a>"                   <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Value-arrays.html#GValueArray"><span class="type">GValueArray</span></a>*          : Read / Write
 
72
  "<a class="link" href="AtkRelation.html#AtkRelation--target" title='The "target" property'>target</a>"                   <span class="type">GValueArray</span>*          : Read / Write
73
73
</pre>
74
74
</div>
75
75
<div class="refsect1">
220
220
<hr>
221
221
<div class="refsect2">
222
222
<a name="atk-relation-type-register"></a><h3>atk_relation_type_register ()</h3>
223
 
<pre class="programlisting"><a class="link" href="AtkRelation.html#AtkRelationType" title="enum AtkRelationType"><span class="returnvalue">AtkRelationType</span></a>     atk_relation_type_register          (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>);</pre>
 
223
<pre class="programlisting"><a class="link" href="AtkRelation.html#AtkRelationType" title="enum AtkRelationType"><span class="returnvalue">AtkRelationType</span></a>     atk_relation_type_register          (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);</pre>
224
224
<p>
225
225
Associate <em class="parameter"><code>name</code></em> with a new <a class="link" href="AtkRelation.html#AtkRelationType" title="enum AtkRelationType"><span class="type">AtkRelationType</span></a>
226
226
</p>
242
242
<hr>
243
243
<div class="refsect2">
244
244
<a name="atk-relation-type-get-name"></a><h3>atk_relation_type_get_name ()</h3>
245
 
<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       atk_relation_type_get_name          (<em class="parameter"><code><a class="link" href="AtkRelation.html#AtkRelationType" title="enum AtkRelationType"><span class="type">AtkRelationType</span></a> type</code></em>);</pre>
 
245
<pre class="programlisting">const <span class="returnvalue">gchar</span> *       atk_relation_type_get_name          (<em class="parameter"><code><a class="link" href="AtkRelation.html#AtkRelationType" title="enum AtkRelationType"><span class="type">AtkRelationType</span></a> type</code></em>);</pre>
246
246
<p>
247
247
Gets the description string describing the <a class="link" href="AtkRelation.html#AtkRelationType" title="enum AtkRelationType"><span class="type">AtkRelationType</span></a> <em class="parameter"><code>type</code></em>.
248
248
</p>
263
263
<hr>
264
264
<div class="refsect2">
265
265
<a name="atk-relation-type-for-name"></a><h3>atk_relation_type_for_name ()</h3>
266
 
<pre class="programlisting"><a class="link" href="AtkRelation.html#AtkRelationType" title="enum AtkRelationType"><span class="returnvalue">AtkRelationType</span></a>     atk_relation_type_for_name          (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>);</pre>
 
266
<pre class="programlisting"><a class="link" href="AtkRelation.html#AtkRelationType" title="enum AtkRelationType"><span class="returnvalue">AtkRelationType</span></a>     atk_relation_type_for_name          (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);</pre>
267
267
<p>
268
268
Get the <a class="link" href="AtkRelation.html#AtkRelationType" title="enum AtkRelationType"><span class="type">AtkRelationType</span></a> type corresponding to a relation name.
269
269
</p>
286
286
<div class="refsect2">
287
287
<a name="atk-relation-new"></a><h3>atk_relation_new ()</h3>
288
288
<pre class="programlisting"><a class="link" href="AtkRelation.html" title="AtkRelation"><span class="returnvalue">AtkRelation</span></a> *       atk_relation_new                    (<em class="parameter"><code><a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> **targets</code></em>,
289
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> n_targets</code></em>,
 
289
                                                         <em class="parameter"><code><span class="type">gint</span> n_targets</code></em>,
290
290
                                                         <em class="parameter"><code><a class="link" href="AtkRelation.html#AtkRelationType" title="enum AtkRelationType"><span class="type">AtkRelationType</span></a> relationship</code></em>);</pre>
291
291
<p>
292
292
Create a new relation for the specified key and the specified list
345
345
<hr>
346
346
<div class="refsect2">
347
347
<a name="atk-relation-get-target"></a><h3>atk_relation_get_target ()</h3>
348
 
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Pointer-Arrays.html#GPtrArray"><span class="returnvalue">GPtrArray</span></a> *         atk_relation_get_target             (<em class="parameter"><code><a class="link" href="AtkRelation.html" title="AtkRelation"><span class="type">AtkRelation</span></a> *relation</code></em>);</pre>
 
348
<pre class="programlisting"><span class="returnvalue">GPtrArray</span> *         atk_relation_get_target             (<em class="parameter"><code><a class="link" href="AtkRelation.html" title="AtkRelation"><span class="type">AtkRelation</span></a> *relation</code></em>);</pre>
349
349
<p>
350
350
Gets the target list of <em class="parameter"><code>relation</code></em>
351
351
</p>
394
394
<hr>
395
395
<div class="refsect2">
396
396
<a name="atk-relation-remove-target"></a><h3>atk_relation_remove_target ()</h3>
397
 
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            atk_relation_remove_target          (<em class="parameter"><code><a class="link" href="AtkRelation.html" title="AtkRelation"><span class="type">AtkRelation</span></a> *relation</code></em>,
 
397
<pre class="programlisting"><span class="returnvalue">gboolean</span>            atk_relation_remove_target          (<em class="parameter"><code><a class="link" href="AtkRelation.html" title="AtkRelation"><span class="type">AtkRelation</span></a> *relation</code></em>,
398
398
                                                         <em class="parameter"><code><a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> *target</code></em>);</pre>
399
399
<p>
400
400
Remove the specified AtkObject from the target for the relation.
431
431
<hr>
432
432
<div class="refsect2">
433
433
<a name="AtkRelation--target"></a><h3>The <code class="literal">"target"</code> property</h3>
434
 
<pre class="programlisting">  "target"                   <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Value-arrays.html#GValueArray"><span class="type">GValueArray</span></a>*          : Read / Write</pre>
 
434
<pre class="programlisting">  "target"                   <span class="type">GValueArray</span>*          : Read / Write</pre>
435
435
<p>An array of the targets for the relation.</p>
436
436
</div>
437
437
</div>
438
438
</div>
439
439
<div class="footer">
440
440
<hr>
441
 
          Generated by GTK-Doc V1.18</div>
 
441
          Generated by GTK-Doc V1.18.1</div>
442
442
</body>
443
443
</html>
 
 
b'\\ No newline at end of file'