doc/libatspi/html/AtspiMatchRule.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2 <html>
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
   5 <title>atspi-matchrule</title>
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.77.1">
   7 <link rel="home" href="index.html" title="libatspi Reference Manual">
   8 <link rel="up" href="ch01.html" title="API reference">
   9 <link rel="prev" href="libatspi-atspi-image.html" title="atspi-image">
  10 <link rel="next" href="libatspi-atspi-document.html" title="atspi-document">
  11 <meta name="generator" content="GTK-Doc V1.18.1 (XML mode)">
  12 <link rel="stylesheet" href="style.css" type="text/css">
  13 </head>
  14 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  15 <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
  16 <tr valign="middle">
  17 <td><a accesskey="p" href="libatspi-atspi-image.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
  18 <td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
  19 <td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
  20 <th width="100%" align="center">libatspi Reference Manual</th>
  21 <td><a accesskey="n" href="libatspi-atspi-document.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
  22 </tr>
  23 <tr><td colspan="5" class="shortcuts">
  24 <a href="#AtspiMatchRule.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#AtspiMatchRule.description" class="shortcut">Description</a>
  27                    |
  28                   <a href="#AtspiMatchRule.object-hierarchy" class="shortcut">Object Hierarchy</a>
  29 </td></tr>
  30 </table>
  31 <div class="refentry">
  32 <a name="AtspiMatchRule"></a><div class="titlepage"></div>
  33 <div class="refnamediv"><table width="100%"><tr>
  34 <td valign="top">
  35 <h2><span class="refentrytitle"><a name="AtspiMatchRule.top_of_page"></a>atspi-matchrule</span></h2>
  36 <p>atspi-matchrule — An interface that allows the definition of match rules
  37 for accessible objects.</p>
  38 </td>
  39 <td valign="top" align="right"></td>
  40 </tr></table></div>
  41 <div class="refsynopsisdiv">
  42 <a name="AtspiMatchRule.synopsis"></a><h2>Synopsis</h2>
  43 <pre class="synopsis">struct              <a class="link" href="AtspiMatchRule.html#AtspiMatchRule-struct" title="struct AtspiMatchRule">AtspiMatchRule</a>;
  44 struct              <a class="link" href="AtspiMatchRule.html#AtspiMatchRuleClass" title="struct AtspiMatchRuleClass">AtspiMatchRuleClass</a>;
  45 <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>,
  46                                                          <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>,
  47                                                          <em class="parameter"><code><a href="../glib/glib-Hash-Tables.html#GHashTable"><span class="type">GHashTable</span></a> *attributes</code></em>,
  48                                                          <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>,
  49                                                          <em class="parameter"><code><a href="../glib/glib-Arrays.html#GArray"><span class="type">GArray</span></a> *roles</code></em>,
  50                                                          <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>,
  51                                                          <em class="parameter"><code><a href="../glib/glib-Arrays.html#GArray"><span class="type">GArray</span></a> *interfaces</code></em>,
  52                                                          <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>,
  53                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> invert</code></em>);
  54 </pre>
  55 </div>
  56 <div class="refsect1">
  57 <a name="AtspiMatchRule.object-hierarchy"></a><h2>Object Hierarchy</h2>
  58 <pre class="synopsis">
  59   <a href="../gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a>
  60    +----AtspiMatchRule
  61 </pre>
  62 </div>
  63 <div class="refsect1">
  64 <a name="AtspiMatchRule.description"></a><h2>Description</h2>
  65 <p>
  66 An interface that allows the definition of match rules
  67 for accessible objects.
  68 </p>
  69 </div>
  70 <div class="refsect1">
  71 <a name="AtspiMatchRule.details"></a><h2>Details</h2>
  72 <div class="refsect2">
  73 <a name="AtspiMatchRule-struct"></a><h3>struct AtspiMatchRule</h3>
  74 <pre class="programlisting">struct AtspiMatchRule;</pre>
  75 <p>
  76 </p>
  77 </div>
  78 <hr>
  79 <div class="refsect2">
  80 <a name="AtspiMatchRuleClass"></a><h3>struct AtspiMatchRuleClass</h3>
  81 <pre class="programlisting">struct AtspiMatchRuleClass {
  82   GObjectClass parent_class;
  83 };
  84 </pre>
  85 <p>
  86 </p>
  87 </div>
  88 <hr>
  89 <div class="refsect2">
  90 <a name="atspi-match-rule-new"></a><h3>atspi_match_rule_new ()</h3>
  91 <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>,
  92                                                          <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>,
  93                                                          <em class="parameter"><code><a href="../glib/glib-Hash-Tables.html#GHashTable"><span class="type">GHashTable</span></a> *attributes</code></em>,
  94                                                          <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>,
  95                                                          <em class="parameter"><code><a href="../glib/glib-Arrays.html#GArray"><span class="type">GArray</span></a> *roles</code></em>,
  96                                                          <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>,
  97                                                          <em class="parameter"><code><a href="../glib/glib-Arrays.html#GArray"><span class="type">GArray</span></a> *interfaces</code></em>,
  98                                                          <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>,
  99                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> invert</code></em>);</pre>
 100 <p>
 101 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>,
 102 <em class="parameter"><code>interfaces</code></em>, and <em class="parameter"><code>roles</code></em>.
 103 </p>
 104 <div class="variablelist"><table border="0" class="variablelist">
 105 <colgroup>
 106 <col align="left" valign="top">
 107 <col>
 108 </colgroup>
 109 <tbody>
 110 <tr>
 111 <td><p><span class="term"><em class="parameter"><code>states</code></em> :</span></p></td>
 112 <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>
 113 </tr>
 114 <tr>
 115 <td><p><span class="term"><em class="parameter"><code>statematchtype</code></em> :</span></p></td>
 116 <td>An <a class="link" href="libatspi-atspi-constants.html#AtspiCollectionMatchType" title="enum AtspiCollectionMatchType"><span class="type">AtspiCollectionMatchType</span></a> specifying how to interpret
 117 <em class="parameter"><code>states</code></em>.</td>
 118 </tr>
 119 <tr>
 120 <td><p><span class="term"><em class="parameter"><code>attributes</code></em> :</span></p></td>
 121 <td>A <a href="../glib/glib-Hash-Tables.html#GHashTable"><span class="type">GHashTable</span></a> specifying
 122 attributes to match. <span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> gchar* gchar*]</span>
 123 </td>
 124 </tr>
 125 <tr>
 126 <td><p><span class="term"><em class="parameter"><code>attributematchtype</code></em> :</span></p></td>
 127 <td>An <a class="link" href="libatspi-atspi-constants.html#AtspiCollectionMatchType" title="enum AtspiCollectionMatchType"><span class="type">AtspiCollectionMatchType</span></a> specifying how to
 128 interpret <em class="parameter"><code>attributes</code></em>.</td>
 129 </tr>
 130 <tr>
 131 <td><p><span class="term"><em class="parameter"><code>roles</code></em> :</span></p></td>
 132 <td>A <a href="../glib/glib-Arrays.html#GArray"><span class="type">GArray</span></a> of roles to match, or NULL if
 133 not applicable. <span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> AtspiRole]</span>
 134 </td>
 135 </tr>
 136 <tr>
 137 <td><p><span class="term"><em class="parameter"><code>rolematchtype</code></em> :</span></p></td>
 138 <td>An <a class="link" href="libatspi-atspi-constants.html#AtspiCollectionMatchType" title="enum AtspiCollectionMatchType"><span class="type">AtspiCollectionMatchType</span></a> specifying how to
 139 interpret <em class="parameter"><code>roles</code></em>.</td>
 140 </tr>
 141 <tr>
 142 <td><p><span class="term"><em class="parameter"><code>interfaces</code></em> :</span></p></td>
 143 <td>An array of interfaces to match, or
 144 NULL if not applicable.  Interface names should be specified
 145 by their DBus names (org.a11y.Atspi.Accessible,
 146 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>
 147 </td>
 148 </tr>
 149 <tr>
 150 <td><p><span class="term"><em class="parameter"><code>interfacematchtype</code></em> :</span></p></td>
 151 <td>An <a class="link" href="libatspi-atspi-constants.html#AtspiCollectionMatchType" title="enum AtspiCollectionMatchType"><span class="type">AtspiCollectionMatchType</span></a> specifying how to
 152 interpret <em class="parameter"><code>interfaces</code></em>.</td>
 153 </tr>
 154 <tr>
 155 <td><p><span class="term"><em class="parameter"><code>invert</code></em> :</span></p></td>
 156 <td>if <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><span class="type">TRUE</span></a>, the match rule should be denied (inverted); if <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><span class="type">FALSE</span></a>,
 157 it should not. For example, if the match rule defines that a match is
 158 an object of ROLE_HEADING which has STATE_FOCUSABLE and a click action,
 159 inverting it would match all objects that are not of ROLE_HEADING,
 160 focusable and clickable at the same time.</td>
 161 </tr>
 162 <tr>
 163 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 164 <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>
 165 </td>
 166 </tr>
 167 </tbody>
 168 </table></div>
 169 </div>
 170 </div>
 171 </div>
 172 <div class="footer">
 173 <hr>
 174           Generated by GTK-Doc V1.18.1</div>
 175 </body>
 176 </html>