<!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"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>GG: GG::PluginManager Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">GG
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.1 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</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>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceGG.html">GG</a></li><li class="navelem"><a class="el" href="classGG_1_1PluginManager.html">PluginManager</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-static-methods">Static Public Member Functions</a> |
<a href="#friends">Friends</a> </div>
<div class="headertitle">
<div class="title">GG::PluginManager Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include <<a class="el" href="PluginInterface_8h_source.html">PluginInterface.h</a>></code></p>
<p><a href="classGG_1_1PluginManager-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a37aefcb837570baa4332e89443bb8f25"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGG_1_1PluginManager.html#a37aefcb837570baa4332e89443bb8f25">InitDynamicLoader</a> ()</td></tr>
<tr class="memitem:adc8d8e8f80bffcd5a18d35b075f9f4a1"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGG_1_1PluginManager.html#adc8d8e8f80bffcd5a18d35b075f9f4a1">AddSearchDirectory</a> (const std::string &dir)</td></tr>
<tr class="memitem:a6de470fe8ae324ac5ce9c31420542830"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGG_1_1PluginManager.html#a6de470fe8ae324ac5ce9c31420542830">CleanupDynamicLoader</a> ()</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="friends"></a>
Friends</h2></td></tr>
<tr class="memitem:a5deadf311b9d919ea6e5c504ebbc4edd"><td class="memItemLeft" align="right" valign="top">GG_API <a class="el" href="classGG_1_1PluginManager.html">PluginManager</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classGG_1_1PluginManager.html#a5deadf311b9d919ea6e5c504ebbc4edd">GetPluginManager</a> ()</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="member-group"></a>
Mutators</h2></td></tr>
<tr class="memitem:a7970400fcc79d2d2dfddf7f08d7ac9c9"><td class="memItemLeft" align="right" valign="top">boost::shared_ptr<br class="typebreak"/>
< <a class="el" href="classGG_1_1PluginInterface.html">PluginInterface</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGG_1_1PluginManager.html#a7970400fcc79d2d2dfddf7f08d7ac9c9">GetPlugin</a> (const std::string &name)</td></tr>
<tr class="memitem:a068df26345255f197da1a93bf2bdf808"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGG_1_1PluginManager.html#a068df26345255f197da1a93bf2bdf808">FreePlugin</a> (const std::string &name)</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="inherited"></a>
Additional Inherited Members</h2></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>A singleton that loads and stores textures for use by <a class="el" href="namespaceGG.html" title="The namespace that encloses all GG classes, functions, typedefs, enums, etc.">GG</a>. </p>
<p>This class is essentially a very thin wrapper around a map of <a class="el" href="classGG_1_1PluginInterface.html" title="The interface to custom-control plugins.">PluginInterface</a> smart pointers, keyed on std::string plugin names. The user need only request a plugin through <a class="el" href="classGG_1_1PluginManager.html#a7970400fcc79d2d2dfddf7f08d7ac9c9">GetPlugin()</a>; if the plugin is not already resident, it will be loaded. </p>
<p>Definition at line <a class="el" href="PluginInterface_8h_source.html#l00117">117</a> of file <a class="el" href="PluginInterface_8h_source.html">PluginInterface.h</a>.</p>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a7970400fcc79d2d2dfddf7f08d7ac9c9"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">boost::shared_ptr<<a class="el" href="classGG_1_1PluginInterface.html">PluginInterface</a>> GG::PluginManager::GetPlugin </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>name</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns a shared_ptr to the plugin interface created from plugin <em>name</em>. If the plugin is not present in the manager's pool, it will be loaded from disk. </p>
</div>
</div>
<a class="anchor" id="a068df26345255f197da1a93bf2bdf808"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void GG::PluginManager::FreePlugin </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>name</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Removes the manager's shared_ptr to the plugin created from file <em>name</em>, if it exists. </p>
<dl class="section note"><dt>Note:</dt><dd>Due to shared_ptr semantics, the plugin may not be deleted until much later. </dd></dl>
</div>
</div>
<a class="anchor" id="a37aefcb837570baa4332e89443bb8f25"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static void GG::PluginManager::InitDynamicLoader </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Initializes the dynamic loader system that loads and unloads plugins. This is available as a convenience only; it will be called automatically as needed. </p>
</div>
</div>
<a class="anchor" id="adc8d8e8f80bffcd5a18d35b075f9f4a1"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static void GG::PluginManager::AddSearchDirectory </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>dir</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Adds a directory which should be searched for plugins. </p>
</div>
</div>
<a class="anchor" id="a6de470fe8ae324ac5ce9c31420542830"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static void GG::PluginManager::CleanupDynamicLoader </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Cleans up the dynamic loader system that loads and unloads plugins. This should be called manually when desiredl it will never be called by other <a class="el" href="classGG_1_1PluginInterface.html" title="The interface to custom-control plugins.">PluginInterface</a> code. </p>
</div>
</div>
<hr/><h2>Friends And Related Function Documentation</h2>
<a class="anchor" id="a5deadf311b9d919ea6e5c504ebbc4edd"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">GG_API <a class="el" href="classGG_1_1PluginManager.html">PluginManager</a>& GetPluginManager </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">friend</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the singleton <a class="el" href="classGG_1_1PluginManager.html" title="A singleton that loads and stores textures for use by GG.">PluginManager</a> instance. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="PluginInterface_8h_source.html">PluginInterface.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Jun 15 2012 15:13:31 for GG by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.1
</small></address>
</body>
</html>
