<!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: iSaver 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 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>iSaver Struct Reference</h1><!-- doxytag: class="iSaver" --><!-- doxytag: inherits="iBase" -->This interface is used to serialize the engine contents.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="saver_8h-source.html">imap/saver.h</a>></code>
<p>
<div class="dynheader">
Inheritance diagram for iSaver:</div>
<div class="dynsection">
<p><center><img src="structiSaver__inherit__graph.png" border="0" usemap="#iSaver__inherit__map" alt="Inheritance graph"></center>
<map name="iSaver__inherit__map">
<area shape="rect" href="structiBase.html" title="This is the basic interface: all other interfaces should be derived from this one..." alt="" coords="8,7,64,33"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<p>
<a href="structiSaver-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 colspan="2"><div class="groupHeader">Whole world saving</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structiSaver.html#325913dbb9fbaa35609151c3008c8542">SaveAllRegions</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Save all regions to their respective files. <a href="#325913dbb9fbaa35609151c3008c8542"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structiSaver.html#cd4eb13e235e473329dfab5ec23ed9a3">SaveMapFile</a> (<a class="el" href="classcsRef.html">csRef</a>< <a class="el" href="structiDocumentNode.html">iDocumentNode</a> > &root)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Save map to DocumentNode. <a href="#cd4eb13e235e473329dfab5ec23ed9a3"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classcsRef.html">csRef</a>< <a class="el" href="structiString.html">iString</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="structiSaver.html#8ee9c66fb0ec58d44f51fcab46a0e792">SaveMapFile</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the current engine contents as a string. <a href="#8ee9c66fb0ec58d44f51fcab46a0e792"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structiSaver.html#2978bb4c6d11ac2e80f731c09ff0b6bd">SaveMapFile</a> (const char *filename)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Save the current engine contents to the filename. <a href="#2978bb4c6d11ac2e80f731c09ff0b6bd"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structiSaver.html#b7ac5da709c98bb47959978cb486a00c">SaveRegion</a> (<a class="el" href="structiRegion.html">iRegion</a> *region, int filetype, <a class="el" href="classcsRef.html">csRef</a>< <a class="el" href="structiDocumentNode.html">iDocumentNode</a> > &root)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Save region to the document node. <a href="#b7ac5da709c98bb47959978cb486a00c"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classcsRef.html">csRef</a>< <a class="el" href="structiString.html">iString</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="structiSaver.html#a426d73190d3f621ec0fa041f41b96e8">SaveRegion</a> (<a class="el" href="structiRegion.html">iRegion</a> *region, int filetype)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the region contents as a string. <a href="#a426d73190d3f621ec0fa041f41b96e8"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structiSaver.html#ef9d97ffb549dfae1eb5814dfec3243c">SaveRegionFile</a> (<a class="el" href="structiRegion.html">iRegion</a> *region, const char *filename, int filetype)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Save a region to the file attached to it using <a class="el" href="structiSaverFile.html" title="This interface represents a CS file to save to.">iSaverFile</a>. <a href="#ef9d97ffb549dfae1eb5814dfec3243c"></a><br></td></tr>
<tr><td colspan="2"><div class="groupHeader">Fine-grained saving</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structiSaver.html#7e2fd8e7986bd04a0026067416c2c1c3">SavePortal</a> (<a class="el" href="structiPortal.html">iPortal</a> *portal, <a class="el" href="structiDocumentNode.html">iDocumentNode</a> *parent)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Save a portal to the given document node. <a href="#7e2fd8e7986bd04a0026067416c2c1c3"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
This interface is used to serialize the engine contents.
<p>Definition at line <a class="el" href="saver_8h-source.html#l00036">36</a> of file <a class="el" href="saver_8h-source.html">saver.h</a>.</p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="325913dbb9fbaa35609151c3008c8542"></a><!-- doxytag: member="iSaver::SaveAllRegions" ref="325913dbb9fbaa35609151c3008c8542" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool iSaver::SaveAllRegions </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Save all regions to their respective files.
<p>
Regions that do not have any <a class="el" href="structiSaverFile.html" title="This interface represents a CS file to save to.">iSaverFile</a> attached will not be saved.
</div>
</div><p>
<a class="anchor" name="cd4eb13e235e473329dfab5ec23ed9a3"></a><!-- doxytag: member="iSaver::SaveMapFile" ref="cd4eb13e235e473329dfab5ec23ed9a3" args="(csRef< iDocumentNode > &root)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool iSaver::SaveMapFile </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classcsRef.html">csRef</a>< <a class="el" href="structiDocumentNode.html">iDocumentNode</a> > & </td>
<td class="paramname"> <em>root</em> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Save map to DocumentNode.
<p>
</div>
</div><p>
<a class="anchor" name="8ee9c66fb0ec58d44f51fcab46a0e792"></a><!-- doxytag: member="iSaver::SaveMapFile" ref="8ee9c66fb0ec58d44f51fcab46a0e792" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classcsRef.html">csRef</a><<a class="el" href="structiString.html">iString</a>> iSaver::SaveMapFile </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return the current engine contents as a string.
<p>
</div>
</div><p>
<a class="anchor" name="2978bb4c6d11ac2e80f731c09ff0b6bd"></a><!-- doxytag: member="iSaver::SaveMapFile" ref="2978bb4c6d11ac2e80f731c09ff0b6bd" args="(const char *filename)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool iSaver::SaveMapFile </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>filename</em> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Save the current engine contents to the filename.
<p>
</div>
</div><p>
<a class="anchor" name="7e2fd8e7986bd04a0026067416c2c1c3"></a><!-- doxytag: member="iSaver::SavePortal" ref="7e2fd8e7986bd04a0026067416c2c1c3" args="(iPortal *portal, iDocumentNode *parent)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool iSaver::SavePortal </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structiPortal.html">iPortal</a> * </td>
<td class="paramname"> <em>portal</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structiDocumentNode.html">iDocumentNode</a> * </td>
<td class="paramname"> <em>parent</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Save a portal to the given document node.
<p>
Will create a '<code>portal</code>' node below <code>parent</code>.
</div>
</div><p>
<a class="anchor" name="b7ac5da709c98bb47959978cb486a00c"></a><!-- doxytag: member="iSaver::SaveRegion" ref="b7ac5da709c98bb47959978cb486a00c" args="(iRegion *region, int filetype, csRef< iDocumentNode > &root)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool iSaver::SaveRegion </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structiRegion.html">iRegion</a> * </td>
<td class="paramname"> <em>region</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>filetype</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classcsRef.html">csRef</a>< <a class="el" href="structiDocumentNode.html">iDocumentNode</a> > & </td>
<td class="paramname"> <em>root</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Save region to the document node.
<p>
</div>
</div><p>
<a class="anchor" name="a426d73190d3f621ec0fa041f41b96e8"></a><!-- doxytag: member="iSaver::SaveRegion" ref="a426d73190d3f621ec0fa041f41b96e8" args="(iRegion *region, int filetype)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classcsRef.html">csRef</a><<a class="el" href="structiString.html">iString</a>> iSaver::SaveRegion </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structiRegion.html">iRegion</a> * </td>
<td class="paramname"> <em>region</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%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return the region contents as a string.
<p>
</div>
</div><p>
<a class="anchor" name="ef9d97ffb549dfae1eb5814dfec3243c"></a><!-- doxytag: member="iSaver::SaveRegionFile" ref="ef9d97ffb549dfae1eb5814dfec3243c" args="(iRegion *region, const char *filename, int filetype)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool iSaver::SaveRegionFile </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structiRegion.html">iRegion</a> * </td>
<td class="paramname"> <em>region</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>filename</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%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Save a region to the file attached to it using <a class="el" href="structiSaverFile.html" title="This interface represents a CS file to save to.">iSaverFile</a>.
<p>
</div>
</div><p>
<hr>The documentation for this struct was generated from the following file:<ul>
<li>imap/<a class="el" href="saver_8h-source.html">saver.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
>
3553
