Sophie

Sophie

distrib > Mandriva > 2010.0 > i586 > media > contrib-release > by-pkgid > bad97183153701b09df5fae1052b1c30 > files > 862

crystalspace-doc-1.2.1-5mdv2010.0.i586.rpm

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>Crystal Space 1.2.1: csPluginLoader Class Reference (Crystal Space 1.2.1 Public API Reference)</title>
<link href="tabs.css" rel="stylesheet" type="text/css">
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<table border="0" cellpadding="0" cellspacing="0" width="100%" class="head">
 <tr height="59">
  <td class="head" width="202" valign="bottom" style="padding-left:0;"><a href="http://www.crystalspace3d.org/"><img src="csblur.png" width="236" height="59" alt="CrystalSpace" border="0"></a></td>
  <td class="head"><h2>Public API Reference</h2></td>
 </tr>
 <tr height="11">
  <td colspan="2" class="headshadow" valign="top" style="padding-left:0;"><img src="csblurb.png" width="236" height="11" alt="" border="0"></td>
 </tr>
</table>
<div class="content">
<!-- Generated by Doxygen 1.5.3 -->
<div class="tabs">
  <ul>
    <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
    <li><a href="modules.html"><span>Modules</span></a></li>
    <li><a href="namespaces.html"><span>Namespaces</span></a></li>
    <li class="current"><a href="classes.html"><span>Classes</span></a></li>
    <li><a href="files.html"><span>Files</span></a></li>
    <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
  </ul>
</div>
<div class="tabs">
  <ul>
    <li><a href="classes.html"><span>Alphabetical&nbsp;List</span></a></li>
    <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
    <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
    <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
  </ul>
</div>
<h1>csPluginLoader Class Reference</h1><!-- doxytag: class="csPluginLoader" -->This utility class helps to load plugins based on request, config file, and commandline.  
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="plugldr_8h-source.html">csutil/plugldr.h</a>&gt;</code>
<p>

<p>
<a href="classcsPluginLoader-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsPluginLoader.html#1069dd9796c2e8f656f9d01c4ee1b726">csPluginLoader</a> (<a class="el" href="structiObjectRegistry.html">iObjectRegistry</a> *object_reg)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Initialize.  <a href="#1069dd9796c2e8f656f9d01c4ee1b726"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsPluginLoader.html#c2fafefe0a2d174475c699588e675ffe">LoadPlugins</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Load the plugins.  <a href="#c2fafefe0a2d174475c699588e675ffe"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsPluginLoader.html#0da92ea4dcd53e0689974befa61f128b">RequestPlugin</a> (const char *pluginName, const char *tagName)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">A shortcut for requesting to load a plugin (before <a class="el" href="classcsPluginLoader.html#c2fafefe0a2d174475c699588e675ffe" title="Load the plugins.">LoadPlugins()</a>).  <a href="#0da92ea4dcd53e0689974befa61f128b"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsPluginLoader.html#25342f4a3a0311cce31a062cdb32d7fe">~csPluginLoader</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Deinitialize.  <a href="#25342f4a3a0311cce31a062cdb32d7fe"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Friends</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="204a8c987a5fe5c7f3eb70bc28937419"></a><!-- doxytag: member="csPluginLoader::csPluginList" ref="204a8c987a5fe5c7f3eb70bc28937419" args="" -->
class&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsPluginLoader.html#204a8c987a5fe5c7f3eb70bc28937419">csPluginList</a></td></tr>

</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
This utility class helps to load plugins based on request, config file, and commandline. 
<p>Definition at line <a class="el" href="plugldr_8h-source.html#l00065">65</a> of file <a class="el" href="plugldr_8h-source.html">plugldr.h</a>.</p>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="1069dd9796c2e8f656f9d01c4ee1b726"></a><!-- doxytag: member="csPluginLoader::csPluginLoader" ref="1069dd9796c2e8f656f9d01c4ee1b726" args="(iObjectRegistry *object_reg)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">csPluginLoader::csPluginLoader           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structiObjectRegistry.html">iObjectRegistry</a> *&nbsp;</td>
          <td class="paramname"> <em>object_reg</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Initialize. 
<p>

</div>
</div><p>
<a class="anchor" name="25342f4a3a0311cce31a062cdb32d7fe"></a><!-- doxytag: member="csPluginLoader::~csPluginLoader" ref="25342f4a3a0311cce31a062cdb32d7fe" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual csPluginLoader::~csPluginLoader           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Deinitialize. 
<p>

</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="c2fafefe0a2d174475c699588e675ffe"></a><!-- doxytag: member="csPluginLoader::LoadPlugins" ref="c2fafefe0a2d174475c699588e675ffe" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool csPluginLoader::LoadPlugins           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Load the plugins. 
<p>

</div>
</div><p>
<a class="anchor" name="0da92ea4dcd53e0689974befa61f128b"></a><!-- doxytag: member="csPluginLoader::RequestPlugin" ref="0da92ea4dcd53e0689974befa61f128b" args="(const char *pluginName, const char *tagName)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void csPluginLoader::RequestPlugin           </td>
          <td>(</td>
          <td class="paramtype">const char *&nbsp;</td>
          <td class="paramname"> <em>pluginName</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&nbsp;</td>
          <td class="paramname"> <em>tagName</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
A shortcut for requesting to load a plugin (before <a class="el" href="classcsPluginLoader.html#c2fafefe0a2d174475c699588e675ffe" title="Load the plugins.">LoadPlugins()</a>). 
<p>
If you want this class to register the plugin as a default for some interface then you should use the interface name as the tag name (i.e. 'iGraphics3D'). Note that plugins requested with some tag here get lowest precendence. The commandline has highest priority followed by the config file. If after this no plugin with the given tag exists then <a class="el" href="classcsPluginLoader.html#0da92ea4dcd53e0689974befa61f128b" title="A shortcut for requesting to load a plugin (before LoadPlugins()).">RequestPlugin()</a> will work. 
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li>csutil/<a class="el" href="plugldr_8h-source.html">plugldr.h</a></ul>
<hr size="1"><address><small>Generated for Crystal Space 1.2.1 by 
<a href="http://www.doxygen.org/index.html">doxygen</a> 1.5.3 
</small></address> </div></body> </html>