/usr/share/gtk-doc/html/libatspi/AtspiRelation.html is in at-spi2-doc 2.10.2.is.2.10.1-0ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>atspi-relation</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="libatspi Reference Manual">
<link rel="up" href="ch01.html" title="API reference">
<link rel="prev" href="libatspi-atspi-action.html" title="atspi-action">
<link rel="next" href="libatspi-atspi-image.html" title="atspi-image">
<meta name="generator" content="GTK-Doc V1.19 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="libatspi-atspi-action.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">libatspi Reference Manual</th>
<td><a accesskey="n" href="libatspi-atspi-image.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#AtspiRelation.synopsis" class="shortcut">Top</a>
|
<a href="#AtspiRelation.description" class="shortcut">Description</a>
|
<a href="#AtspiRelation.object-hierarchy" class="shortcut">Object Hierarchy</a>
</td></tr>
</table>
<div class="refentry">
<a name="AtspiRelation"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="AtspiRelation.top_of_page"></a>atspi-relation</span></h2>
<p>atspi-relation — An interface via which non-hierarchical relationships
are indicated.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="AtspiRelation.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">struct <a class="link" href="AtspiRelation.html#AtspiRelation-struct" title="struct AtspiRelation">AtspiRelation</a>;
struct <a class="link" href="AtspiRelation.html#AtspiRelationClass" title="struct AtspiRelationClass">AtspiRelationClass</a>;
<a class="link" href="libatspi-atspi-constants.html#AtspiRelationType" title="enum AtspiRelationType"><span class="returnvalue">AtspiRelationType</span></a> <a class="link" href="AtspiRelation.html#atspi-relation-get-relation-type" title="atspi_relation_get_relation_type ()">atspi_relation_get_relation_type</a> (<em class="parameter"><code><a class="link" href="AtspiRelation.html" title="atspi-relation"><span class="type">AtspiRelation</span></a> *obj</code></em>);
<span class="returnvalue">gint</span> <a class="link" href="AtspiRelation.html#atspi-relation-get-n-targets" title="atspi_relation_get_n_targets ()">atspi_relation_get_n_targets</a> (<em class="parameter"><code><a class="link" href="AtspiRelation.html" title="atspi-relation"><span class="type">AtspiRelation</span></a> *obj</code></em>);
<a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="returnvalue">AtspiAccessible</span></a> * <a class="link" href="AtspiRelation.html#atspi-relation-get-target" title="atspi_relation_get_target ()">atspi_relation_get_target</a> (<em class="parameter"><code><a class="link" href="AtspiRelation.html" title="atspi-relation"><span class="type">AtspiRelation</span></a> *obj</code></em>,
<em class="parameter"><code><span class="type">gint</span> i</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="AtspiRelation.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
GObject
+----AtspiRelation
</pre>
</div>
<div class="refsect1">
<a name="AtspiRelation.description"></a><h2>Description</h2>
<p>
An interface via which non-hierarchical relationships
are indicated. An instance of this interface represents
a "one-to-many" correspondance.
</p>
</div>
<div class="refsect1">
<a name="AtspiRelation.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="AtspiRelation-struct"></a><h3>struct AtspiRelation</h3>
<pre class="programlisting">struct AtspiRelation;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="AtspiRelationClass"></a><h3>struct AtspiRelationClass</h3>
<pre class="programlisting">struct AtspiRelationClass {
GObjectClass parent_class;
};
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="atspi-relation-get-relation-type"></a><h3>atspi_relation_get_relation_type ()</h3>
<pre class="programlisting"><a class="link" href="libatspi-atspi-constants.html#AtspiRelationType" title="enum AtspiRelationType"><span class="returnvalue">AtspiRelationType</span></a> atspi_relation_get_relation_type (<em class="parameter"><code><a class="link" href="AtspiRelation.html" title="atspi-relation"><span class="type">AtspiRelation</span></a> *obj</code></em>);</pre>
<p>
Gets the type of relationship represented by an <a class="link" href="AtspiRelation.html" title="atspi-relation"><span class="type">AtspiRelation</span></a>.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
<td>a pointer to the <a class="link" href="AtspiRelation.html" title="atspi-relation"><span class="type">AtspiRelation</span></a> object to query.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>an <a class="link" href="libatspi-atspi-constants.html#AtspiRelationType" title="enum AtspiRelationType"><span class="type">AtspiRelationType</span></a> indicating the type of relation
encapsulated in this <a class="link" href="AtspiRelation.html" title="atspi-relation"><span class="type">AtspiRelation</span></a> object.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="atspi-relation-get-n-targets"></a><h3>atspi_relation_get_n_targets ()</h3>
<pre class="programlisting"><span class="returnvalue">gint</span> atspi_relation_get_n_targets (<em class="parameter"><code><a class="link" href="AtspiRelation.html" title="atspi-relation"><span class="type">AtspiRelation</span></a> *obj</code></em>);</pre>
<p>
Gets the number of objects which this relationship has as its
target objects (the subject is the <a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="type">AtspiAccessible</span></a> from which this
<a class="link" href="AtspiRelation.html" title="atspi-relation"><span class="type">AtspiRelation</span></a> originated).
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
<td>a pointer to the <a class="link" href="AtspiRelation.html" title="atspi-relation"><span class="type">AtspiRelation</span></a> object to query.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a <span class="type">gint</span> indicating how many target objects which the
originating <a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="type">AtspiAccessible</span></a> object has the <a class="link" href="AtspiRelation.html" title="atspi-relation"><span class="type">AtspiRelation</span></a>
relationship with.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="atspi-relation-get-target"></a><h3>atspi_relation_get_target ()</h3>
<pre class="programlisting"><a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="returnvalue">AtspiAccessible</span></a> * atspi_relation_get_target (<em class="parameter"><code><a class="link" href="AtspiRelation.html" title="atspi-relation"><span class="type">AtspiRelation</span></a> *obj</code></em>,
<em class="parameter"><code><span class="type">gint</span> i</code></em>);</pre>
<p>
Gets the <em class="parameter"><code>i</code></em>-th target of a specified <a class="link" href="AtspiRelation.html" title="atspi-relation"><span class="type">AtspiRelation</span></a> relationship.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
<td>a pointer to the <a class="link" href="AtspiRelation.html" title="atspi-relation"><span class="type">AtspiRelation</span></a> object to query.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>i</code></em> :</span></p></td>
<td>a (zero-index) <span class="type">gint</span> indicating which (of possibly several) target is requested.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>an <a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="type">AtspiAccessible</span></a> which is the <em class="parameter"><code>i</code></em>-th object
with which the originating <a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="type">AtspiAccessible</span></a> has relationship
specified in the <a class="link" href="AtspiRelation.html" title="atspi-relation"><span class="type">AtspiRelation</span></a> object. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.19</div>
</body>
</html>
|