<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <title>The Gnome Chemistry Utils: gcp::Plugin Class Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <link href="doxygen.css" rel="stylesheet" type="text/css"/> </head> <body> <!-- Generated by Doxygen 1.6.1 --> <div class="navigation" id="top"> <div class="tabs"> <ul> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="namespaces.html"><span>Namespaces</span></a></li> <li class="current"><a href="annotated.html"><span>Classes</span></a></li> <li><a href="files.html"><span>Files</span></a></li> <li><a href="dirs.html"><span>Directories</span></a></li> </ul> </div> <div class="tabs"> <ul> <li><a href="annotated.html"><span>Class List</span></a></li> <li><a href="classes.html"><span>Class Index</span></a></li> <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> <li><a href="functions.html"><span>Class Members</span></a></li> </ul> </div> <div class="navpath"><a class="el" href="namespacegcp.html">gcp</a>::<a class="el" href="classgcp_1_1Plugin.html">Plugin</a> </div> </div> <div class="contents"> <h1>gcp::Plugin Class Reference</h1><!-- doxytag: class="gcp::Plugin" --> <p>Class for GChemPaint plugins. <a href="#_details">More...</a></p> <p><code>#include <<a class="el" href="plugin_8h_source.html">gcp/plugin.h</a>></code></p> <p><a href="classgcp_1_1Plugin-members.html">List of all members.</a></p> <table border="0" cellpadding="0" cellspacing="0"> <tr><td colspan="2"><h2>Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcp_1_1Plugin.html#a7c0fb453808209a350c3d6fecee2581e">Plugin</a> ()</td></tr> <tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcp_1_1Plugin.html#a80a677ba13672987b9226d0c79ab9e60">~Plugin</a> ()</td></tr> <tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcp_1_1Plugin.html#a2ee7781a24b94977eb3eff29cc148d51">Populate</a> (<a class="el" href="classgcp_1_1Application.html">Application</a> *App)</td></tr> <tr><td colspan="2"><h2>Static Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcp_1_1Plugin.html#aa2302200422d39b7d42415e0095e5276">LoadPlugins</a> ()</td></tr> </table> <hr/><a name="_details"></a><h2>Detailed Description</h2> <p>Class for GChemPaint plugins. </p> <p>Every plugin should implement a new <a class="el" href="classgcp_1_1Plugin.html" title="Class for GChemPaint plugins.">Plugin</a> class derived from this one and create a unique static instance of the new class. The base class constructor will register the plugin. Such plugins are loaded on program startup. </p> <p>Definition at line <a class="el" href="plugin_8h_source.html#l00044">44</a> of file <a class="el" href="plugin_8h_source.html">plugin.h</a>.</p> <hr/><h2>Constructor & Destructor Documentation</h2> <a class="anchor" id="a7c0fb453808209a350c3d6fecee2581e"></a><!-- doxytag: member="gcp::Plugin::Plugin" ref="a7c0fb453808209a350c3d6fecee2581e" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">gcp::Plugin::Plugin </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>The default constructor. Adds the new plugin to <a class="el" href="namespacegcp.html#a334ebfc8c0f4b29f22359cdd9a133b1c">gcp::Plugins</a>. </p> </div> </div> <a class="anchor" id="a80a677ba13672987b9226d0c79ab9e60"></a><!-- doxytag: member="gcp::Plugin::~Plugin" ref="a80a677ba13672987b9226d0c79ab9e60" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual gcp::Plugin::~Plugin </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td><code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p>The destructor. </p> </div> </div> <hr/><h2>Member Function Documentation</h2> <a class="anchor" id="aa2302200422d39b7d42415e0095e5276"></a><!-- doxytag: member="gcp::Plugin::LoadPlugins" ref="aa2302200422d39b7d42415e0095e5276" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">static void gcp::Plugin::LoadPlugins </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td><code> [static]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Loads plugins from the GChemPaint plugin directory stored in the PLUGINSDIR variable. </p> </div> </div> <a class="anchor" id="a2ee7781a24b94977eb3eff29cc148d51"></a><!-- doxytag: member="gcp::Plugin::Populate" ref="a2ee7781a24b94977eb3eff29cc148d51" args="(Application *App)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual void gcp::Plugin::Populate </td> <td>(</td> <td class="paramtype"><a class="el" href="classgcp_1_1Application.html">Application</a> * </td> <td class="paramname"> <em>App</em></td> <td> ) </td> <td><code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <dl><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>App</em> </td><td>the GChemPaint application.</td></tr> </table> </dd> </dl> <p>Called by the framework so that the plugin can add new UI elements to the application. </p> </div> </div> <hr/>The documentation for this class was generated from the following file:<ul> <li><a class="el" href="plugin_8h_source.html">plugin.h</a></li> </ul> </div> <hr size="1"/><address style="text-align: right;"><small>Generated on Sun Sep 6 18:33:54 2009 for The Gnome Chemistry Utils by <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address> </body> </html>