<!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>Irrlicht Engine: irr::io::IFileReadCallBack Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<table class="irrlicht" >
<tr valign="middle">
<td><font size="2"><a class="qindex" href="index.html"><font color="#FFFFFF">Home</font></a>
| <a class="qindex" href="namespaces.html"><font color="#FFFFFF">Namespaces</font></a>
| <a class="qindex" href="hierarchy.html"><font color="#FFFFFF">Hierarchy</font></a>
| <a class="qindex" href="classes.html"><font color="#FFFFFF">Alphabetical
List</font></a> | <a class="qindex" href="annotated.html"><font color="#FFFFFF">
Class list</font></a> | <a class="qindex" href="files.html"><font color="#FFFFFF">Files</font></a>
| <a class="qindex" href="namespacemembers.html"><font color="#FFFFFF">
Namespace Members</font></a> | <a class="qindex" href="functions.html"><font color="#FFFFFF">Class
members</font></a> | <a class="qindex" href="globals.html"><font color="#FFFFFF">File
members</font></a> | <a class="qindex" href="pages.html"><font color="#FFFFFF">Tutorials</font></a></font> </td>
</tr>
</table>
<!-- Generated by Doxygen 1.5.6 -->
<div class="navpath"><a class="el" href="namespaceirr.html">irr</a>::<a class="el" href="namespaceirr_1_1io.html">io</a>::<a class="el" href="classirr_1_1io_1_1_i_file_read_call_back.html">IFileReadCallBack</a>
</div>
<div class="contents">
<h1>irr::io::IFileReadCallBack Class Reference</h1><!-- doxytag: class="irr::io::IFileReadCallBack" -->Callback class for file read abstraction.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="irr_x_m_l_8h-source.html">irrXML.h</a>></code>
<p>
<p>
<a href="classirr_1_1io_1_1_i_file_read_call_back-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 long </td><td class="memItemRight" valign="bottom"><a class="el" href="classirr_1_1io_1_1_i_file_read_call_back.html#ba9a5b45e5cdead9fb12def3069bd0ec">getSize</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns size of file in bytes. <a href="#ba9a5b45e5cdead9fb12def3069bd0ec"></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="classirr_1_1io_1_1_i_file_read_call_back.html#e8c57b8454078aa2acd39772a6aa4439">read</a> (void *buffer, int sizeToRead)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Reads an amount of bytes from the file. <a href="#e8c57b8454078aa2acd39772a6aa4439"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classirr_1_1io_1_1_i_file_read_call_back.html#91ace84f0a3966d88d78da5342eb9619">~IFileReadCallBack</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#91ace84f0a3966d88d78da5342eb9619"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Callback class for file read abstraction.
<p>
With this, it is possible to make the xml parser read in other things than just files. The Irrlicht engine is using this for example to read xml from compressed .zip files. To make the parser read in any other data, derive a class from this interface, implement the two methods to read your data and give a pointer to an instance of your implementation when calling <a class="el" href="namespaceirr_1_1io.html#581f4d4648398759c61266d63d7106b1" title="Creates an instance of an UFT-8 or ASCII character xml parser.">createIrrXMLReader()</a>, <a class="el" href="namespaceirr_1_1io.html#86473ef152c15b685af181a4c5461a5d" title="Creates an instance of an UFT-16 xml parser.">createIrrXMLReaderUTF16()</a> or <a class="el" href="namespaceirr_1_1io.html#e05bf7ee342431ea8c98fb98e75b974a" title="Creates an instance of an UFT-32 xml parser.">createIrrXMLReaderUTF32()</a>
<p>Definition at line <a class="el" href="irr_x_m_l_8h-source.html#l00213">213</a> of file <a class="el" href="irr_x_m_l_8h-source.html">irrXML.h</a>.</p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="91ace84f0a3966d88d78da5342eb9619"></a><!-- doxytag: member="irr::io::IFileReadCallBack::~IFileReadCallBack" ref="91ace84f0a3966d88d78da5342eb9619" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual irr::io::IFileReadCallBack::~IFileReadCallBack </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Destructor.
<p>
<p>Definition at line <a class="el" href="irr_x_m_l_8h-source.html#l00218">218</a> of file <a class="el" href="irr_x_m_l_8h-source.html">irrXML.h</a>.</p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="ba9a5b45e5cdead9fb12def3069bd0ec"></a><!-- doxytag: member="irr::io::IFileReadCallBack::getSize" ref="ba9a5b45e5cdead9fb12def3069bd0ec" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual long irr::io::IFileReadCallBack::getSize </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns size of file in bytes.
<p>
</div>
</div><p>
<a class="anchor" name="e8c57b8454078aa2acd39772a6aa4439"></a><!-- doxytag: member="irr::io::IFileReadCallBack::read" ref="e8c57b8454078aa2acd39772a6aa4439" args="(void *buffer, int sizeToRead)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int irr::io::IFileReadCallBack::read </td>
<td>(</td>
<td class="paramtype">void * </td>
<td class="paramname"> <em>buffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>sizeToRead</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Reads an amount of bytes from the file.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>buffer,:</em> </td><td>Pointer to buffer where to read bytes will be written to. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>sizeToRead,:</em> </td><td>Amount of bytes to read from the file. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Returns how much bytes were read. </dd></dl>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="irr_x_m_l_8h-source.html">irrXML.h</a></ul>
</div>
<hr size="1">
<address style="align: right;">
<small> </small>
</address>
<table width="100%" border="0" cellspacing="0" cellpadding="2">
<tr>
<td width="0"> <div align="left"><small><a href="http://irrlicht.sourceforge.net" target="_blank"><img src="irrlicht.png" alt="The Irrlicht Engine" align="middle" border=0 width=88 height=31></a></small></div></td>
<td> <div align="left"><small><em><font size="2">The <a href="http://irrlicht.sourceforge.net" target="_blank">Irrlicht
Engine</a> Documentation © 2003-2009 by Nikolaus Gebhardt. Generated
on Sun Jan 10 09:24:12 2010 by <a href="http://www.doxygen.org" target="_blank">Doxygen</a>
(1.5.6)</font></em></small></div></td>
</tr>
</table>
<address style="align: right;">
</address>
</body>
</html>
distrib
>
Mandriva
>
2010.1
>
x86_64
>
media
>
contrib-release
>
by-pkgid
>
58828b263d8f56d90ac336dea07a4586
>
files
>
492
