<!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: csAddonReference 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 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 Pages</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="classes.html"><span>Alphabetical List</span></a></li>
<li><a href="annotated.html"><span>Class List</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>
<h1>csAddonReference Class Reference</h1><!-- doxytag: class="csAddonReference" --><!-- doxytag: inherits="scfImplementationExt2< csAddonReference, csObject, iAddonReference, iSelfDestruct >" -->An object representing an addon.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="cstool_2saverref_8h-source.html">cstool/saverref.h</a>></code>
<p>
<div class="dynheader">
Inheritance diagram for csAddonReference:</div>
<div class="dynsection">
<p><center><img src="classcsAddonReference__inherit__graph.png" border="0" usemap="#csAddonReference__inherit__map" alt="Inheritance graph"></center>
<map name="csAddonReference__inherit__map">
<area shape="rect" href="classscfImplementationExt2.html" title="scfImplementationExt2\< csAddonReference, csObject, iAddonReference, iSelfDestruct \>" alt="" coords="1067,107,1664,133"><area shape="rect" href="classcsObject.html" title="A generic csObject class." alt="" coords="915,56,989,83"><area shape="rect" href="classscfImplementation1.html" title="scfImplementation1\< csObject, iObject \>" alt="" coords="551,56,836,83"><area shape="rect" href="classscfImplementation.html" title="scfImplementation\< csObject \>" alt="" coords="275,5,501,32"><area shape="rect" href="structiBase.html" title="This is the basic interface: all other interfaces should be derived from this one..." alt="" coords="88,81,144,108"><area shape="rect" href="structiObject.html" title="This interface is an SCF interface for encapsulating csObject." alt="" coords="356,56,420,83"><area shape="rect" href="structiAddonReference.html" title="This interface represents a reference to an addon." alt="" coords="887,107,1017,133"><area shape="rect" href="structiSelfDestruct.html" title="An object implementing this interface can remove itself from its 'natural parent'..." alt="" coords="900,157,1004,184"><area shape="rect" href="classCS_1_1Memory_1_1CustomAllocated.html" title="Class that overrides operator new/operator delete/etc." alt="" coords="5,5,227,32"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<p>
<a href="classcsAddonReference-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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsAddonReference.html#70bab78820b31849ec1abe7b6070831a">csAddonReference</a> (const char *plugin, const char *paramsfile, <a class="el" href="structiBase.html">iBase</a> *addonobj=0)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The constructor. <a href="#70bab78820b31849ec1abe7b6070831a"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="structiBase.html">iBase</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsAddonReference.html#da714f9a3a5b036b4bb69a7c5d9babb0">GetAddonObject</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the object that the addon references. <a href="#da714f9a3a5b036b4bb69a7c5d9babb0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsAddonReference.html#b66a1e1bc451f1282ee2a4d9e801e781">GetParamsFile</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the file name of the params file. <a href="#b66a1e1bc451f1282ee2a4d9e801e781"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsAddonReference.html#f9ca437de99cb387c7ef00ed185bcbe7">GetPlugin</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the SCF name of the plugin. <a href="#f9ca437de99cb387c7ef00ed185bcbe7"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="structiObject.html">iObject</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsAddonReference.html#4e0bb58341be550312a16343e5ee335f">QueryObject</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the <a class="el" href="structiObject.html" title="This interface is an SCF interface for encapsulating csObject.">iObject</a> for this interface. <a href="#4e0bb58341be550312a16343e5ee335f"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsAddonReference.html#61e5c817e970c0347dfec36dfb40971c">SelfDestruct</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Remove me! <a href="#61e5c817e970c0347dfec36dfb40971c"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsAddonReference.html#b83cba29c6573fd646111014a342e360">~csAddonReference</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The destructor. <a href="#b83cba29c6573fd646111014a342e360"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
An object representing an addon.
<p>Definition at line <a class="el" href="cstool_2saverref_8h-source.html#l00068">68</a> of file <a class="el" href="cstool_2saverref_8h-source.html">saverref.h</a>.</p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="70bab78820b31849ec1abe7b6070831a"></a><!-- doxytag: member="csAddonReference::csAddonReference" ref="70bab78820b31849ec1abe7b6070831a" args="(const char *plugin, const char *paramsfile, iBase *addonobj=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">csAddonReference::csAddonReference </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>plugin</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>paramsfile</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structiBase.html">iBase</a> * </td>
<td class="paramname"> <em>addonobj</em> = <code>0</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
The constructor.
<p>
</div>
</div><p>
<a class="anchor" name="b83cba29c6573fd646111014a342e360"></a><!-- doxytag: member="csAddonReference::~csAddonReference" ref="b83cba29c6573fd646111014a342e360" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual csAddonReference::~csAddonReference </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
The destructor.
<p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="da714f9a3a5b036b4bb69a7c5d9babb0"></a><!-- doxytag: member="csAddonReference::GetAddonObject" ref="da714f9a3a5b036b4bb69a7c5d9babb0" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="structiBase.html">iBase</a>* csAddonReference::GetAddonObject </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the object that the addon references.
<p>
<p>Implements <a class="el" href="structiAddonReference.html#e92aede02e79729f6f90fac572c6a1df">iAddonReference</a>.</p>
</div>
</div><p>
<a class="anchor" name="b66a1e1bc451f1282ee2a4d9e801e781"></a><!-- doxytag: member="csAddonReference::GetParamsFile" ref="b66a1e1bc451f1282ee2a4d9e801e781" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const char* csAddonReference::GetParamsFile </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the file name of the params file.
<p>
<p>Implements <a class="el" href="structiAddonReference.html#76cd18a11a0d38f0b697f8f5f4513b4e">iAddonReference</a>.</p>
</div>
</div><p>
<a class="anchor" name="f9ca437de99cb387c7ef00ed185bcbe7"></a><!-- doxytag: member="csAddonReference::GetPlugin" ref="f9ca437de99cb387c7ef00ed185bcbe7" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const char* csAddonReference::GetPlugin </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the SCF name of the plugin.
<p>
<p>Implements <a class="el" href="structiAddonReference.html#674f0d12142ee52198393ae4f4774b87">iAddonReference</a>.</p>
</div>
</div><p>
<a class="anchor" name="4e0bb58341be550312a16343e5ee335f"></a><!-- doxytag: member="csAddonReference::QueryObject" ref="4e0bb58341be550312a16343e5ee335f" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="structiObject.html">iObject</a>* csAddonReference::QueryObject </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the <a class="el" href="structiObject.html" title="This interface is an SCF interface for encapsulating csObject.">iObject</a> for this interface.
<p>
<p>Implements <a class="el" href="structiAddonReference.html#68c39a062ae3596c2fb06375d22d0e38">iAddonReference</a>.</p>
<p>Definition at line <a class="el" href="cstool_2saverref_8h-source.html#l00091">91</a> of file <a class="el" href="cstool_2saverref_8h-source.html">saverref.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="61e5c817e970c0347dfec36dfb40971c"></a><!-- doxytag: member="csAddonReference::SelfDestruct" ref="61e5c817e970c0347dfec36dfb40971c" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void csAddonReference::SelfDestruct </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Remove me!
<p>
<p>Implements <a class="el" href="structiSelfDestruct.html#cbd9e2f83310f6e6a14317816d5179af">iSelfDestruct</a>.</p>
<p>Definition at line <a class="el" href="cstool_2saverref_8h-source.html#l00093">93</a> of file <a class="el" href="cstool_2saverref_8h-source.html">saverref.h</a>.</p>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li>cstool/<a class="el" href="cstool_2saverref_8h-source.html">saverref.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>
distrib
>
Mandriva
>
2010.0
>
i586
>
media
>
contrib-release
>
by-pkgid
>
bad97183153701b09df5fae1052b1c30
>
files
>
229
