doc/reference/cally/html/CallyRoot.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>CallyRoot</title>
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
   7 <link rel="home" href="index.html" title="Cally Reference Manual">
   8 <link rel="up" href="ch02.html" title="Utility API">
   9 <link rel="prev" href="CallyUtil.html" title="CallyUtil">
  10 <link rel="next" href="callyobjects.html" title="Part III. Cally Actors and Objects">
  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="CallyUtil.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
  18 <td><a accesskey="u" href="ch02.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">Cally Reference Manual</th>
  21 <td><a accesskey="n" href="callyobjects.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="#CallyRoot.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#CallyRoot.description" class="shortcut">Description</a>
  27                    |
  28                   <a href="#CallyRoot.object-hierarchy" class="shortcut">Object Hierarchy</a>
  29 </td></tr>
  30 </table>
  31 <div class="refentry">
  32 <a name="CallyRoot"></a><div class="titlepage"></div>
  33 <div class="refnamediv"><table width="100%"><tr>
  34 <td valign="top">
  35 <h2><span class="refentrytitle"><a name="CallyRoot.top_of_page"></a>CallyRoot</span></h2>
  36 <p>CallyRoot — Root object for the Cally toolkit</p>
  37 </td>
  38 <td valign="top" align="right"></td>
  39 </tr></table></div>
  40 <div class="refsynopsisdiv">
  41 <a name="CallyRoot.synopsis"></a><h2>Synopsis</h2>
  42 <pre class="synopsis">struct              <a class="link" href="CallyRoot.html#CallyRoot-struct" title="struct CallyRoot">CallyRoot</a>;
  43 struct              <a class="link" href="CallyRoot.html#CallyRootClass" title="struct CallyRootClass">CallyRootClass</a>;
  44 <span class="returnvalue">AtkObject</span> *         <a class="link" href="CallyRoot.html#cally-root-new" title="cally_root_new ()">cally_root_new</a>                      (<em class="parameter"><code><span class="type">void</span></code></em>);
  45 </pre>
  46 </div>
  47 <div class="refsect1">
  48 <a name="CallyRoot.object-hierarchy"></a><h2>Object Hierarchy</h2>
  49 <pre class="synopsis">
  50   GObject
  51    +----AtkObject
  52          +----AtkGObjectAccessible
  53                +----CallyRoot
  54 </pre>
  55 </div>
  56 <div class="refsect1">
  57 <a name="CallyRoot.description"></a><h2>Description</h2>
  58 <p>
  59 <a class="link" href="CallyRoot.html" title="CallyRoot"><span class="type">CallyRoot</span></a> is the root object of the accessibility tree-like
  60 hierarchy, exposing the application level.
  61 </p>
  62 <p>
  63 Somewhat equivalent to <span class="type">GailTopLevel</span>. We consider that this class
  64 expose the a11y information of the <a href="../clutter/clutter-Stage-Manager.html#ClutterStageManager"><span class="type">ClutterStageManager</span></a>, as the
  65 children of this object are the different ClutterStage managed (so
  66 the <span class="type">GObject</span> used in the <code class="function">atk_object_initialize()</code> is the
  67 <a href="../clutter/clutter-Stage-Manager.html#ClutterStageManager"><span class="type">ClutterStageManager</span></a>).
  68 </p>
  69 </div>
  70 <div class="refsect1">
  71 <a name="CallyRoot.details"></a><h2>Details</h2>
  72 <div class="refsect2">
  73 <a name="CallyRoot-struct"></a><h3>struct CallyRoot</h3>
  74 <pre class="programlisting">struct CallyRoot;</pre>
  75 <p>
  76 The <span class="structname">CallyRoot</span> structure contains only private
  77 data and should be accessed using the provided API
  78 </p>
  79 <p class="since">Since 1.4</p>
  80 </div>
  81 <hr>
  82 <div class="refsect2">
  83 <a name="CallyRootClass"></a><h3>struct CallyRootClass</h3>
  84 <pre class="programlisting">struct CallyRootClass {
  85 };
  86 </pre>
  87 <p>
  88 The <span class="structname">CallyRootClass</span> structure contains only
  89 private data
  90 </p>
  91 <p class="since">Since 1.4</p>
  92 </div>
  93 <hr>
  94 <div class="refsect2">
  95 <a name="cally-root-new"></a><h3>cally_root_new ()</h3>
  96 <pre class="programlisting"><span class="returnvalue">AtkObject</span> *         cally_root_new                      (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
  97 <p>
  98 Creates a new <a class="link" href="CallyRoot.html" title="CallyRoot"><span class="type">CallyRoot</span></a> object.
  99 </p>
 100 <div class="variablelist"><table border="0">
 101 <col align="left" valign="top">
 102 <tbody><tr>
 103 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 104 <td>the newly created <span class="type">AtkObject</span>
 105 </td>
 106 </tr></tbody>
 107 </table></div>
 108 <p class="since">Since 1.4</p>
 109 </div>
 110 </div>
 111 <div class="refsect1">
 112 <a name="CallyRoot.see-also"></a><h2>See Also</h2>
 113 <a href="../clutter/ClutterStage.html"><span class="type">ClutterStage</span></a>
 114 </div>
 115 </div>
 116 <div class="footer">
 117 <hr>
 118           Generated by GTK-Doc V1.18.1</div>
 119 </body>
 120 </html>