diff options
Diffstat (limited to 'sigalatvision/doc/html/classTStrListMaker.html')
| -rw-r--r-- | sigalatvision/doc/html/classTStrListMaker.html | 274 |
1 files changed, 274 insertions, 0 deletions
diff --git a/sigalatvision/doc/html/classTStrListMaker.html b/sigalatvision/doc/html/classTStrListMaker.html new file mode 100644 index 0000000..f8472e0 --- /dev/null +++ b/sigalatvision/doc/html/classTStrListMaker.html @@ -0,0 +1,274 @@ +<!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>TStrListMaker class Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.8.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> <a class="qindex" href="globals.html">File Members</a> </center> +<hr><h1>TStrListMaker Class Reference</h1>Used to create string lists for use with <a class="el" href="classTStringList.html">TStringList</a>. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="resource_8h-source.html">resource.h</a>></code> +<p> +<p>Inheritance diagram for TStrListMaker:: +<p><center><img src="classTStrListMaker.gif" usemap="#TStrListMaker_map" border="0"></center> +<map name="TStrListMaker_map"> +<area href="classTObject.html" alt="TObject" shape="rect" coords="0,0,90,24"> +<area href="classTStreamable.html" alt="TStreamable" shape="rect" coords="100,0,190,24"> +</map> +<a href="classTStrListMaker-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> +<tr><td colspan=2><br><h2>Public Methods</h2></td></tr> +<tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classTStrListMaker.html#a0">TStrListMaker</a> (<a class="el" href="ttypes_8h.html#a0">ushort</a> aStrSize, <a class="el" href="ttypes_8h.html#a0">ushort</a> aIndexSize)</td></tr> +<tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classTStrListMaker.html#a1">~TStrListMaker</a> ()</td></tr> +<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classTStrListMaker.html#a2">put</a> (<a class="el" href="ttypes_8h.html#a0">ushort</a> key, char *str)</td></tr> +<tr><td colspan=2><br><h2>Static Public Methods</h2></td></tr> +<tr><td nowrap align=right valign=top><a class="el" href="classTStreamable.html">TStreamable</a>* </td><td valign=bottom><a class="el" href="classTStrListMaker.html#d0">build</a> ()</td></tr> +<tr><td colspan=2><br><h2>Protected Methods</h2></td></tr> +<tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classTStrListMaker.html#b0">TStrListMaker</a> (<a class="el" href="ttypes_8h.html#a14">StreamableInit</a>)</td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classTStrListMaker.html#b1">write</a> (<a class="el" href="classopstream.html">opstream</a> &os)</td></tr> +<tr><td nowrap align=right valign=top>virtual void* </td><td valign=bottom><a class="el" href="classTStrListMaker.html#b2">read</a> (<a class="el" href="classipstream.html">ipstream</a> &)</td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +TStrListMaker is a simple object type used to create string lists for use with <a class="el" href="classTStringList.html">TStringList</a>. +<p> + +<p> +Definition at line <a class="el" href="resource_8h-source.html#l00465">465</a> of file <a class="el" href="resource_8h-source.html">resource.h</a>.<hr><h2>Constructor & Destructor Documentation</h2> +<a name="a0" doxytag="TStrListMaker::TStrListMaker"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +TStrListMaker::TStrListMaker ( + </b></td> + <td valign="bottom"><b> +<a class="el" href="ttypes_8h.html#a0">ushort</a> <em>aStrSize</em>, + </b></td> + </tr> + <tr> + <td></td> + <td><b> +<a class="el" href="ttypes_8h.html#a0">ushort</a> <em>aIndexSize</em> ) + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Creates an in-memory string list of size `aStrSize' with an index of `aIndexSize' elements. A string buffer and an index buffer of the specified size are allocated on the heap. +<p> +`aStrSize' must be large enough to hold all strings to be added to the string list; each string occupies its length plus a final 0. +<p> +As strings are added to the string list (using <a class="el" href="classTStrListMaker.html#a2">put</a>()), a string index is built. +<p> +Strings with contiguous keys (such `as' and `sError' in the example above) are recorded in one index record, up to 16 at a time. `aIndexSize' must be large enough to allow for all index records generated as strings are added. Each index entry occupies 6 bytes. </td> + </tr> +</table> +<a name="a1" doxytag="TStrListMaker::~TStrListMaker"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +TStrListMaker::~TStrListMaker ( + </b></td> + <td valign="bottom"><b> +) + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Frees the memory allocated to the string list maker. </td> + </tr> +</table> +<a name="b0" doxytag="TStrListMaker::TStrListMaker"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +TStrListMaker::TStrListMaker ( + </b></td> + <td valign="bottom"><b> +<a class="el" href="ttypes_8h.html#a14">StreamableInit</a> )<code> [protected]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Each streamable class needs a "builder" to allocate the correct memory for its objects together with the initialized virtual table pointers. This is achieved by calling this constructor with an argument of type <a class="el" href="ttypes_8h.html#a14">StreamableInit</a>. </td> + </tr> +</table> +<hr><h2>Member Function Documentation</h2> +<a name="d0" doxytag="TStrListMaker::build"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +<a class="el" href="classTStreamable.html">TStreamable</a> * TStrListMaker::build ( + </b></td> + <td valign="bottom"><b> +)<code> [static]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Called to create an object in certain stream-reading situations. </td> + </tr> +</table> +<a name="a2" doxytag="TStrListMaker::put"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +void TStrListMaker::put ( + </b></td> + <td valign="bottom"><b> +<a class="el" href="ttypes_8h.html#a0">ushort</a> <em>key</em>, + </b></td> + </tr> + <tr> + <td></td> + <td><b> +char * <em>str</em> ) + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Adds the given string `str' to the calling string list (with the given numerical key). </td> + </tr> +</table> +<a name="b2" doxytag="TStrListMaker::read"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +void * TStrListMaker::read ( + </b></td> + <td valign="bottom"><b> +<a class="el" href="classipstream.html">ipstream</a> & <em>is</em> )<code> [inline, protected, virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +This pure virtual function must be overridden (or redeclared as pure virtual) in every derived class. The overriding <a class="el" href="classTStrListMaker.html#b2">read</a>() function for each streamable class must read the necessary data members from the <a class="el" href="classipstream.html">ipstream</a> object `is'. <a class="el" href="classTStrListMaker.html#b2">read</a>() is usually implemented by calling the base class's <a class="el" href="classTStrListMaker.html#b2">read</a>() (if any), then extracting any additional data members for the derived class. +<p> +Reimplemented from <a class="el" href="classTStreamable.html#b0">TStreamable</a>. +<p> +Definition at line <a class="el" href="resource_8h-source.html#l00517">517</a> of file <a class="el" href="resource_8h-source.html">resource.h</a>. </td> + </tr> +</table> +<a name="b1" doxytag="TStrListMaker::write"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +void TStrListMaker::write ( + </b></td> + <td valign="bottom"><b> +<a class="el" href="classopstream.html">opstream</a> & <em>os</em> )<code> [protected, virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Writes to the output stream `os'. +<p> +Reimplemented from <a class="el" href="classTStreamable.html#b1">TStreamable</a>. </td> + </tr> +</table> +<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="resource_8h-source.html">resource.h</a></ul> +<hr><address><small>Generated at Sat Sep 22 20:19:37 2001 for TVision by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.8.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> |