doc/html/group__events.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   2 <html xmlns="http://www.w3.org/1999/xhtml">
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
   5 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
   6 <meta name="generator" content="Doxygen 1.8.6"/>
   7 <title>yaml: Events</title>
   8 <link href="tabs.css" rel="stylesheet" type="text/css"/>
   9 <script type="text/javascript" src="jquery.js"></script>
  10 <script type="text/javascript" src="dynsections.js"></script>
  11 <link href="doxygen.css" rel="stylesheet" type="text/css" />
  12 </head>
  13 <body>
  14 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  15 <div id="titlearea">
  16 <table cellspacing="0" cellpadding="0">
  17  <tbody>
  18  <tr style="height: 56px;">
  19   <td style="padding-left: 0.5em;">
  20    <div id="projectname">yaml
  21    &#160;<span id="projectnumber">0.1.7</span>
  22    </div>
  23   </td>
  24  </tr>
  25  </tbody>
  26 </table>
  27 </div>
  28 <!-- end header part -->
  29 <!-- Generated by Doxygen 1.8.6 -->
  30   <div id="navrow1" class="tabs">
  31     <ul class="tablist">
  32       <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  33       <li><a href="modules.html"><span>Modules</span></a></li>
  34       <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
  35       <li><a href="files.html"><span>Files</span></a></li>
  36     </ul>
  37   </div>
  38 </div><!-- top -->
  39 <div class="header">
  40   <div class="summary">
  41 <a href="#nested-classes">Data Structures</a> &#124;
  42 <a href="#typedef-members">Typedefs</a> &#124;
  43 <a href="#enum-members">Enumerations</a> &#124;
  44 <a href="#func-members">Functions</a>  </div>
  45   <div class="headertitle">
  46 <div class="title">Events</div>  </div>
  47 </div><!--header-->
  48 <div class="contents">
  49 <table class="memberdecls">
  50 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
  51 Data Structures</h2></td></tr>
  52 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structyaml__event__s.html">yaml_event_s</a></td></tr>
  53 <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">The event structure.  <a href="structyaml__event__s.html#details">More...</a><br/></td></tr>
  54 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  55 </table><table class="memberdecls">
  56 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
  57 Typedefs</h2></td></tr>
  58 <tr class="memitem:ga8934661be36bd7c9d17a8af69eff89a1"><td class="memItemLeft" align="right" valign="top">typedef enum <a class="el" href="group__events.html#ga454fccebae859c188fe3e7fa3299577c">yaml_event_type_e</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__events.html#ga8934661be36bd7c9d17a8af69eff89a1">yaml_event_type_t</a></td></tr>
  59 <tr class="memdesc:ga8934661be36bd7c9d17a8af69eff89a1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event types.  <a href="#ga8934661be36bd7c9d17a8af69eff89a1">More...</a><br/></td></tr>
  60 <tr class="separator:ga8934661be36bd7c9d17a8af69eff89a1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  61 <tr class="memitem:ga3b392d9716c4920cabefdd29e78dd542"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structyaml__event__s.html">yaml_event_s</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__events.html#ga3b392d9716c4920cabefdd29e78dd542">yaml_event_t</a></td></tr>
  62 <tr class="memdesc:ga3b392d9716c4920cabefdd29e78dd542"><td class="mdescLeft">&#160;</td><td class="mdescRight">The event structure.  <a href="#ga3b392d9716c4920cabefdd29e78dd542">More...</a><br/></td></tr>
  63 <tr class="separator:ga3b392d9716c4920cabefdd29e78dd542"><td class="memSeparator" colspan="2">&#160;</td></tr>
  64 </table><table class="memberdecls">
  65 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
  66 Enumerations</h2></td></tr>
  67 <tr class="memitem:ga454fccebae859c188fe3e7fa3299577c"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__events.html#ga454fccebae859c188fe3e7fa3299577c">yaml_event_type_e</a> { <br/>
  68 &#160;&#160;<a class="el" href="group__events.html#gga454fccebae859c188fe3e7fa3299577caefda9f31823fe534f094f4241d5e5eac">YAML_NO_EVENT</a>,
  69 <br/>
  70 &#160;&#160;<a class="el" href="group__events.html#gga454fccebae859c188fe3e7fa3299577caa742e9970f14d1fe7ce4d178d79e8465">YAML_STREAM_START_EVENT</a>,
  71 <br/>
  72 &#160;&#160;<a class="el" href="group__events.html#gga454fccebae859c188fe3e7fa3299577ca4a5e76ed540645102a13352af2503d3b">YAML_STREAM_END_EVENT</a>,
  73 <br/>
  74 &#160;&#160;<a class="el" href="group__events.html#gga454fccebae859c188fe3e7fa3299577caf4ca2b0f538029cf054cdebd09d3d6d3">YAML_DOCUMENT_START_EVENT</a>,
  75 <br/>
  76 &#160;&#160;<a class="el" href="group__events.html#gga454fccebae859c188fe3e7fa3299577ca355ec471f963827c96512e529676276f">YAML_DOCUMENT_END_EVENT</a>,
  77 <br/>
  78 &#160;&#160;<a class="el" href="group__events.html#gga454fccebae859c188fe3e7fa3299577ca8c3ce47705cfbd49a87a32bdbe544eb7">YAML_ALIAS_EVENT</a>,
  79 <br/>
  80 &#160;&#160;<a class="el" href="group__events.html#gga454fccebae859c188fe3e7fa3299577ca8b16dc795bb228e33d647d1bdf683713">YAML_SCALAR_EVENT</a>,
  81 <br/>
  82 &#160;&#160;<a class="el" href="group__events.html#gga454fccebae859c188fe3e7fa3299577cad90ccd43e238221f542defa3c8eaf093">YAML_SEQUENCE_START_EVENT</a>,
  83 <br/>
  84 &#160;&#160;<a class="el" href="group__events.html#gga454fccebae859c188fe3e7fa3299577ca2a8af98529275987d73eb307b6a92898">YAML_SEQUENCE_END_EVENT</a>,
  85 <br/>
  86 &#160;&#160;<a class="el" href="group__events.html#gga454fccebae859c188fe3e7fa3299577ca0f6982f6d1c325ee71af518c2c66dae8">YAML_MAPPING_START_EVENT</a>,
  87 <br/>
  88 &#160;&#160;<a class="el" href="group__events.html#gga454fccebae859c188fe3e7fa3299577cadc3dc55f17056a657005fecfb80fbd30">YAML_MAPPING_END_EVENT</a>
  89 <br/>
  90  }</td></tr>
  91 <tr class="memdesc:ga454fccebae859c188fe3e7fa3299577c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event types.  <a href="group__events.html#ga454fccebae859c188fe3e7fa3299577c">More...</a><br/></td></tr>
  92 <tr class="separator:ga454fccebae859c188fe3e7fa3299577c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  93 </table><table class="memberdecls">
  94 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
  95 Functions</h2></td></tr>
  96 <tr class="memitem:ga0650d255b23d9aae13c839f4ab3ec2ab"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__events.html#ga0650d255b23d9aae13c839f4ab3ec2ab">yaml_stream_start_event_initialize</a> (<a class="el" href="group__events.html#ga3b392d9716c4920cabefdd29e78dd542">yaml_event_t</a> *event, <a class="el" href="group__basic.html#ga2170996d7e636397b5e6bc0c1b7df7c6">yaml_encoding_t</a> encoding)</td></tr>
  97 <tr class="memdesc:ga0650d255b23d9aae13c839f4ab3ec2ab"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create the STREAM-START event.  <a href="#ga0650d255b23d9aae13c839f4ab3ec2ab">More...</a><br/></td></tr>
  98 <tr class="separator:ga0650d255b23d9aae13c839f4ab3ec2ab"><td class="memSeparator" colspan="2">&#160;</td></tr>
  99 <tr class="memitem:ga84cf0c3ff01251c852c71624e64df9fe"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__events.html#ga84cf0c3ff01251c852c71624e64df9fe">yaml_stream_end_event_initialize</a> (<a class="el" href="group__events.html#ga3b392d9716c4920cabefdd29e78dd542">yaml_event_t</a> *event)</td></tr>
 100 <tr class="memdesc:ga84cf0c3ff01251c852c71624e64df9fe"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create the STREAM-END event.  <a href="#ga84cf0c3ff01251c852c71624e64df9fe">More...</a><br/></td></tr>
 101 <tr class="separator:ga84cf0c3ff01251c852c71624e64df9fe"><td class="memSeparator" colspan="2">&#160;</td></tr>
 102 <tr class="memitem:ga527e89302e1c969fbea5aa45664bf51c"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__events.html#ga527e89302e1c969fbea5aa45664bf51c">yaml_document_start_event_initialize</a> (<a class="el" href="group__events.html#ga3b392d9716c4920cabefdd29e78dd542">yaml_event_t</a> *event, <a class="el" href="group__basic.html#ga2fc55608333fbe6df17cf891be709b72">yaml_version_directive_t</a> *version_directive, <a class="el" href="group__basic.html#ga0b4bc4871b0c9104e32d40d5f3803674">yaml_tag_directive_t</a> *tag_directives_start, <a class="el" href="group__basic.html#ga0b4bc4871b0c9104e32d40d5f3803674">yaml_tag_directive_t</a> *tag_directives_end, int implicit)</td></tr>
 103 <tr class="memdesc:ga527e89302e1c969fbea5aa45664bf51c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create the DOCUMENT-START event.  <a href="#ga527e89302e1c969fbea5aa45664bf51c">More...</a><br/></td></tr>
 104 <tr class="separator:ga527e89302e1c969fbea5aa45664bf51c"><td class="memSeparator" colspan="2">&#160;</td></tr>
 105 <tr class="memitem:ga8bae16548ee88f8a5ca15204f8c30344"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__events.html#ga8bae16548ee88f8a5ca15204f8c30344">yaml_document_end_event_initialize</a> (<a class="el" href="group__events.html#ga3b392d9716c4920cabefdd29e78dd542">yaml_event_t</a> *event, int implicit)</td></tr>
 106 <tr class="memdesc:ga8bae16548ee88f8a5ca15204f8c30344"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create the DOCUMENT-END event.  <a href="#ga8bae16548ee88f8a5ca15204f8c30344">More...</a><br/></td></tr>
 107 <tr class="separator:ga8bae16548ee88f8a5ca15204f8c30344"><td class="memSeparator" colspan="2">&#160;</td></tr>
 108 <tr class="memitem:gade4c15b75eb9a8035e04d4f0dd23f005"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__events.html#gade4c15b75eb9a8035e04d4f0dd23f005">yaml_alias_event_initialize</a> (<a class="el" href="group__events.html#ga3b392d9716c4920cabefdd29e78dd542">yaml_event_t</a> *event, <a class="el" href="group__basic.html#gaf8657e81f0b8b05d1a081001fc6cb8bd">yaml_char_t</a> *anchor)</td></tr>
 109 <tr class="memdesc:gade4c15b75eb9a8035e04d4f0dd23f005"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create an ALIAS event.  <a href="#gade4c15b75eb9a8035e04d4f0dd23f005">More...</a><br/></td></tr>
 110 <tr class="separator:gade4c15b75eb9a8035e04d4f0dd23f005"><td class="memSeparator" colspan="2">&#160;</td></tr>
 111 <tr class="memitem:gafc60a1a437385e19e6fb3be075958c8c"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__events.html#gafc60a1a437385e19e6fb3be075958c8c">yaml_scalar_event_initialize</a> (<a class="el" href="group__events.html#ga3b392d9716c4920cabefdd29e78dd542">yaml_event_t</a> *event, <a class="el" href="group__basic.html#gaf8657e81f0b8b05d1a081001fc6cb8bd">yaml_char_t</a> *anchor, <a class="el" href="group__basic.html#gaf8657e81f0b8b05d1a081001fc6cb8bd">yaml_char_t</a> *tag, <a class="el" href="group__basic.html#gaf8657e81f0b8b05d1a081001fc6cb8bd">yaml_char_t</a> *value, int length, int plain_implicit, int quoted_implicit, <a class="el" href="group__styles.html#ga3fa6405631e1afe5bd5c488a6c5e8065">yaml_scalar_style_t</a> style)</td></tr>
 112 <tr class="memdesc:gafc60a1a437385e19e6fb3be075958c8c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a SCALAR event.  <a href="#gafc60a1a437385e19e6fb3be075958c8c">More...</a><br/></td></tr>
 113 <tr class="separator:gafc60a1a437385e19e6fb3be075958c8c"><td class="memSeparator" colspan="2">&#160;</td></tr>
 114 <tr class="memitem:ga53aea428c768d7b131923d08c904b4eb"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__events.html#ga53aea428c768d7b131923d08c904b4eb">yaml_sequence_start_event_initialize</a> (<a class="el" href="group__events.html#ga3b392d9716c4920cabefdd29e78dd542">yaml_event_t</a> *event, <a class="el" href="group__basic.html#gaf8657e81f0b8b05d1a081001fc6cb8bd">yaml_char_t</a> *anchor, <a class="el" href="group__basic.html#gaf8657e81f0b8b05d1a081001fc6cb8bd">yaml_char_t</a> *tag, int implicit, <a class="el" href="group__styles.html#ga58a1123d271e56c72de6abf852ac4dc2">yaml_sequence_style_t</a> style)</td></tr>
 115 <tr class="memdesc:ga53aea428c768d7b131923d08c904b4eb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a SEQUENCE-START event.  <a href="#ga53aea428c768d7b131923d08c904b4eb">More...</a><br/></td></tr>
 116 <tr class="separator:ga53aea428c768d7b131923d08c904b4eb"><td class="memSeparator" colspan="2">&#160;</td></tr>
 117 <tr class="memitem:ga99fdfa4b9d42b64d8171c9b22f334b1c"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__events.html#ga99fdfa4b9d42b64d8171c9b22f334b1c">yaml_sequence_end_event_initialize</a> (<a class="el" href="group__events.html#ga3b392d9716c4920cabefdd29e78dd542">yaml_event_t</a> *event)</td></tr>
 118 <tr class="memdesc:ga99fdfa4b9d42b64d8171c9b22f334b1c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a SEQUENCE-END event.  <a href="#ga99fdfa4b9d42b64d8171c9b22f334b1c">More...</a><br/></td></tr>
 119 <tr class="separator:ga99fdfa4b9d42b64d8171c9b22f334b1c"><td class="memSeparator" colspan="2">&#160;</td></tr>
 120 <tr class="memitem:ga0603cf8d20f0b6dfc3be04b6360134aa"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__events.html#ga0603cf8d20f0b6dfc3be04b6360134aa">yaml_mapping_start_event_initialize</a> (<a class="el" href="group__events.html#ga3b392d9716c4920cabefdd29e78dd542">yaml_event_t</a> *event, <a class="el" href="group__basic.html#gaf8657e81f0b8b05d1a081001fc6cb8bd">yaml_char_t</a> *anchor, <a class="el" href="group__basic.html#gaf8657e81f0b8b05d1a081001fc6cb8bd">yaml_char_t</a> *tag, int implicit, <a class="el" href="group__styles.html#gab47523846a5c5960e07367a28ea9750a">yaml_mapping_style_t</a> style)</td></tr>
 121 <tr class="memdesc:ga0603cf8d20f0b6dfc3be04b6360134aa"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a MAPPING-START event.  <a href="#ga0603cf8d20f0b6dfc3be04b6360134aa">More...</a><br/></td></tr>
 122 <tr class="separator:ga0603cf8d20f0b6dfc3be04b6360134aa"><td class="memSeparator" colspan="2">&#160;</td></tr>
 123 <tr class="memitem:ga3afaf8b3aca2ec902a4e268f12adb0c2"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__events.html#ga3afaf8b3aca2ec902a4e268f12adb0c2">yaml_mapping_end_event_initialize</a> (<a class="el" href="group__events.html#ga3b392d9716c4920cabefdd29e78dd542">yaml_event_t</a> *event)</td></tr>
 124 <tr class="memdesc:ga3afaf8b3aca2ec902a4e268f12adb0c2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a MAPPING-END event.  <a href="#ga3afaf8b3aca2ec902a4e268f12adb0c2">More...</a><br/></td></tr>
 125 <tr class="separator:ga3afaf8b3aca2ec902a4e268f12adb0c2"><td class="memSeparator" colspan="2">&#160;</td></tr>
 126 <tr class="memitem:ga5330d62ef52856aa53188137cb93a6a1"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__events.html#ga5330d62ef52856aa53188137cb93a6a1">yaml_event_delete</a> (<a class="el" href="group__events.html#ga3b392d9716c4920cabefdd29e78dd542">yaml_event_t</a> *event)</td></tr>
 127 <tr class="memdesc:ga5330d62ef52856aa53188137cb93a6a1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Free any memory allocated for an event object.  <a href="#ga5330d62ef52856aa53188137cb93a6a1">More...</a><br/></td></tr>
 128 <tr class="separator:ga5330d62ef52856aa53188137cb93a6a1"><td class="memSeparator" colspan="2">&#160;</td></tr>
 129 </table>
 130 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 131 <h2 class="groupheader">Typedef Documentation</h2>
 132 <a class="anchor" id="ga8934661be36bd7c9d17a8af69eff89a1"></a>
 133 <div class="memitem">
 134 <div class="memproto">
 135       <table class="memname">
 136         <tr>
 137           <td class="memname">typedef enum <a class="el" href="group__events.html#ga454fccebae859c188fe3e7fa3299577c">yaml_event_type_e</a>  <a class="el" href="group__events.html#ga8934661be36bd7c9d17a8af69eff89a1">yaml_event_type_t</a></td>
 138         </tr>
 139       </table>
 140 </div><div class="memdoc">
 141
 142 <p>Event types. </p>
 143
 144 </div>
 145 </div>
 146 <a class="anchor" id="ga3b392d9716c4920cabefdd29e78dd542"></a>
 147 <div class="memitem">
 148 <div class="memproto">
 149       <table class="memname">
 150         <tr>
 151           <td class="memname">typedef struct <a class="el" href="structyaml__event__s.html">yaml_event_s</a>  <a class="el" href="group__events.html#ga3b392d9716c4920cabefdd29e78dd542">yaml_event_t</a></td>
 152         </tr>
 153       </table>
 154 </div><div class="memdoc">
 155
 156 <p>The event structure. </p>
 157
 158 </div>
 159 </div>
 160 <h2 class="groupheader">Enumeration Type Documentation</h2>
 161 <a class="anchor" id="ga454fccebae859c188fe3e7fa3299577c"></a>
 162 <div class="memitem">
 163 <div class="memproto">
 164       <table class="memname">
 165         <tr>
 166           <td class="memname">enum <a class="el" href="group__events.html#ga454fccebae859c188fe3e7fa3299577c">yaml_event_type_e</a></td>
 167         </tr>
 168       </table>
 169 </div><div class="memdoc">
 170
 171 <p>Event types. </p>
 172 <table class="fieldtable">
 173 <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="gga454fccebae859c188fe3e7fa3299577caefda9f31823fe534f094f4241d5e5eac"></a>YAML_NO_EVENT</em>&#160;</td><td class="fielddoc">
 174 <p>An empty event. </p>
 175 </td></tr>
 176 <tr><td class="fieldname"><em><a class="anchor" id="gga454fccebae859c188fe3e7fa3299577caa742e9970f14d1fe7ce4d178d79e8465"></a>YAML_STREAM_START_EVENT</em>&#160;</td><td class="fielddoc">
 177 <p>A STREAM-START event. </p>
 178 </td></tr>
 179 <tr><td class="fieldname"><em><a class="anchor" id="gga454fccebae859c188fe3e7fa3299577ca4a5e76ed540645102a13352af2503d3b"></a>YAML_STREAM_END_EVENT</em>&#160;</td><td class="fielddoc">
 180 <p>A STREAM-END event. </p>
 181 </td></tr>
 182 <tr><td class="fieldname"><em><a class="anchor" id="gga454fccebae859c188fe3e7fa3299577caf4ca2b0f538029cf054cdebd09d3d6d3"></a>YAML_DOCUMENT_START_EVENT</em>&#160;</td><td class="fielddoc">
 183 <p>A DOCUMENT-START event. </p>
 184 </td></tr>
 185 <tr><td class="fieldname"><em><a class="anchor" id="gga454fccebae859c188fe3e7fa3299577ca355ec471f963827c96512e529676276f"></a>YAML_DOCUMENT_END_EVENT</em>&#160;</td><td class="fielddoc">
 186 <p>A DOCUMENT-END event. </p>
 187 </td></tr>
 188 <tr><td class="fieldname"><em><a class="anchor" id="gga454fccebae859c188fe3e7fa3299577ca8c3ce47705cfbd49a87a32bdbe544eb7"></a>YAML_ALIAS_EVENT</em>&#160;</td><td class="fielddoc">
 189 <p>An ALIAS event. </p>
 190 </td></tr>
 191 <tr><td class="fieldname"><em><a class="anchor" id="gga454fccebae859c188fe3e7fa3299577ca8b16dc795bb228e33d647d1bdf683713"></a>YAML_SCALAR_EVENT</em>&#160;</td><td class="fielddoc">
 192 <p>A SCALAR event. </p>
 193 </td></tr>
 194 <tr><td class="fieldname"><em><a class="anchor" id="gga454fccebae859c188fe3e7fa3299577cad90ccd43e238221f542defa3c8eaf093"></a>YAML_SEQUENCE_START_EVENT</em>&#160;</td><td class="fielddoc">
 195 <p>A SEQUENCE-START event. </p>
 196 </td></tr>
 197 <tr><td class="fieldname"><em><a class="anchor" id="gga454fccebae859c188fe3e7fa3299577ca2a8af98529275987d73eb307b6a92898"></a>YAML_SEQUENCE_END_EVENT</em>&#160;</td><td class="fielddoc">
 198 <p>A SEQUENCE-END event. </p>
 199 </td></tr>
 200 <tr><td class="fieldname"><em><a class="anchor" id="gga454fccebae859c188fe3e7fa3299577ca0f6982f6d1c325ee71af518c2c66dae8"></a>YAML_MAPPING_START_EVENT</em>&#160;</td><td class="fielddoc">
 201 <p>A MAPPING-START event. </p>
 202 </td></tr>
 203 <tr><td class="fieldname"><em><a class="anchor" id="gga454fccebae859c188fe3e7fa3299577cadc3dc55f17056a657005fecfb80fbd30"></a>YAML_MAPPING_END_EVENT</em>&#160;</td><td class="fielddoc">
 204 <p>A MAPPING-END event. </p>
 205 </td></tr>
 206 </table>
 207
 208 </div>
 209 </div>
 210 <h2 class="groupheader">Function Documentation</h2>
 211 <a class="anchor" id="ga0650d255b23d9aae13c839f4ab3ec2ab"></a>
 212 <div class="memitem">
 213 <div class="memproto">
 214       <table class="memname">
 215         <tr>
 216           <td class="memname">int yaml_stream_start_event_initialize </td>
 217           <td>(</td>
 218           <td class="paramtype"><a class="el" href="group__events.html#ga3b392d9716c4920cabefdd29e78dd542">yaml_event_t</a> *&#160;</td>
 219           <td class="paramname"><em>event</em>, </td>
 220         </tr>
 221         <tr>
 222           <td class="paramkey"></td>
 223           <td></td>
 224           <td class="paramtype"><a class="el" href="group__basic.html#ga2170996d7e636397b5e6bc0c1b7df7c6">yaml_encoding_t</a>&#160;</td>
 225           <td class="paramname"><em>encoding</em>&#160;</td>
 226         </tr>
 227         <tr>
 228           <td></td>
 229           <td>)</td>
 230           <td></td><td></td>
 231         </tr>
 232       </table>
 233 </div><div class="memdoc">
 234
 235 <p>Create the STREAM-START event. </p>
 236 <dl class="params"><dt>Parameters</dt><dd>
 237   <table class="params">
 238     <tr><td class="paramdir">[out]</td><td class="paramname">event</td><td>An empty event object. </td></tr>
 239     <tr><td class="paramdir">[in]</td><td class="paramname">encoding</td><td>The stream encoding.</td></tr>
 240   </table>
 241   </dd>
 242 </dl>
 243 <dl class="section return"><dt>Returns</dt><dd><code>1</code> if the function succeeded, <code>0</code> on error. </dd></dl>
 244
 245 </div>
 246 </div>
 247 <a class="anchor" id="ga84cf0c3ff01251c852c71624e64df9fe"></a>
 248 <div class="memitem">
 249 <div class="memproto">
 250       <table class="memname">
 251         <tr>
 252           <td class="memname">int yaml_stream_end_event_initialize </td>
 253           <td>(</td>
 254           <td class="paramtype"><a class="el" href="group__events.html#ga3b392d9716c4920cabefdd29e78dd542">yaml_event_t</a> *&#160;</td>
 255           <td class="paramname"><em>event</em></td><td>)</td>
 256           <td></td>
 257         </tr>
 258       </table>
 259 </div><div class="memdoc">
 260
 261 <p>Create the STREAM-END event. </p>
 262 <dl class="params"><dt>Parameters</dt><dd>
 263   <table class="params">
 264     <tr><td class="paramdir">[out]</td><td class="paramname">event</td><td>An empty event object.</td></tr>
 265   </table>
 266   </dd>
 267 </dl>
 268 <dl class="section return"><dt>Returns</dt><dd><code>1</code> if the function succeeded, <code>0</code> on error. </dd></dl>
 269
 270 </div>
 271 </div>
 272 <a class="anchor" id="ga527e89302e1c969fbea5aa45664bf51c"></a>
 273 <div class="memitem">
 274 <div class="memproto">
 275       <table class="memname">
 276         <tr>
 277           <td class="memname">int yaml_document_start_event_initialize </td>
 278           <td>(</td>
 279           <td class="paramtype"><a class="el" href="group__events.html#ga3b392d9716c4920cabefdd29e78dd542">yaml_event_t</a> *&#160;</td>
 280           <td class="paramname"><em>event</em>, </td>
 281         </tr>
 282         <tr>
 283           <td class="paramkey"></td>
 284           <td></td>
 285           <td class="paramtype"><a class="el" href="group__basic.html#ga2fc55608333fbe6df17cf891be709b72">yaml_version_directive_t</a> *&#160;</td>
 286           <td class="paramname"><em>version_directive</em>, </td>
 287         </tr>
 288         <tr>
 289           <td class="paramkey"></td>
 290           <td></td>
 291           <td class="paramtype"><a class="el" href="group__basic.html#ga0b4bc4871b0c9104e32d40d5f3803674">yaml_tag_directive_t</a> *&#160;</td>
 292           <td class="paramname"><em>tag_directives_start</em>, </td>
 293         </tr>
 294         <tr>
 295           <td class="paramkey"></td>
 296           <td></td>
 297           <td class="paramtype"><a class="el" href="group__basic.html#ga0b4bc4871b0c9104e32d40d5f3803674">yaml_tag_directive_t</a> *&#160;</td>
 298           <td class="paramname"><em>tag_directives_end</em>, </td>
 299         </tr>
 300         <tr>
 301           <td class="paramkey"></td>
 302           <td></td>
 303           <td class="paramtype">int&#160;</td>
 304           <td class="paramname"><em>implicit</em>&#160;</td>
 305         </tr>
 306         <tr>
 307           <td></td>
 308           <td>)</td>
 309           <td></td><td></td>
 310         </tr>
 311       </table>
 312 </div><div class="memdoc">
 313
 314 <p>Create the DOCUMENT-START event. </p>
 315 <p>The <em>implicit</em> argument is considered as a stylistic parameter and may be ignored by the emitter.</p>
 316 <dl class="params"><dt>Parameters</dt><dd>
 317   <table class="params">
 318     <tr><td class="paramdir">[out]</td><td class="paramname">event</td><td>An empty event object. </td></tr>
 319     <tr><td class="paramdir">[in]</td><td class="paramname">version_directive</td><td>The YAML directive value or <code>NULL</code>. </td></tr>
 320     <tr><td class="paramdir">[in]</td><td class="paramname">tag_directives_start</td><td>The beginning of the TAG directives list. </td></tr>
 321     <tr><td class="paramdir">[in]</td><td class="paramname">tag_directives_end</td><td>The end of the TAG directives list. </td></tr>
 322     <tr><td class="paramdir">[in]</td><td class="paramname">implicit</td><td>If the document start indicator is implicit.</td></tr>
 323   </table>
 324   </dd>
 325 </dl>
 326 <dl class="section return"><dt>Returns</dt><dd><code>1</code> if the function succeeded, <code>0</code> on error. </dd></dl>
 327
 328 </div>
 329 </div>
 330 <a class="anchor" id="ga8bae16548ee88f8a5ca15204f8c30344"></a>
 331 <div class="memitem">
 332 <div class="memproto">
 333       <table class="memname">
 334         <tr>
 335           <td class="memname">int yaml_document_end_event_initialize </td>
 336           <td>(</td>
 337           <td class="paramtype"><a class="el" href="group__events.html#ga3b392d9716c4920cabefdd29e78dd542">yaml_event_t</a> *&#160;</td>
 338           <td class="paramname"><em>event</em>, </td>
 339         </tr>
 340         <tr>
 341           <td class="paramkey"></td>
 342           <td></td>
 343           <td class="paramtype">int&#160;</td>
 344           <td class="paramname"><em>implicit</em>&#160;</td>
 345         </tr>
 346         <tr>
 347           <td></td>
 348           <td>)</td>
 349           <td></td><td></td>
 350         </tr>
 351       </table>
 352 </div><div class="memdoc">
 353
 354 <p>Create the DOCUMENT-END event. </p>
 355 <p>The <em>implicit</em> argument is considered as a stylistic parameter and may be ignored by the emitter.</p>
 356 <dl class="params"><dt>Parameters</dt><dd>
 357   <table class="params">
 358     <tr><td class="paramdir">[out]</td><td class="paramname">event</td><td>An empty event object. </td></tr>
 359     <tr><td class="paramdir">[in]</td><td class="paramname">implicit</td><td>If the document end indicator is implicit.</td></tr>
 360   </table>
 361   </dd>
 362 </dl>
 363 <dl class="section return"><dt>Returns</dt><dd><code>1</code> if the function succeeded, <code>0</code> on error. </dd></dl>
 364
 365 </div>
 366 </div>
 367 <a class="anchor" id="gade4c15b75eb9a8035e04d4f0dd23f005"></a>
 368 <div class="memitem">
 369 <div class="memproto">
 370       <table class="memname">
 371         <tr>
 372           <td class="memname">int yaml_alias_event_initialize </td>
 373           <td>(</td>
 374           <td class="paramtype"><a class="el" href="group__events.html#ga3b392d9716c4920cabefdd29e78dd542">yaml_event_t</a> *&#160;</td>
 375           <td class="paramname"><em>event</em>, </td>
 376         </tr>
 377         <tr>
 378           <td class="paramkey"></td>
 379           <td></td>
 380           <td class="paramtype"><a class="el" href="group__basic.html#gaf8657e81f0b8b05d1a081001fc6cb8bd">yaml_char_t</a> *&#160;</td>
 381           <td class="paramname"><em>anchor</em>&#160;</td>
 382         </tr>
 383         <tr>
 384           <td></td>
 385           <td>)</td>
 386           <td></td><td></td>
 387         </tr>
 388       </table>
 389 </div><div class="memdoc">
 390
 391 <p>Create an ALIAS event. </p>
 392 <dl class="params"><dt>Parameters</dt><dd>
 393   <table class="params">
 394     <tr><td class="paramdir">[out]</td><td class="paramname">event</td><td>An empty event object. </td></tr>
 395     <tr><td class="paramdir">[in]</td><td class="paramname">anchor</td><td>The anchor value.</td></tr>
 396   </table>
 397   </dd>
 398 </dl>
 399 <dl class="section return"><dt>Returns</dt><dd><code>1</code> if the function succeeded, <code>0</code> on error. </dd></dl>
 400
 401 </div>
 402 </div>
 403 <a class="anchor" id="gafc60a1a437385e19e6fb3be075958c8c"></a>
 404 <div class="memitem">
 405 <div class="memproto">
 406       <table class="memname">
 407         <tr>
 408           <td class="memname">int yaml_scalar_event_initialize </td>
 409           <td>(</td>
 410           <td class="paramtype"><a class="el" href="group__events.html#ga3b392d9716c4920cabefdd29e78dd542">yaml_event_t</a> *&#160;</td>
 411           <td class="paramname"><em>event</em>, </td>
 412         </tr>
 413         <tr>
 414           <td class="paramkey"></td>
 415           <td></td>
 416           <td class="paramtype"><a class="el" href="group__basic.html#gaf8657e81f0b8b05d1a081001fc6cb8bd">yaml_char_t</a> *&#160;</td>
 417           <td class="paramname"><em>anchor</em>, </td>
 418         </tr>
 419         <tr>
 420           <td class="paramkey"></td>
 421           <td></td>
 422           <td class="paramtype"><a class="el" href="group__basic.html#gaf8657e81f0b8b05d1a081001fc6cb8bd">yaml_char_t</a> *&#160;</td>
 423           <td class="paramname"><em>tag</em>, </td>
 424         </tr>
 425         <tr>
 426           <td class="paramkey"></td>
 427           <td></td>
 428           <td class="paramtype"><a class="el" href="group__basic.html#gaf8657e81f0b8b05d1a081001fc6cb8bd">yaml_char_t</a> *&#160;</td>
 429           <td class="paramname"><em>value</em>, </td>
 430         </tr>
 431         <tr>
 432           <td class="paramkey"></td>
 433           <td></td>
 434           <td class="paramtype">int&#160;</td>
 435           <td class="paramname"><em>length</em>, </td>
 436         </tr>
 437         <tr>
 438           <td class="paramkey"></td>
 439           <td></td>
 440           <td class="paramtype">int&#160;</td>
 441           <td class="paramname"><em>plain_implicit</em>, </td>
 442         </tr>
 443         <tr>
 444           <td class="paramkey"></td>
 445           <td></td>
 446           <td class="paramtype">int&#160;</td>
 447           <td class="paramname"><em>quoted_implicit</em>, </td>
 448         </tr>
 449         <tr>
 450           <td class="paramkey"></td>
 451           <td></td>
 452           <td class="paramtype"><a class="el" href="group__styles.html#ga3fa6405631e1afe5bd5c488a6c5e8065">yaml_scalar_style_t</a>&#160;</td>
 453           <td class="paramname"><em>style</em>&#160;</td>
 454         </tr>
 455         <tr>
 456           <td></td>
 457           <td>)</td>
 458           <td></td><td></td>
 459         </tr>
 460       </table>
 461 </div><div class="memdoc">
 462
 463 <p>Create a SCALAR event. </p>
 464 <p>The <em>style</em> argument may be ignored by the emitter.</p>
 465 <p>Either the <em>tag</em> attribute or one of the <em>plain_implicit</em> and <em>quoted_implicit</em> flags must be set.</p>
 466 <dl class="params"><dt>Parameters</dt><dd>
 467   <table class="params">
 468     <tr><td class="paramdir">[out]</td><td class="paramname">event</td><td>An empty event object. </td></tr>
 469     <tr><td class="paramdir">[in]</td><td class="paramname">anchor</td><td>The scalar anchor or <code>NULL</code>. </td></tr>
 470     <tr><td class="paramdir">[in]</td><td class="paramname">tag</td><td>The scalar tag or <code>NULL</code>. </td></tr>
 471     <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>The scalar value. </td></tr>
 472     <tr><td class="paramdir">[in]</td><td class="paramname">length</td><td>The length of the scalar value. </td></tr>
 473     <tr><td class="paramdir">[in]</td><td class="paramname">plain_implicit</td><td>If the tag may be omitted for the plain style. </td></tr>
 474     <tr><td class="paramdir">[in]</td><td class="paramname">quoted_implicit</td><td>If the tag may be omitted for any non-plain style. </td></tr>
 475     <tr><td class="paramdir">[in]</td><td class="paramname">style</td><td>The scalar style.</td></tr>
 476   </table>
 477   </dd>
 478 </dl>
 479 <dl class="section return"><dt>Returns</dt><dd><code>1</code> if the function succeeded, <code>0</code> on error. </dd></dl>
 480
 481 </div>
 482 </div>
 483 <a class="anchor" id="ga53aea428c768d7b131923d08c904b4eb"></a>
 484 <div class="memitem">
 485 <div class="memproto">
 486       <table class="memname">
 487         <tr>
 488           <td class="memname">int yaml_sequence_start_event_initialize </td>
 489           <td>(</td>
 490           <td class="paramtype"><a class="el" href="group__events.html#ga3b392d9716c4920cabefdd29e78dd542">yaml_event_t</a> *&#160;</td>
 491           <td class="paramname"><em>event</em>, </td>
 492         </tr>
 493         <tr>
 494           <td class="paramkey"></td>
 495           <td></td>
 496           <td class="paramtype"><a class="el" href="group__basic.html#gaf8657e81f0b8b05d1a081001fc6cb8bd">yaml_char_t</a> *&#160;</td>
 497           <td class="paramname"><em>anchor</em>, </td>
 498         </tr>
 499         <tr>
 500           <td class="paramkey"></td>
 501           <td></td>
 502           <td class="paramtype"><a class="el" href="group__basic.html#gaf8657e81f0b8b05d1a081001fc6cb8bd">yaml_char_t</a> *&#160;</td>
 503           <td class="paramname"><em>tag</em>, </td>
 504         </tr>
 505         <tr>
 506           <td class="paramkey"></td>
 507           <td></td>
 508           <td class="paramtype">int&#160;</td>
 509           <td class="paramname"><em>implicit</em>, </td>
 510         </tr>
 511         <tr>
 512           <td class="paramkey"></td>
 513           <td></td>
 514           <td class="paramtype"><a class="el" href="group__styles.html#ga58a1123d271e56c72de6abf852ac4dc2">yaml_sequence_style_t</a>&#160;</td>
 515           <td class="paramname"><em>style</em>&#160;</td>
 516         </tr>
 517         <tr>
 518           <td></td>
 519           <td>)</td>
 520           <td></td><td></td>
 521         </tr>
 522       </table>
 523 </div><div class="memdoc">
 524
 525 <p>Create a SEQUENCE-START event. </p>
 526 <p>The <em>style</em> argument may be ignored by the emitter.</p>
 527 <p>Either the <em>tag</em> attribute or the <em>implicit</em> flag must be set.</p>
 528 <dl class="params"><dt>Parameters</dt><dd>
 529   <table class="params">
 530     <tr><td class="paramdir">[out]</td><td class="paramname">event</td><td>An empty event object. </td></tr>
 531     <tr><td class="paramdir">[in]</td><td class="paramname">anchor</td><td>The sequence anchor or <code>NULL</code>. </td></tr>
 532     <tr><td class="paramdir">[in]</td><td class="paramname">tag</td><td>The sequence tag or <code>NULL</code>. </td></tr>
 533     <tr><td class="paramdir">[in]</td><td class="paramname">implicit</td><td>If the tag may be omitted. </td></tr>
 534     <tr><td class="paramdir">[in]</td><td class="paramname">style</td><td>The sequence style.</td></tr>
 535   </table>
 536   </dd>
 537 </dl>
 538 <dl class="section return"><dt>Returns</dt><dd><code>1</code> if the function succeeded, <code>0</code> on error. </dd></dl>
 539
 540 </div>
 541 </div>
 542 <a class="anchor" id="ga99fdfa4b9d42b64d8171c9b22f334b1c"></a>
 543 <div class="memitem">
 544 <div class="memproto">
 545       <table class="memname">
 546         <tr>
 547           <td class="memname">int yaml_sequence_end_event_initialize </td>
 548           <td>(</td>
 549           <td class="paramtype"><a class="el" href="group__events.html#ga3b392d9716c4920cabefdd29e78dd542">yaml_event_t</a> *&#160;</td>
 550           <td class="paramname"><em>event</em></td><td>)</td>
 551           <td></td>
 552         </tr>
 553       </table>
 554 </div><div class="memdoc">
 555
 556 <p>Create a SEQUENCE-END event. </p>
 557 <dl class="params"><dt>Parameters</dt><dd>
 558   <table class="params">
 559     <tr><td class="paramdir">[out]</td><td class="paramname">event</td><td>An empty event object.</td></tr>
 560   </table>
 561   </dd>
 562 </dl>
 563 <dl class="section return"><dt>Returns</dt><dd><code>1</code> if the function succeeded, <code>0</code> on error. </dd></dl>
 564
 565 </div>
 566 </div>
 567 <a class="anchor" id="ga0603cf8d20f0b6dfc3be04b6360134aa"></a>
 568 <div class="memitem">
 569 <div class="memproto">
 570       <table class="memname">
 571         <tr>
 572           <td class="memname">int yaml_mapping_start_event_initialize </td>
 573           <td>(</td>
 574           <td class="paramtype"><a class="el" href="group__events.html#ga3b392d9716c4920cabefdd29e78dd542">yaml_event_t</a> *&#160;</td>
 575           <td class="paramname"><em>event</em>, </td>
 576         </tr>
 577         <tr>
 578           <td class="paramkey"></td>
 579           <td></td>
 580           <td class="paramtype"><a class="el" href="group__basic.html#gaf8657e81f0b8b05d1a081001fc6cb8bd">yaml_char_t</a> *&#160;</td>
 581           <td class="paramname"><em>anchor</em>, </td>
 582         </tr>
 583         <tr>
 584           <td class="paramkey"></td>
 585           <td></td>
 586           <td class="paramtype"><a class="el" href="group__basic.html#gaf8657e81f0b8b05d1a081001fc6cb8bd">yaml_char_t</a> *&#160;</td>
 587           <td class="paramname"><em>tag</em>, </td>
 588         </tr>
 589         <tr>
 590           <td class="paramkey"></td>
 591           <td></td>
 592           <td class="paramtype">int&#160;</td>
 593           <td class="paramname"><em>implicit</em>, </td>
 594         </tr>
 595         <tr>
 596           <td class="paramkey"></td>
 597           <td></td>
 598           <td class="paramtype"><a class="el" href="group__styles.html#gab47523846a5c5960e07367a28ea9750a">yaml_mapping_style_t</a>&#160;</td>
 599           <td class="paramname"><em>style</em>&#160;</td>
 600         </tr>
 601         <tr>
 602           <td></td>
 603           <td>)</td>
 604           <td></td><td></td>
 605         </tr>
 606       </table>
 607 </div><div class="memdoc">
 608
 609 <p>Create a MAPPING-START event. </p>
 610 <p>The <em>style</em> argument may be ignored by the emitter.</p>
 611 <p>Either the <em>tag</em> attribute or the <em>implicit</em> flag must be set.</p>
 612 <dl class="params"><dt>Parameters</dt><dd>
 613   <table class="params">
 614     <tr><td class="paramdir">[out]</td><td class="paramname">event</td><td>An empty event object. </td></tr>
 615     <tr><td class="paramdir">[in]</td><td class="paramname">anchor</td><td>The mapping anchor or <code>NULL</code>. </td></tr>
 616     <tr><td class="paramdir">[in]</td><td class="paramname">tag</td><td>The mapping tag or <code>NULL</code>. </td></tr>
 617     <tr><td class="paramdir">[in]</td><td class="paramname">implicit</td><td>If the tag may be omitted. </td></tr>
 618     <tr><td class="paramdir">[in]</td><td class="paramname">style</td><td>The mapping style.</td></tr>
 619   </table>
 620   </dd>
 621 </dl>
 622 <dl class="section return"><dt>Returns</dt><dd><code>1</code> if the function succeeded, <code>0</code> on error. </dd></dl>
 623
 624 </div>
 625 </div>
 626 <a class="anchor" id="ga3afaf8b3aca2ec902a4e268f12adb0c2"></a>
 627 <div class="memitem">
 628 <div class="memproto">
 629       <table class="memname">
 630         <tr>
 631           <td class="memname">int yaml_mapping_end_event_initialize </td>
 632           <td>(</td>
 633           <td class="paramtype"><a class="el" href="group__events.html#ga3b392d9716c4920cabefdd29e78dd542">yaml_event_t</a> *&#160;</td>
 634           <td class="paramname"><em>event</em></td><td>)</td>
 635           <td></td>
 636         </tr>
 637       </table>
 638 </div><div class="memdoc">
 639
 640 <p>Create a MAPPING-END event. </p>
 641 <dl class="params"><dt>Parameters</dt><dd>
 642   <table class="params">
 643     <tr><td class="paramdir">[out]</td><td class="paramname">event</td><td>An empty event object.</td></tr>
 644   </table>
 645   </dd>
 646 </dl>
 647 <dl class="section return"><dt>Returns</dt><dd><code>1</code> if the function succeeded, <code>0</code> on error. </dd></dl>
 648
 649 </div>
 650 </div>
 651 <a class="anchor" id="ga5330d62ef52856aa53188137cb93a6a1"></a>
 652 <div class="memitem">
 653 <div class="memproto">
 654       <table class="memname">
 655         <tr>
 656           <td class="memname">void yaml_event_delete </td>
 657           <td>(</td>
 658           <td class="paramtype"><a class="el" href="group__events.html#ga3b392d9716c4920cabefdd29e78dd542">yaml_event_t</a> *&#160;</td>
 659           <td class="paramname"><em>event</em></td><td>)</td>
 660           <td></td>
 661         </tr>
 662       </table>
 663 </div><div class="memdoc">
 664
 665 <p>Free any memory allocated for an event object. </p>
 666 <dl class="params"><dt>Parameters</dt><dd>
 667   <table class="params">
 668     <tr><td class="paramdir">[in,out]</td><td class="paramname">event</td><td>An event object. </td></tr>
 669   </table>
 670   </dd>
 671 </dl>
 672
 673 </div>
 674 </div>
 675 </div><!-- contents -->
 676 <!-- start footer part -->
 677 <hr class="footer"/><address class="footer"><small>
 678 Generated on Sun Aug 28 2016 23:56:54 for yaml by &#160;<a href="http://www.doxygen.org/index.html">
 679 <img class="footer" src="doxygen.png" alt="doxygen"/>
 680 </a> 1.8.6
 681 </small></address>
 682 </body>
 683 </html>