This file is indexed.

/usr/share/gtk-doc/html/libatspi/AtspiMatchRule.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
176
177
178
179
<!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-matchrule</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-image.html" title="atspi-image">
<link rel="next" href="libatspi-atspi-document.html" title="atspi-document">
<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-image.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-document.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#AtspiMatchRule.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#AtspiMatchRule.description" class="shortcut">Description</a>
                   | 
                  <a href="#AtspiMatchRule.object-hierarchy" class="shortcut">Object Hierarchy</a>
</td></tr>
</table>
<div class="refentry">
<a name="AtspiMatchRule"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="AtspiMatchRule.top_of_page"></a>atspi-matchrule</span></h2>
<p>atspi-matchrule — An interface that allows the definition of match rules
for accessible objects.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="AtspiMatchRule.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">struct              <a class="link" href="AtspiMatchRule.html#AtspiMatchRule-struct" title="struct AtspiMatchRule">AtspiMatchRule</a>;
struct              <a class="link" href="AtspiMatchRule.html#AtspiMatchRuleClass" title="struct AtspiMatchRuleClass">AtspiMatchRuleClass</a>;
<a class="link" href="AtspiMatchRule.html" title="atspi-matchrule"><span class="returnvalue">AtspiMatchRule</span></a> *    <a class="link" href="AtspiMatchRule.html#atspi-match-rule-new" title="atspi_match_rule_new ()">atspi_match_rule_new</a>                (<em class="parameter"><code><a class="link" href="AtspiStateSet.html" title="atspi-stateset"><span class="type">AtspiStateSet</span></a> *states</code></em>,
                                                         <em class="parameter"><code><a class="link" href="libatspi-atspi-constants.html#AtspiCollectionMatchType" title="enum AtspiCollectionMatchType"><span class="type">AtspiCollectionMatchType</span></a> statematchtype</code></em>,
                                                         <em class="parameter"><code><span class="type">GHashTable</span> *attributes</code></em>,
                                                         <em class="parameter"><code><a class="link" href="libatspi-atspi-constants.html#AtspiCollectionMatchType" title="enum AtspiCollectionMatchType"><span class="type">AtspiCollectionMatchType</span></a> attributematchtype</code></em>,
                                                         <em class="parameter"><code><span class="type">GArray</span> *roles</code></em>,
                                                         <em class="parameter"><code><a class="link" href="libatspi-atspi-constants.html#AtspiCollectionMatchType" title="enum AtspiCollectionMatchType"><span class="type">AtspiCollectionMatchType</span></a> rolematchtype</code></em>,
                                                         <em class="parameter"><code><span class="type">GArray</span> *interfaces</code></em>,
                                                         <em class="parameter"><code><a class="link" href="libatspi-atspi-constants.html#AtspiCollectionMatchType" title="enum AtspiCollectionMatchType"><span class="type">AtspiCollectionMatchType</span></a> interfacematchtype</code></em>,
                                                         <em class="parameter"><code><span class="type">gboolean</span> invert</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="AtspiMatchRule.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
  GObject
   +----AtspiMatchRule
</pre>
</div>
<div class="refsect1">
<a name="AtspiMatchRule.description"></a><h2>Description</h2>
<p>
An interface that allows the definition of match rules
for accessible objects.
</p>
</div>
<div class="refsect1">
<a name="AtspiMatchRule.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="AtspiMatchRule-struct"></a><h3>struct AtspiMatchRule</h3>
<pre class="programlisting">struct AtspiMatchRule;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="AtspiMatchRuleClass"></a><h3>struct AtspiMatchRuleClass</h3>
<pre class="programlisting">struct AtspiMatchRuleClass {
  GObjectClass parent_class;
};
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="atspi-match-rule-new"></a><h3>atspi_match_rule_new ()</h3>
<pre class="programlisting"><a class="link" href="AtspiMatchRule.html" title="atspi-matchrule"><span class="returnvalue">AtspiMatchRule</span></a> *    atspi_match_rule_new                (<em class="parameter"><code><a class="link" href="AtspiStateSet.html" title="atspi-stateset"><span class="type">AtspiStateSet</span></a> *states</code></em>,
                                                         <em class="parameter"><code><a class="link" href="libatspi-atspi-constants.html#AtspiCollectionMatchType" title="enum AtspiCollectionMatchType"><span class="type">AtspiCollectionMatchType</span></a> statematchtype</code></em>,
                                                         <em class="parameter"><code><span class="type">GHashTable</span> *attributes</code></em>,
                                                         <em class="parameter"><code><a class="link" href="libatspi-atspi-constants.html#AtspiCollectionMatchType" title="enum AtspiCollectionMatchType"><span class="type">AtspiCollectionMatchType</span></a> attributematchtype</code></em>,
                                                         <em class="parameter"><code><span class="type">GArray</span> *roles</code></em>,
                                                         <em class="parameter"><code><a class="link" href="libatspi-atspi-constants.html#AtspiCollectionMatchType" title="enum AtspiCollectionMatchType"><span class="type">AtspiCollectionMatchType</span></a> rolematchtype</code></em>,
                                                         <em class="parameter"><code><span class="type">GArray</span> *interfaces</code></em>,
                                                         <em class="parameter"><code><a class="link" href="libatspi-atspi-constants.html#AtspiCollectionMatchType" title="enum AtspiCollectionMatchType"><span class="type">AtspiCollectionMatchType</span></a> interfacematchtype</code></em>,
                                                         <em class="parameter"><code><span class="type">gboolean</span> invert</code></em>);</pre>
<p>
Creates a new <a class="link" href="AtspiMatchRule.html" title="atspi-matchrule"><span class="type">AtspiMatchRule</span></a> with specified <em class="parameter"><code>states</code></em>, <em class="parameter"><code>attributes</code></em>, 
<em class="parameter"><code>interfaces</code></em>, and <em class="parameter"><code>roles</code></em>.
</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>states</code></em> :</span></p></td>
<td>An <a class="link" href="AtspiStateSet.html" title="atspi-stateset"><span class="type">AtspiStateSet</span></a> specifying the states to match or NULL if none.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>statematchtype</code></em> :</span></p></td>
<td>An <a class="link" href="libatspi-atspi-constants.html#AtspiCollectionMatchType" title="enum AtspiCollectionMatchType"><span class="type">AtspiCollectionMatchType</span></a> specifying how to interpret
<em class="parameter"><code>states</code></em>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>attributes</code></em> :</span></p></td>
<td>A <span class="type">GHashTable</span> specifying
attributes to match. To specify multiple attribute values,
separate each value with a :: If an attribute value contains a :,
then it can be escaped by preceding it with a \. A backslash can
likewise be escaped by inserting a double backslash. <span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> gchar* gchar*]</span>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>attributematchtype</code></em> :</span></p></td>
<td>An <a class="link" href="libatspi-atspi-constants.html#AtspiCollectionMatchType" title="enum AtspiCollectionMatchType"><span class="type">AtspiCollectionMatchType</span></a> specifying how to
interpret <em class="parameter"><code>attributes</code></em>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>roles</code></em> :</span></p></td>
<td>A <span class="type">GArray</span> of roles to match, or NULL if
not applicable. <span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> AtspiRole]</span>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>rolematchtype</code></em> :</span></p></td>
<td>An <a class="link" href="libatspi-atspi-constants.html#AtspiCollectionMatchType" title="enum AtspiCollectionMatchType"><span class="type">AtspiCollectionMatchType</span></a> specifying how to
interpret <em class="parameter"><code>roles</code></em>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>interfaces</code></em> :</span></p></td>
<td>An array of interfaces to match, or
NULL if not applicable.  Interface names should be specified
by their DBus names (org.a11y.Atspi.Accessible,
org.a11y.Atspi.Component, etc). <span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> gchar*]</span>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>interfacematchtype</code></em> :</span></p></td>
<td>An <a class="link" href="libatspi-atspi-constants.html#AtspiCollectionMatchType" title="enum AtspiCollectionMatchType"><span class="type">AtspiCollectionMatchType</span></a> specifying how to
interpret <em class="parameter"><code>interfaces</code></em>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>invert</code></em> :</span></p></td>
<td>if <span class="type">TRUE</span>, the match rule should be denied (inverted); if <span class="type">FALSE</span>,
it should not. For example, if the match rule defines that a match is
an object of ROLE_HEADING which has STATE_FOCUSABLE and a click action,
inverting it would match all objects that are not of ROLE_HEADING,
focusable and clickable at the same time.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>A new <a class="link" href="AtspiMatchRule.html" title="atspi-matchrule"><span class="type">AtspiMatchRule</span></a>. <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>