Sophie

Sophie

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

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: iAddonReference Struct 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>iAddonReference Struct Reference</h1><!-- doxytag: class="iAddonReference" --><!-- doxytag: inherits="iBase" -->This interface represents a reference to an addon.  
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="imap_2saverref_8h-source.html">imap/saverref.h</a>&gt;</code>
<p>
<div class="dynheader">
Inheritance diagram for iAddonReference:</div>
<div class="dynsection">
<p><center><img src="structiAddonReference__inherit__graph.png" border="0" usemap="#iAddonReference__inherit__map" alt="Inheritance graph"></center>
<map name="iAddonReference__inherit__map">
<area shape="rect" href="classscfImplementationExt2.html" title="scfImplementationExt2\&lt; csAddonReference, csObject, iAddonReference, iSelfDestruct \&gt;" alt="" coords="291,5,888,32"><area shape="rect" href="structiBase.html" title="This is the basic interface: all other interfaces should be derived from this one..." alt="" coords="5,5,61,32"><area shape="rect" href="classcsAddonReference.html" title="An object representing an addon." alt="" coords="937,5,1079,32"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>

<p>
<a href="structiAddonReference-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">virtual <a class="el" href="structiBase.html">iBase</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structiAddonReference.html#e92aede02e79729f6f90fac572c6a1df">GetAddonObject</a> () const =0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the object that the addon references.  <a href="#e92aede02e79729f6f90fac572c6a1df"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const char *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structiAddonReference.html#76cd18a11a0d38f0b697f8f5f4513b4e">GetParamsFile</a> () const =0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the file name of the params file.  <a href="#76cd18a11a0d38f0b697f8f5f4513b4e"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const char *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structiAddonReference.html#674f0d12142ee52198393ae4f4774b87">GetPlugin</a> () const =0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the SCF name of the plugin.  <a href="#674f0d12142ee52198393ae4f4774b87"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="structiObject.html">iObject</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structiAddonReference.html#68c39a062ae3596c2fb06375d22d0e38">QueryObject</a> ()=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</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="#68c39a062ae3596c2fb06375d22d0e38"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
This interface represents a reference to an addon. 
<p>Definition at line <a class="el" href="imap_2saverref_8h-source.html#l00061">61</a> of file <a class="el" href="imap_2saverref_8h-source.html">saverref.h</a>.</p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="e92aede02e79729f6f90fac572c6a1df"></a><!-- doxytag: member="iAddonReference::GetAddonObject" ref="e92aede02e79729f6f90fac572c6a1df" args="() const =0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual <a class="el" href="structiBase.html">iBase</a>* iAddonReference::GetAddonObject           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"> const<code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Get the object that the addon references. 
<p>

<p>Implemented in <a class="el" href="classcsAddonReference.html#da714f9a3a5b036b4bb69a7c5d9babb0">csAddonReference</a>.</p>

</div>
</div><p>
<a class="anchor" name="76cd18a11a0d38f0b697f8f5f4513b4e"></a><!-- doxytag: member="iAddonReference::GetParamsFile" ref="76cd18a11a0d38f0b697f8f5f4513b4e" args="() const =0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual const char* iAddonReference::GetParamsFile           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"> const<code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Get the file name of the params file. 
<p>

<p>Implemented in <a class="el" href="classcsAddonReference.html#b66a1e1bc451f1282ee2a4d9e801e781">csAddonReference</a>.</p>

</div>
</div><p>
<a class="anchor" name="674f0d12142ee52198393ae4f4774b87"></a><!-- doxytag: member="iAddonReference::GetPlugin" ref="674f0d12142ee52198393ae4f4774b87" args="() const =0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual const char* iAddonReference::GetPlugin           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"> const<code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Get the SCF name of the plugin. 
<p>

<p>Implemented in <a class="el" href="classcsAddonReference.html#f9ca437de99cb387c7ef00ed185bcbe7">csAddonReference</a>.</p>

</div>
</div><p>
<a class="anchor" name="68c39a062ae3596c2fb06375d22d0e38"></a><!-- doxytag: member="iAddonReference::QueryObject" ref="68c39a062ae3596c2fb06375d22d0e38" args="()=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual <a class="el" href="structiObject.html">iObject</a>* iAddonReference::QueryObject           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [pure 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>Implemented in <a class="el" href="classcsAddonReference.html#4e0bb58341be550312a16343e5ee335f">csAddonReference</a>.</p>

</div>
</div><p>
<hr>The documentation for this struct was generated from the following file:<ul>
<li>imap/<a class="el" href="imap_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>