<!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: csSaverFile 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>csSaverFile Class Reference</h1><!-- doxytag: class="csSaverFile" --><!-- doxytag: inherits="scfImplementationExt2< csSaverFile, csObject, iSaverFile, iSelfDestruct >" -->An object containing information about where to save a file. <a href="#_details">More...</a> <p> <code>#include <<a class="el" href="cstool_2saverfile_8h-source.html">cstool/saverfile.h</a>></code> <p> <div class="dynheader"> Inheritance diagram for csSaverFile:</div> <div class="dynsection"> <p><center><img src="classcsSaverFile__inherit__graph.png" border="0" usemap="#csSaverFile__inherit__map" alt="Inheritance graph"></center> <map name="csSaverFile__inherit__map"> <area shape="rect" href="classscfImplementationExt2.html" title="scfImplementationExt2\< csSaverFile, csObject, iSaverFile, iSelfDestruct \>" alt="" coords="41,316,540,343"><area shape="rect" href="classcsObject.html" title="A generic csObject class." alt="" coords="151,239,225,265"><area shape="rect" href="classscfImplementation1.html" title="scfImplementation1\< csObject, iObject \>" alt="" coords="35,161,320,188"><area shape="rect" href="classscfImplementation.html" title="scfImplementation\< csObject \>" alt="" coords="5,84,232,111"><area shape="rect" href="structiBase.html" title="This is the basic interface: all other interfaces should be derived from this one..." alt="" coords="295,7,351,33"><area shape="rect" href="structiObject.html" title="This interface is an SCF interface for encapsulating csObject." alt="" coords="256,84,320,111"><area shape="rect" href="structiSaverFile.html" title="This interface represents a CS file to save to." alt="" coords="249,239,332,265"><area shape="rect" href="structiSelfDestruct.html" title="An object implementing this interface can remove itself from its 'natural parent'..." alt="" coords="356,239,460,265"><area shape="rect" href="classCS_1_1Memory_1_1CustomAllocated.html" title="Class that overrides operator new/operator delete/etc." alt="" coords="8,7,229,33"></map> <center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div> <p> <a href="classcsSaverFile-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="classcsSaverFile.html#6e7feeb8d37e29bab7dcc70e5b74ea7c">csSaverFile</a> (const char *file, int filetype)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">The constructor. <a href="#6e7feeb8d37e29bab7dcc70e5b74ea7c"></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="classcsSaverFile.html#2c73171ffb2fcef77ae38904cde6e6f2">GetFile</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the file name of the saver file. <a href="#2c73171ffb2fcef77ae38904cde6e6f2"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsSaverFile.html#cea7faf8be3631f15b3aba3a89d74bb2">GetFileType</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the type of the saver file. <a href="#cea7faf8be3631f15b3aba3a89d74bb2"></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="classcsSaverFile.html#b11a80099468f60219a408c367e3ee58">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 object. <a href="#b11a80099468f60219a408c367e3ee58"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsSaverFile.html#0cfa864a91dd4671adc7818d65678e0a">SelfDestruct</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Remove me! <a href="#0cfa864a91dd4671adc7818d65678e0a"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsSaverFile.html#a0db4204c80404b622dd2abe03871634">~csSaverFile</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">The destructor. <a href="#a0db4204c80404b622dd2abe03871634"></a><br></td></tr> </table> <hr><a name="_details"></a><h2>Detailed Description</h2> An object containing information about where to save a file. <p> Parent this <a class="el" href="structiObject.html" title="This interface is an SCF interface for encapsulating csObject.">iObject</a> to engine objects. <p>Definition at line <a class="el" href="cstool_2saverfile_8h-source.html#l00037">37</a> of file <a class="el" href="cstool_2saverfile_8h-source.html">saverfile.h</a>.</p> <hr><h2>Constructor & Destructor Documentation</h2> <a class="anchor" name="6e7feeb8d37e29bab7dcc70e5b74ea7c"></a><!-- doxytag: member="csSaverFile::csSaverFile" ref="6e7feeb8d37e29bab7dcc70e5b74ea7c" args="(const char *file, int filetype)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">csSaverFile::csSaverFile </td> <td>(</td> <td class="paramtype">const char * </td> <td class="paramname"> <em>file</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"> <em>filetype</em></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="a0db4204c80404b622dd2abe03871634"></a><!-- doxytag: member="csSaverFile::~csSaverFile" ref="a0db4204c80404b622dd2abe03871634" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual csSaverFile::~csSaverFile </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="2c73171ffb2fcef77ae38904cde6e6f2"></a><!-- doxytag: member="csSaverFile::GetFile" ref="2c73171ffb2fcef77ae38904cde6e6f2" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual const char* csSaverFile::GetFile </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 saver file. <p> <p>Implements <a class="el" href="structiSaverFile.html#99f9fff1d2c845ac8a7564fde064cfb5">iSaverFile</a>.</p> </div> </div><p> <a class="anchor" name="cea7faf8be3631f15b3aba3a89d74bb2"></a><!-- doxytag: member="csSaverFile::GetFileType" ref="cea7faf8be3631f15b3aba3a89d74bb2" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual int csSaverFile::GetFileType </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 type of the saver file. <p> <p>Implements <a class="el" href="structiSaverFile.html#22f720eae2bbbb29ea8eef5514f85b4d">iSaverFile</a>.</p> </div> </div><p> <a class="anchor" name="b11a80099468f60219a408c367e3ee58"></a><!-- doxytag: member="csSaverFile::QueryObject" ref="b11a80099468f60219a408c367e3ee58" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual <a class="el" href="structiObject.html">iObject</a>* csSaverFile::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 object. <p> <p>Implements <a class="el" href="structiSaverFile.html#bcfc100217de3421a4a1317caa520106">iSaverFile</a>.</p> <p>Definition at line <a class="el" href="cstool_2saverfile_8h-source.html#l00052">52</a> of file <a class="el" href="cstool_2saverfile_8h-source.html">saverfile.h</a>.</p> </div> </div><p> <a class="anchor" name="0cfa864a91dd4671adc7818d65678e0a"></a><!-- doxytag: member="csSaverFile::SelfDestruct" ref="0cfa864a91dd4671adc7818d65678e0a" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void csSaverFile::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_2saverfile_8h-source.html#l00058">58</a> of file <a class="el" href="cstool_2saverfile_8h-source.html">saverfile.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_2saverfile_8h-source.html">saverfile.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>