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_ext_point_t Struct Reference</title>
4 <link href="doxygen.css" rel="stylesheet" type="text/css">
5 <link href="tabs.css" rel="stylesheet" type="text/css">
7 <!-- Generated by Doxygen 1.5.1 -->
10 <li><a href="index.html"><span>Main 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 Structures</span></a></li>
13 <li><a href="files.html"><span>Files</span></a></li>
14 <li><a href="pages.html"><span>Related Pages</span></a></li>
18 <li><a href="annotated.html"><span>Data Structures</span></a></li>
19 <li><a href="functions.html"><span>Data Fields</span></a></li>
21 <h1>cp_ext_point_t Struct Reference<br>
23 [<a class="el" href="group__cStructs.html">Data structures</a>]</small>
24 </h1><!-- doxytag: class="cp_ext_point_t" -->Collaboration diagram for cp_ext_point_t:<p><center><img src="structcp__ext__point__t__coll__graph.png" border="0" usemap="#cp__ext__point__t__coll__map" alt="Collaboration graph"></center>
25 <map name="cp__ext__point__t__coll__map">
26 <area href="structcp__plugin__info__t.html" shape="rect" coords="92,99,223,123" alt="">
27 <area href="structcp__extension__t.html" shape="rect" coords="160,191,283,215" alt="">
28 <area href="structcp__cfg__element__t.html" shape="rect" coords="256,99,395,123" alt="">
29 <area href="structcp__plugin__import__t.html" shape="rect" coords="156,7,306,31" alt="">
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 point structure captures information about an extension point.
34 Extension point structures are contained in <a class="el" href="structcp__plugin__info__t.html#8299ae4ef53289492911a1334494e405">cp_plugin_info_t::ext_points</a>.
36 <table border="0" cellpadding="0" cellspacing="0">
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> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structcp__ext__point__t.html#e498b24942e6fdd73ce6c22505549680">plugin</a></td></tr>
41 <tr><td class="mdescLeft"> </td><td class="mdescRight">A pointer to plug-in information containing this extension point. <a href="#e498b24942e6fdd73ce6c22505549680"></a><br></td></tr>
42 <tr><td colspan="2"><div class="groupHeader">id attribute of an</div></td></tr>
43 <tr><td colspan="2"><div class="groupText">The local identifier uniquely identifying the extension point within the host plug-in.<p>
44 This corresponds to the <em>extension-point</em> element in a plug-in descriptor. <br><br></div></td></tr>
45 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="eb234b64f623fd6c2bcbbc98bacb99ce"></a><!-- doxytag: member="cp_ext_point_t::local_id" ref="eb234b64f623fd6c2bcbbc98bacb99ce" args="" -->
46 char * </td><td class="memItemRight" valign="bottom"><b>local_id</b></td></tr>
48 <tr><td class="memItemLeft" nowrap align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="structcp__ext__point__t.html#f5351a0143adaf16c64b881aee01d893">identifier</a></td></tr>
50 <tr><td class="mdescLeft"> </td><td class="mdescRight">The unique identifier of the extension point. <a href="#f5351a0143adaf16c64b881aee01d893"></a><br></td></tr>
51 <tr><td class="memItemLeft" nowrap align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="structcp__ext__point__t.html#5ac083a645d964373f022d03df4849c8">name</a></td></tr>
53 <tr><td class="mdescLeft"> </td><td class="mdescRight">An optional extension point name. <a href="#5ac083a645d964373f022d03df4849c8"></a><br></td></tr>
54 <tr><td class="memItemLeft" nowrap align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="structcp__ext__point__t.html#2370171ff78694fa0871fd845ab3ad6f">schema_path</a></td></tr>
56 <tr><td class="mdescLeft"> </td><td class="mdescRight">An optional path to the extension schema definition. <a href="#2370171ff78694fa0871fd845ab3ad6f"></a><br></td></tr>
58 <hr><h2>Field Documentation</h2>
59 <a class="anchor" name="e498b24942e6fdd73ce6c22505549680"></a><!-- doxytag: member="cp_ext_point_t::plugin" ref="e498b24942e6fdd73ce6c22505549680" args="" -->
61 <div class="memproto">
62 <table class="memname">
64 <td class="memname"><a class="el" href="structcp__plugin__info__t.html">cp_plugin_info_t</a>* <a class="el" href="structcp__ext__point__t.html#e498b24942e6fdd73ce6c22505549680">plugin</a> </td>
71 A pointer to plug-in information containing this extension point.
73 This reverse pointer is provided to make it easy to get information about the plug-in which is hosting a particular extension point.
76 <a class="anchor" name="f5351a0143adaf16c64b881aee01d893"></a><!-- doxytag: member="cp_ext_point_t::identifier" ref="f5351a0143adaf16c64b881aee01d893" args="" -->
78 <div class="memproto">
79 <table class="memname">
81 <td class="memname">char* <a class="el" href="structcp__ext__point__t.html#f5351a0143adaf16c64b881aee01d893">identifier</a> </td>
88 The unique identifier of the extension point.
90 This is automatically constructed by concatenating the identifier of the host plug-in and the local identifier of the extension point.
93 <a class="anchor" name="5ac083a645d964373f022d03df4849c8"></a><!-- doxytag: member="cp_ext_point_t::name" ref="5ac083a645d964373f022d03df4849c8" args="" -->
95 <div class="memproto">
96 <table class="memname">
98 <td class="memname">char* <a class="el" href="structcp__ext__point__t.html#5ac083a645d964373f022d03df4849c8">name</a> </td>
105 An optional extension point name.
107 NULL if not available. The extension point 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-point</em> element in a plug-in descriptor.
110 <a class="anchor" name="2370171ff78694fa0871fd845ab3ad6f"></a><!-- doxytag: member="cp_ext_point_t::schema_path" ref="2370171ff78694fa0871fd845ab3ad6f" args="" -->
111 <div class="memitem">
112 <div class="memproto">
113 <table class="memname">
115 <td class="memname">char* <a class="el" href="structcp__ext__point__t.html#2370171ff78694fa0871fd845ab3ad6f">schema_path</a> </td>
122 An optional path to the extension schema definition.
124 NULL if not available. The path is relative to the plug-in directory. This corresponds to the <em>schema</em> attribute of an <em>extension-point</em> element in a plug-in descriptor.
127 <hr>The documentation for this struct was generated from the following file:<ul>
128 <li><a class="el" href="cpluff_8h-source.html">cpluff.h</a></ul>
131 <a href="http://www.c-pluff.org/">C-Pluff</a>, a plug-in framework for C<br>
132 Copyright 2007 <a href="http://www.jlehtinen.net/">Johannes Lehtinen</a>
134 <p class="generated-by">
135 Generated on Fri Apr 6 15:40:56 2007 for C-Pluff C API by <a href="http://www.doxygen.org/index.html"><img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.1