docs/reference/html/gi-gir-reference.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>The GIR XML format</title>
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
   7 <link rel="home" href="index.html" title="GObject Introspection Reference Manual">
   8 <link rel="up" href="gi-gir.html" title="Part II. GIR markup format">
   9 <link rel="prev" href="gi-gir.html" title="Part II. GIR markup format">
  10 <link rel="next" href="gi-typelib.html" title="Typelib binary format">
  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"><tr valign="middle">
  16 <td><a accesskey="p" href="gi-gir.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
  17 <td><a accesskey="u" href="gi-gir.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
  18 <td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
  19 <th width="100%" align="center">GObject Introspection Reference Manual</th>
  20 <td><a accesskey="n" href="gi-typelib.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
  21 </tr></table>
  22 <div class="chapter">
  23 <div class="titlepage"><div><div><h2 class="title">
  24 <a name="gi-gir-reference"></a>The GIR XML format</h2></div></div></div>
  25 <p>
  26     This chapter describes the GIR XML markup format.
  27   </p>
  28 <div class="refsect2">
  29 <a name="gi-gir-api"></a><h3>
  30 <span class="emphasis"><em>api</em></span> node</h3>
  31
  32      The root node of all GIR documents is the api node.
  33
  34      Possible children: <a href="gi-gir-reference.html#gi-gir-namespace">namespace</a>.
  35
  36      <div class="example">
  37 <a name="id481079"></a><p class="title"><b>Example 4. A GIR fragment showing an api node</b></p>
  38 <div class="example-contents">
  39   <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
  40     <tbody>
  41       <tr>
  42         <td class="listing_lines" align="right"><pre>1
  43 2
  44 3</pre></td>
  45         <td class="listing_code"><pre class="programlisting"><span class="symbol">&lt;</span><span class="usertype">api</span><span class="normal"> version</span><span class="symbol">=</span><span class="string">"1.0"</span><span class="symbol">&gt;</span>
  46 <span class="normal">  </span><span class="symbol">&lt;</span><span class="normal">namespace</span><span class="symbol">/&gt;</span>
  47 <span class="symbol">&lt;/</span><span class="normal">api</span><span class="symbol">&gt;</span></pre></td>
  48       </tr>
  49     </tbody>
  50   </table>
  51 </div>
  52
  53 </div>
  54 <br class="example-break">
  55 </div>
  56 <hr>
  57 <div class="refsect2">
  58 <a name="gi-gir-namespace"></a><h3>
  59 <span class="emphasis"><em>namespace</em></span> node</h3>
  60
  61      Parent node: <a href="gi-gir-reference.html#gi-gir-api">api</a>.
  62      Possible children: callback,
  63      <a href="gi-gir-reference.html#gi-gir-class">class</a>,
  64      <a href="gi-gir-reference.html#gi-gir-function">function</a>.
  65      <a href="gi-gir-reference.html#gi-gir-interface">interface</a>.
  66
  67      <div class="example">
  68 <a name="id488486"></a><p class="title"><b>Example 5. A GIR fragment showing an namespace node</b></p>
  69 <div class="example-contents">
  70   <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
  71     <tbody>
  72       <tr>
  73         <td class="listing_lines" align="right"><pre>1
  74 2
  75 3
  76 4
  77 5
  78 6</pre></td>
  79         <td class="listing_code"><pre class="programlisting"><span class="symbol">&lt;</span><span class="usertype">api</span><span class="normal"> version</span><span class="symbol">=</span><span class="string">"1.0"</span><span class="symbol">&gt;</span>
  80 <span class="normal">  </span><span class="symbol">&lt;</span><span class="normal">namespace</span><span class="symbol">=</span><span class="string">"Gtk"</span><span class="symbol">&gt;</span>
  81 <span class="normal">     </span><span class="symbol">&lt;</span><span class="normal">class</span><span class="symbol">/&gt;</span>
  82 <span class="normal">     </span><span class="symbol">&lt;</span><span class="normal">function</span><span class="symbol">/&gt;</span>
  83 <span class="normal">  </span><span class="symbol">&lt;/</span><span class="normal">namespace</span><span class="symbol">&gt;</span>
  84 <span class="symbol">&lt;/</span><span class="normal">api</span><span class="symbol">&gt;</span></pre></td>
  85       </tr>
  86     </tbody>
  87   </table>
  88 </div>
  89
  90 </div>
  91 <br class="example-break">
  92 </div>
  93 <hr>
  94 <div class="refsect2">
  95 <a name="gi-gir-class"></a><h3>
  96 <span class="emphasis"><em>class</em></span> node</h3>
  97
  98      Parent node: <a href="gi-gir-reference.html#gi-gir-namespace">namespace</a>.
  99      Possible children: <a href="gi-gir-reference.html#gi-gir-class">constructor</a>,
 100      field,
 101      method,
 102      property.
 103      <div class="example">
 104 <a name="id518920"></a><p class="title"><b>Example 6. A GIR fragment showing an class node</b></p>
 105 <div class="example-contents">
 106   <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
 107     <tbody>
 108       <tr>
 109         <td class="listing_lines" align="right"><pre>1
 110 2
 111 3
 112 4
 113 5
 114 6
 115 7
 116 8
 117 9
 118 10</pre></td>
 119         <td class="listing_code"><pre class="programlisting"><span class="symbol">&lt;</span><span class="usertype">api</span><span class="normal"> version</span><span class="symbol">=</span><span class="string">"1.0"</span><span class="symbol">&gt;</span>
 120 <span class="normal">  </span><span class="symbol">&lt;</span><span class="normal">namespace</span><span class="symbol">=</span><span class="string">"Gtk"</span><span class="symbol">&gt;</span>
 121 <span class="normal">    </span><span class="symbol">&lt;</span><span class="usertype">class</span><span class="normal"> name</span><span class="symbol">=</span><span class="string">"Widget"</span><span class="symbol">&gt;</span>
 122 <span class="normal">       </span><span class="symbol">&lt;</span><span class="normal">constructor</span><span class="symbol">/&gt;</span>
 123 <span class="normal">       </span><span class="symbol">&lt;</span><span class="normal">field</span><span class="symbol">/&gt;</span>
 124 <span class="normal">       </span><span class="symbol">&lt;</span><span class="normal">method</span><span class="symbol">/&gt;</span>
 125 <span class="normal">       </span><span class="symbol">&lt;</span><span class="normal">property</span><span class="symbol">/&gt;</span>
 126 <span class="normal">    </span><span class="symbol">&lt;</span><span class="normal">class</span><span class="symbol">&gt;</span>
 127 <span class="normal">  </span><span class="symbol">&lt;/</span><span class="normal">namespace</span><span class="symbol">&gt;</span>
 128 <span class="symbol">&lt;/</span><span class="normal">api</span><span class="symbol">&gt;</span></pre></td>
 129       </tr>
 130     </tbody>
 131   </table>
 132 </div>
 133
 134 </div>
 135 <br class="example-break">
 136 </div>
 137 <hr>
 138 <div class="refsect2">
 139 <a name="gi-gir-interface"></a><h3>
 140 <span class="emphasis"><em>interface</em></span> node</h3>
 141
 142      Parent node: <a href="gi-gir-reference.html#gi-gir-namespace">namespace</a>.
 143      Possible children: field,
 144      method,
 145      property.
 146      <div class="example">
 147 <a name="id506234"></a><p class="title"><b>Example 7. A GIR fragment showing an interface node</b></p>
 148 <div class="example-contents">
 149   <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
 150     <tbody>
 151       <tr>
 152         <td class="listing_lines" align="right"><pre>1
 153 2
 154 3
 155 4
 156 5
 157 6
 158 7
 159 8
 160 9</pre></td>
 161         <td class="listing_code"><pre class="programlisting"><span class="symbol">&lt;</span><span class="usertype">api</span><span class="normal"> version</span><span class="symbol">=</span><span class="string">"1.0"</span><span class="symbol">&gt;</span>
 162 <span class="normal">  </span><span class="symbol">&lt;</span><span class="normal">namespace</span><span class="symbol">=</span><span class="string">"Gtk"</span><span class="symbol">&gt;</span>
 163 <span class="normal">    </span><span class="symbol">&lt;</span><span class="usertype">interface</span><span class="normal"> name</span><span class="symbol">=</span><span class="string">"Buildable"</span><span class="symbol">&gt;</span>
 164 <span class="normal">       </span><span class="symbol">&lt;</span><span class="normal">field</span><span class="symbol">/&gt;</span>
 165 <span class="normal">       </span><span class="symbol">&lt;</span><span class="normal">method</span><span class="symbol">/&gt;</span>
 166 <span class="normal">       </span><span class="symbol">&lt;</span><span class="normal">property</span><span class="symbol">/&gt;</span>
 167 <span class="normal">    </span><span class="symbol">&lt;</span><span class="normal">interface</span><span class="symbol">&gt;</span>
 168 <span class="normal">  </span><span class="symbol">&lt;/</span><span class="normal">namespace</span><span class="symbol">&gt;</span>
 169 <span class="symbol">&lt;/</span><span class="normal">api</span><span class="symbol">&gt;</span></pre></td>
 170       </tr>
 171     </tbody>
 172   </table>
 173 </div>
 174
 175 </div>
 176 <br class="example-break">
 177 </div>
 178 <hr>
 179 <div class="refsect2">
 180 <a name="gi-gir-function"></a><h3>
 181 <span class="emphasis"><em>function</em></span> node</h3>
 182
 183      Parent node: <a href="gi-gir-reference.html#gi-gir-namespace">namespace</a>.
 184      <div class="example">
 185 <a name="id522284"></a><p class="title"><b>Example 8. A GIR fragment showing an function node</b></p>
 186 <div class="example-contents">
 187   <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
 188     <tbody>
 189       <tr>
 190         <td class="listing_lines" align="right"><pre>1
 191 2
 192 3
 193 4
 194 5
 195 6</pre></td>
 196         <td class="listing_code"><pre class="programlisting"><span class="symbol">&lt;</span><span class="usertype">api</span><span class="normal"> version</span><span class="symbol">=</span><span class="string">"1.0"</span><span class="symbol">&gt;</span>
 197 <span class="normal">  </span><span class="symbol">&lt;</span><span class="normal">namespace</span><span class="symbol">=</span><span class="string">"Gtk"</span><span class="symbol">&gt;</span>
 198 <span class="normal">    </span><span class="symbol">&lt;</span><span class="usertype">function</span><span class="normal"> name</span><span class="symbol">=</span><span class="string">"init"</span><span class="symbol">&gt;</span>
 199 <span class="normal">    </span><span class="symbol">&lt;/</span><span class="normal">function</span><span class="symbol">&gt;</span>
 200 <span class="normal">  </span><span class="symbol">&lt;/</span><span class="normal">namespace</span><span class="symbol">&gt;</span>
 201 <span class="symbol">&lt;/</span><span class="normal">api</span><span class="symbol">&gt;</span></pre></td>
 202       </tr>
 203     </tbody>
 204   </table>
 205 </div>
 206
 207 </div>
 208 <br class="example-break">
 209 </div>
 210 </div>
 211 <div class="footer">
 212 <hr>
 213           Generated by GTK-Doc V1.18.1</div>
 214 </body>
 215 </html>