service/protocol-plugin/lib/cpluff/doc/reference/c-api/structcp__extension__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_extension_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_extension_t Struct Reference<br>
  22 <small>
  23 [<a class="el" href="group__cStructs.html">Data structures</a>]</small>
  24 </h1><!-- doxytag: class="cp_extension_t" -->Collaboration diagram for cp_extension_t:<p><center><img src="structcp__extension__t__coll__graph.png" border="0" usemap="#cp__extension__t__coll__map" alt="Collaboration graph"></center>
  25 <map name="cp__extension__t__coll__map">
  26 <area href="structcp__plugin__info__t.html" shape="rect" coords="98,196,228,220" alt="">
  27 <area href="structcp__ext__point__t.html" shape="rect" coords="104,287,222,311" alt="">
  28 <area href="structcp__plugin__import__t.html" shape="rect" coords="6,105,155,129" alt="">
  29 <area href="structcp__cfg__element__t.html" shape="rect" coords="184,13,323,37" alt="">
  30 </map>
  31 <center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><hr><a name="_details"></a><h2>Detailed Description</h2>
  32 Extension structure captures information about an extension.
  33 <p>
  34 Extension structures are contained in <a class="el" href="structcp__plugin__info__t.html#2288d4af96da6699b7a2c8b747bd42dc">cp_plugin_info_t::extensions</a>.
  35 <p>
  36 <table border="0" cellpadding="0" cellspacing="0">
  37 <tr><td></td></tr>
  38 <tr><td colspan="2"><br><h2>Data Fields</h2></td></tr>
  39 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="structcp__plugin__info__t.html">cp_plugin_info_t</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcp__extension__t.html#e498b24942e6fdd73ce6c22505549680">plugin</a></td></tr>
  40
  41 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">A pointer to plug-in information containing this extension.  <a href="#e498b24942e6fdd73ce6c22505549680"></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__extension__t.html#9fe304775bea17eeba3c3fd734d1e4bc">ext_point_id</a></td></tr>
  43
  44 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The unique identifier of the extension point this extension is attached to.  <a href="#9fe304775bea17eeba3c3fd734d1e4bc"></a><br></td></tr>
  45 <tr><td class="memItemLeft" nowrap align="right" valign="top">char *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcp__extension__t.html#eb234b64f623fd6c2bcbbc98bacb99ce">local_id</a></td></tr>
  46
  47 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">An optional local identifier uniquely identifying the extension within the host plug-in.  <a href="#eb234b64f623fd6c2bcbbc98bacb99ce"></a><br></td></tr>
  48 <tr><td class="memItemLeft" nowrap align="right" valign="top">char *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcp__extension__t.html#f5351a0143adaf16c64b881aee01d893">identifier</a></td></tr>
  49
  50 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">An optional unique identifier of the extension.  <a href="#f5351a0143adaf16c64b881aee01d893"></a><br></td></tr>
  51 <tr><td class="memItemLeft" nowrap align="right" valign="top">char *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcp__extension__t.html#5ac083a645d964373f022d03df4849c8">name</a></td></tr>
  52
  53 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">An optional extension name.  <a href="#5ac083a645d964373f022d03df4849c8"></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__extension__t.html#a745fad14a2300fd48e55c33f580f91b">configuration</a></td></tr>
  55
  56 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Extension configuration starting with the extension element.  <a href="#a745fad14a2300fd48e55c33f580f91b"></a><br></td></tr>
  57 </table>
  58 <hr><h2>Field Documentation</h2>
  59 <a class="anchor" name="e498b24942e6fdd73ce6c22505549680"></a><!-- doxytag: member="cp_extension_t::plugin" ref="e498b24942e6fdd73ce6c22505549680" args="" -->
  60 <div class="memitem">
  61 <div class="memproto">
  62       <table class="memname">
  63         <tr>
  64           <td class="memname"><a class="el" href="structcp__plugin__info__t.html">cp_plugin_info_t</a>* <a class="el" href="structcp__extension__t.html#e498b24942e6fdd73ce6c22505549680">plugin</a>          </td>
  65         </tr>
  66       </table>
  67 </div>
  68 <div class="memdoc">
  69
  70 <p>
  71 A pointer to plug-in information containing this extension.
  72 <p>
  73 This reverse pointer is provided to make it easy to get information about the plug-in which is hosting a particular extension.
  74 </div>
  75 </div><p>
  76 <a class="anchor" name="9fe304775bea17eeba3c3fd734d1e4bc"></a><!-- doxytag: member="cp_extension_t::ext_point_id" ref="9fe304775bea17eeba3c3fd734d1e4bc" args="" -->
  77 <div class="memitem">
  78 <div class="memproto">
  79       <table class="memname">
  80         <tr>
  81           <td class="memname">char* <a class="el" href="structcp__extension__t.html#9fe304775bea17eeba3c3fd734d1e4bc">ext_point_id</a>          </td>
  82         </tr>
  83       </table>
  84 </div>
  85 <div class="memdoc">
  86
  87 <p>
  88 The unique identifier of the extension point this extension is attached to.
  89 <p>
  90 This corresponds to the <em>point</em> attribute of an <em>extension</em> element in a plug-in descriptor.
  91 </div>
  92 </div><p>
  93 <a class="anchor" name="eb234b64f623fd6c2bcbbc98bacb99ce"></a><!-- doxytag: member="cp_extension_t::local_id" ref="eb234b64f623fd6c2bcbbc98bacb99ce" 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__extension__t.html#eb234b64f623fd6c2bcbbc98bacb99ce">local_id</a>          </td>
  99         </tr>
 100       </table>
 101 </div>
 102 <div class="memdoc">
 103
 104 <p>
 105 An optional local identifier uniquely identifying the extension within the host plug-in.
 106 <p>
 107 NULL if not available. This corresponds to the <em>id</em> attribute of an <em>extension</em> element in a plug-in descriptor.
 108 </div>
 109 </div><p>
 110 <a class="anchor" name="f5351a0143adaf16c64b881aee01d893"></a><!-- doxytag: member="cp_extension_t::identifier" ref="f5351a0143adaf16c64b881aee01d893" 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__extension__t.html#f5351a0143adaf16c64b881aee01d893">identifier</a>          </td>
 116         </tr>
 117       </table>
 118 </div>
 119 <div class="memdoc">
 120
 121 <p>
 122 An optional unique identifier of the extension.
 123 <p>
 124 NULL if not available. This is automatically constructed by concatenating the identifier of the host plug-in and the local identifier of the extension.
 125 </div>
 126 </div><p>
 127 <a class="anchor" name="5ac083a645d964373f022d03df4849c8"></a><!-- doxytag: member="cp_extension_t::name" ref="5ac083a645d964373f022d03df4849c8" args="" -->
 128 <div class="memitem">
 129 <div class="memproto">
 130       <table class="memname">
 131         <tr>
 132           <td class="memname">char* <a class="el" href="structcp__extension__t.html#5ac083a645d964373f022d03df4849c8">name</a>          </td>
 133         </tr>
 134       </table>
 135 </div>
 136 <div class="memdoc">
 137
 138 <p>
 139 An optional extension name.
 140 <p>
 141 NULL if not available. The extension name is intended for display purposes only and the value can be localized. This corresponds to the <em>name</em> attribute of an <em>extension</em> element in a plug-in descriptor.
 142 </div>
 143 </div><p>
 144 <a class="anchor" name="a745fad14a2300fd48e55c33f580f91b"></a><!-- doxytag: member="cp_extension_t::configuration" ref="a745fad14a2300fd48e55c33f580f91b" args="" -->
 145 <div class="memitem">
 146 <div class="memproto">
 147       <table class="memname">
 148         <tr>
 149           <td class="memname"><a class="el" href="structcp__cfg__element__t.html">cp_cfg_element_t</a>* <a class="el" href="structcp__extension__t.html#a745fad14a2300fd48e55c33f580f91b">configuration</a>          </td>
 150         </tr>
 151       </table>
 152 </div>
 153 <div class="memdoc">
 154
 155 <p>
 156 Extension configuration starting with the extension element.
 157 <p>
 158 This includes extension configuration information as a tree of configuration elements. These correspond to the <em>extension</em> element and its contents in a plug-in descriptor.
 159 </div>
 160 </div><p>
 161 <hr>The documentation for this struct was generated from the following file:<ul>
 162 <li><a class="el" href="cpluff_8h-source.html">cpluff.h</a></ul>
 163 <hr size="1">
 164 <p class="footer">
 165 <a href="http://www.c-pluff.org/">C-Pluff</a>, a plug-in framework for C<br>
 166 Copyright 2007 <a href="http://www.jlehtinen.net/">Johannes Lehtinen</a>
 167 </p>
 168 <p class="generated-by">
 169 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
 170 </p>
 171 </body>
 172 </html>