service/protocol-plugin/lib/cpluff/doc/reference/c-api/structcp__cfg__element__t.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
   3 <title>C-Pluff C API: cp_cfg_element_t Struct Reference</title>
   4 <link href="doxygen.css" rel="stylesheet" type="text/css">
   5 <link href="tabs.css" rel="stylesheet" type="text/css">
   6 </head><body>
   7 <!-- Generated by Doxygen 1.5.1 -->
   8 <div class="tabs">
   9   <ul>
  10     <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
  11     <li><a href="modules.html"><span>Modules</span></a></li>
  12     <li id="current"><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
  13     <li><a href="files.html"><span>Files</span></a></li>
  14     <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
  15   </ul></div>
  16 <div class="tabs">
  17   <ul>
  18     <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
  19     <li><a href="functions.html"><span>Data&nbsp;Fields</span></a></li>
  20   </ul></div>
  21 <h1>cp_cfg_element_t Struct Reference<br>
  22 <small>
  23 [<a class="el" href="group__cStructs.html">Data structures</a>]</small>
  24 </h1><!-- doxytag: class="cp_cfg_element_t" -->Collaboration diagram for cp_cfg_element_t:<p><center><img src="structcp__cfg__element__t__coll__graph.png" border="0" usemap="#cp__cfg__element__t__coll__map" alt="Collaboration graph"></center>
  25 <center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><hr><a name="_details"></a><h2>Detailed Description</h2>
  26 A configuration element contains configuration information for an extension.
  27 <p>
  28 Utility functions <a class="el" href="group__cFuncsPluginInfo.html#g9868077c72df950607e2698153d593d1">cp_lookup_cfg_element</a> and <a class="el" href="group__cFuncsPluginInfo.html#g13f5121ab21951d59d3c6b985ed6adcd">cp_lookup_cfg_value</a> can be used for traversing the tree of configuration elements. Pointer to the root configuration element is stored at <a class="el" href="structcp__extension__t.html#a745fad14a2300fd48e55c33f580f91b">cp_extension_t::configuration</a> and others are contained as <a class="el" href="structcp__cfg__element__t.html#3c4e4c4df68a11f898566c3f90bcd534">children</a> of parent elements.
  29 <p>
  30 <table border="0" cellpadding="0" cellspacing="0">
  31 <tr><td></td></tr>
  32 <tr><td colspan="2"><br><h2>Data Fields</h2></td></tr>
  33 <tr><td class="memItemLeft" nowrap align="right" valign="top">char *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcp__cfg__element__t.html#5ac083a645d964373f022d03df4849c8">name</a></td></tr>
  34
  35 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The name of the configuration element.  <a href="#5ac083a645d964373f022d03df4849c8"></a><br></td></tr>
  36 <tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcp__cfg__element__t.html#b6eced8675261543cd28efea6c7a0fa4">num_atts</a></td></tr>
  37
  38 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Number of attribute name, value pairs in the <a class="el" href="structcp__cfg__element__t.html#719b3d0c1369478044ce59dc2f207c21">atts</a> array.  <a href="#b6eced8675261543cd28efea6c7a0fa4"></a><br></td></tr>
  39 <tr><td class="memItemLeft" nowrap align="right" valign="top">char **&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcp__cfg__element__t.html#719b3d0c1369478044ce59dc2f207c21">atts</a></td></tr>
  40
  41 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">An array of pointers to alternating attribute names and values.  <a href="#719b3d0c1369478044ce59dc2f207c21"></a><br></td></tr>
  42 <tr><td class="memItemLeft" nowrap align="right" valign="top">char *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcp__cfg__element__t.html#4e9aec275e566b978a3ccb4e043d8c61">value</a></td></tr>
  43
  44 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">An optional value of this configuration element.  <a href="#4e9aec275e566b978a3ccb4e043d8c61"></a><br></td></tr>
  45 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="structcp__cfg__element__t.html">cp_cfg_element_t</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcp__cfg__element__t.html#8c99879f94f30ed01e0b76847ab11237">parent</a></td></tr>
  46
  47 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">A pointer to the parent element or NULL if this is a root element.  <a href="#8c99879f94f30ed01e0b76847ab11237"></a><br></td></tr>
  48 <tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcp__cfg__element__t.html#589d64202487f78e3cc30dd2e04c5201">index</a></td></tr>
  49
  50 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The index of this element among its siblings (0-based).  <a href="#589d64202487f78e3cc30dd2e04c5201"></a><br></td></tr>
  51 <tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcp__cfg__element__t.html#b7c9e81d106b95f54ff71b9096ba5dc6">num_children</a></td></tr>
  52
  53 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Number of children in the <a class="el" href="structcp__cfg__element__t.html#3c4e4c4df68a11f898566c3f90bcd534">children</a> array.  <a href="#b7c9e81d106b95f54ff71b9096ba5dc6"></a><br></td></tr>
  54 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="structcp__cfg__element__t.html">cp_cfg_element_t</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcp__cfg__element__t.html#3c4e4c4df68a11f898566c3f90bcd534">children</a></td></tr>
  55
  56 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">An array of <a class="el" href="structcp__cfg__element__t.html#b7c9e81d106b95f54ff71b9096ba5dc6">num_children</a> childrens of this element.  <a href="#3c4e4c4df68a11f898566c3f90bcd534"></a><br></td></tr>
  57 </table>
  58 <hr><h2>Field Documentation</h2>
  59 <a class="anchor" name="5ac083a645d964373f022d03df4849c8"></a><!-- doxytag: member="cp_cfg_element_t::name" ref="5ac083a645d964373f022d03df4849c8" args="" -->
  60 <div class="memitem">
  61 <div class="memproto">
  62       <table class="memname">
  63         <tr>
  64           <td class="memname">char* <a class="el" href="structcp__cfg__element__t.html#5ac083a645d964373f022d03df4849c8">name</a>          </td>
  65         </tr>
  66       </table>
  67 </div>
  68 <div class="memdoc">
  69
  70 <p>
  71 The name of the configuration element.
  72 <p>
  73 This corresponds to the name of the element in a plug-in descriptor.
  74 </div>
  75 </div><p>
  76 <a class="anchor" name="b6eced8675261543cd28efea6c7a0fa4"></a><!-- doxytag: member="cp_cfg_element_t::num_atts" ref="b6eced8675261543cd28efea6c7a0fa4" args="" -->
  77 <div class="memitem">
  78 <div class="memproto">
  79       <table class="memname">
  80         <tr>
  81           <td class="memname">unsigned int <a class="el" href="structcp__cfg__element__t.html#b6eced8675261543cd28efea6c7a0fa4">num_atts</a>          </td>
  82         </tr>
  83       </table>
  84 </div>
  85 <div class="memdoc">
  86
  87 <p>
  88 Number of attribute name, value pairs in the <a class="el" href="structcp__cfg__element__t.html#719b3d0c1369478044ce59dc2f207c21">atts</a> array.
  89 <p>
  90
  91 </div>
  92 </div><p>
  93 <a class="anchor" name="719b3d0c1369478044ce59dc2f207c21"></a><!-- doxytag: member="cp_cfg_element_t::atts" ref="719b3d0c1369478044ce59dc2f207c21" args="" -->
  94 <div class="memitem">
  95 <div class="memproto">
  96       <table class="memname">
  97         <tr>
  98           <td class="memname">char** <a class="el" href="structcp__cfg__element__t.html#719b3d0c1369478044ce59dc2f207c21">atts</a>          </td>
  99         </tr>
 100       </table>
 101 </div>
 102 <div class="memdoc">
 103
 104 <p>
 105 An array of pointers to alternating attribute names and values.
 106 <p>
 107 Attribute values can be localized.
 108 </div>
 109 </div><p>
 110 <a class="anchor" name="4e9aec275e566b978a3ccb4e043d8c61"></a><!-- doxytag: member="cp_cfg_element_t::value" ref="4e9aec275e566b978a3ccb4e043d8c61" args="" -->
 111 <div class="memitem">
 112 <div class="memproto">
 113       <table class="memname">
 114         <tr>
 115           <td class="memname">char* <a class="el" href="structcp__cfg__element__t.html#4e9aec275e566b978a3ccb4e043d8c61">value</a>          </td>
 116         </tr>
 117       </table>
 118 </div>
 119 <div class="memdoc">
 120
 121 <p>
 122 An optional value of this configuration element.
 123 <p>
 124 NULL if not available. The value can be localized. This corresponds to the text contents of the element in a plug-in descriptor.
 125 </div>
 126 </div><p>
 127 <a class="anchor" name="8c99879f94f30ed01e0b76847ab11237"></a><!-- doxytag: member="cp_cfg_element_t::parent" ref="8c99879f94f30ed01e0b76847ab11237" args="" -->
 128 <div class="memitem">
 129 <div class="memproto">
 130       <table class="memname">
 131         <tr>
 132           <td class="memname"><a class="el" href="structcp__cfg__element__t.html">cp_cfg_element_t</a>* <a class="el" href="structcp__cfg__element__t.html#8c99879f94f30ed01e0b76847ab11237">parent</a>          </td>
 133         </tr>
 134       </table>
 135 </div>
 136 <div class="memdoc">
 137
 138 <p>
 139 A pointer to the parent element or NULL if this is a root element.
 140 <p>
 141
 142 </div>
 143 </div><p>
 144 <a class="anchor" name="589d64202487f78e3cc30dd2e04c5201"></a><!-- doxytag: member="cp_cfg_element_t::index" ref="589d64202487f78e3cc30dd2e04c5201" args="" -->
 145 <div class="memitem">
 146 <div class="memproto">
 147       <table class="memname">
 148         <tr>
 149           <td class="memname">unsigned int <a class="el" href="structcp__cfg__element__t.html#589d64202487f78e3cc30dd2e04c5201">index</a>          </td>
 150         </tr>
 151       </table>
 152 </div>
 153 <div class="memdoc">
 154
 155 <p>
 156 The index of this element among its siblings (0-based).
 157 <p>
 158
 159 </div>
 160 </div><p>
 161 <a class="anchor" name="b7c9e81d106b95f54ff71b9096ba5dc6"></a><!-- doxytag: member="cp_cfg_element_t::num_children" ref="b7c9e81d106b95f54ff71b9096ba5dc6" args="" -->
 162 <div class="memitem">
 163 <div class="memproto">
 164       <table class="memname">
 165         <tr>
 166           <td class="memname">unsigned int <a class="el" href="structcp__cfg__element__t.html#b7c9e81d106b95f54ff71b9096ba5dc6">num_children</a>          </td>
 167         </tr>
 168       </table>
 169 </div>
 170 <div class="memdoc">
 171
 172 <p>
 173 Number of children in the <a class="el" href="structcp__cfg__element__t.html#3c4e4c4df68a11f898566c3f90bcd534">children</a> array.
 174 <p>
 175
 176 </div>
 177 </div><p>
 178 <a class="anchor" name="3c4e4c4df68a11f898566c3f90bcd534"></a><!-- doxytag: member="cp_cfg_element_t::children" ref="3c4e4c4df68a11f898566c3f90bcd534" args="" -->
 179 <div class="memitem">
 180 <div class="memproto">
 181       <table class="memname">
 182         <tr>
 183           <td class="memname"><a class="el" href="structcp__cfg__element__t.html">cp_cfg_element_t</a>* <a class="el" href="structcp__cfg__element__t.html#3c4e4c4df68a11f898566c3f90bcd534">children</a>          </td>
 184         </tr>
 185       </table>
 186 </div>
 187 <div class="memdoc">
 188
 189 <p>
 190 An array of <a class="el" href="structcp__cfg__element__t.html#b7c9e81d106b95f54ff71b9096ba5dc6">num_children</a> childrens of this element.
 191 <p>
 192 These correspond to child elements in a plug-in descriptor.
 193 </div>
 194 </div><p>
 195 <hr>The documentation for this struct was generated from the following file:<ul>
 196 <li><a class="el" href="cpluff_8h-source.html">cpluff.h</a></ul>
 197 <hr size="1">
 198 <p class="footer">
 199 <a href="http://www.c-pluff.org/">C-Pluff</a>, a plug-in framework for C<br>
 200 Copyright 2007 <a href="http://www.jlehtinen.net/">Johannes Lehtinen</a>
 201 </p>
 202 <p class="generated-by">
 203 Generated on Fri Apr 6 15:40:56 2007 for C-Pluff C API by&nbsp;<a href="http://www.doxygen.org/index.html"><img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.1
 204 </p>
 205 </body>
 206 </html>