diff options
Diffstat (limited to 'sigalatvision/doc/html/classTHelpTopic.html')
| -rw-r--r-- | sigalatvision/doc/html/classTHelpTopic.html | 651 |
1 files changed, 651 insertions, 0 deletions
diff --git a/sigalatvision/doc/html/classTHelpTopic.html b/sigalatvision/doc/html/classTHelpTopic.html new file mode 100644 index 0000000..58ea152 --- /dev/null +++ b/sigalatvision/doc/html/classTHelpTopic.html @@ -0,0 +1,651 @@ +<!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>THelpTopic 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>THelpTopic Class Reference</h1>Part of the help system. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="helpbase_8h-source.html">helpbase.h</a>></code> +<p> +<p>Inheritance diagram for THelpTopic:: +<p><center><img src="classTHelpTopic.gif" usemap="#THelpTopic_map" border="0"></center> +<map name="THelpTopic_map"> +<area href="classTObject.html" alt="TObject" shape="rect" coords="0,0,82,24"> +<area href="classTStreamable.html" alt="TStreamable" shape="rect" coords="92,0,174,24"> +</map> +<a href="classTHelpTopic-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="classTHelpTopic.html#a0">THelpTopic</a> ()</td></tr> +<tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classTHelpTopic.html#a1">THelpTopic</a> (<a class="el" href="ttypes_8h.html#a14">StreamableInit</a>)</td></tr> +<tr><td nowrap align=right valign=top>virtual </td><td valign=bottom><a class="el" href="classTHelpTopic.html#a2">~THelpTopic</a> ()</td></tr> +<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classTHelpTopic.html#a3">addCrossRef</a> (<a class="el" href="classTCrossRef.html">TCrossRef</a> ref)</td></tr> +<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classTHelpTopic.html#a4">addParagraph</a> (<a class="el" href="classTParagraph.html">TParagraph</a> *p)</td></tr> +<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classTHelpTopic.html#a5">getCrossRef</a> (int i, <a class="el" href="classTPoint.html">TPoint</a> &loc, <a class="el" href="ttypes_8h.html#a1">uchar</a> &length, int &ref)</td></tr> +<tr><td nowrap align=right valign=top>char* </td><td valign=bottom><a class="el" href="classTHelpTopic.html#a6">getLine</a> (int line, char *buffer, int buflen)</td></tr> +<tr><td nowrap align=right valign=top>int </td><td valign=bottom><a class="el" href="classTHelpTopic.html#a7">getNumCrossRefs</a> ()</td></tr> +<tr><td nowrap align=right valign=top>int </td><td valign=bottom><a class="el" href="classTHelpTopic.html#a8">numLines</a> ()</td></tr> +<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classTHelpTopic.html#a9">setCrossRef</a> (int i, <a class="el" href="classTCrossRef.html">TCrossRef</a> &ref)</td></tr> +<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classTHelpTopic.html#a10">setNumCrossRefs</a> (int i)</td></tr> +<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classTHelpTopic.html#a11">setWidth</a> (int aWidth)</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="classTHelpTopic.html#d0">build</a> ()</td></tr> +<tr><td colspan=2><br><h2>Public Attributes</h2></td></tr> +<tr><td nowrap align=right valign=top><a class="el" href="classTParagraph.html">TParagraph</a>* </td><td valign=bottom><a class="el" href="classTHelpTopic.html#m0">paragraphs</a></td></tr> +<tr><td nowrap align=right valign=top>int </td><td valign=bottom><a class="el" href="classTHelpTopic.html#m1">numRefs</a></td></tr> +<tr><td nowrap align=right valign=top><a class="el" href="classTCrossRef.html">TCrossRef</a>* </td><td valign=bottom><a class="el" href="classTHelpTopic.html#m2">crossRefs</a></td></tr> +<tr><td colspan=2><br><h2>Static Public Attributes</h2></td></tr> +<tr><td nowrap align=right valign=top>const char* const </td><td valign=bottom><a class="el" href="classTHelpTopic.html#p0">name</a></td></tr> +<tr><td colspan=2><br><h2>Protected Methods</h2></td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classTHelpTopic.html#b0">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="classTHelpTopic.html#b1">read</a> (<a class="el" href="classipstream.html">ipstream</a> &is)</td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +Part of the help system. +<p> + +<p> +Definition at line <a class="el" href="helpbase_8h-source.html#l00091">91</a> of file <a class="el" href="helpbase_8h-source.html">helpbase.h</a>.<hr><h2>Constructor & Destructor Documentation</h2> +<a name="a0" doxytag="THelpTopic::THelpTopic"></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> +THelpTopic::THelpTopic ( + </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> +Undocumented. </td> + </tr> +</table> +<a name="a1" doxytag="THelpTopic::THelpTopic"></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> +THelpTopic::THelpTopic ( + </b></td> + <td valign="bottom"><b> +<a class="el" href="ttypes_8h.html#a14">StreamableInit</a> )<code> [inline]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Undocumented. +<p> +Definition at line <a class="el" href="helpbase_8h-source.html#l00101">101</a> of file <a class="el" href="helpbase_8h-source.html">helpbase.h</a>. </td> + </tr> +</table> +<a name="a2" doxytag="THelpTopic::~THelpTopic"></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> +THelpTopic::~THelpTopic ( + </b></td> + <td valign="bottom"><b> +)<code> [virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Undocumented. </td> + </tr> +</table> +<hr><h2>Member Function Documentation</h2> +<a name="a3" doxytag="THelpTopic::addCrossRef"></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 THelpTopic::addCrossRef ( + </b></td> + <td valign="bottom"><b> +<a class="el" href="classTCrossRef.html">TCrossRef</a> <em>ref</em> ) + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Undocumented. </td> + </tr> +</table> +<a name="a4" doxytag="THelpTopic::addParagraph"></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 THelpTopic::addParagraph ( + </b></td> + <td valign="bottom"><b> +<a class="el" href="classTParagraph.html">TParagraph</a> * <em>p</em> ) + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Undocumented. </td> + </tr> +</table> +<a name="d0" doxytag="THelpTopic::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> * THelpTopic::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> +Undocumented. </td> + </tr> +</table> +<a name="a5" doxytag="THelpTopic::getCrossRef"></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 THelpTopic::getCrossRef ( + </b></td> + <td valign="bottom"><b> +int <em>i</em>, + </b></td> + </tr> + <tr> + <td></td> + <td><b> +<a class="el" href="classTPoint.html">TPoint</a> & <em>loc</em>, + </b></td> + </tr> + <tr> + <td></td> + <td><b> +<a class="el" href="ttypes_8h.html#a1">uchar</a> & <em>length</em>, + </b></td> + </tr> + <tr> + <td></td> + <td><b> +int & <em>ref</em> ) + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Undocumented. </td> + </tr> +</table> +<a name="a6" doxytag="THelpTopic::getLine"></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> +char * THelpTopic::getLine ( + </b></td> + <td valign="bottom"><b> +int <em>line</em>, + </b></td> + </tr> + <tr> + <td></td> + <td><b> +char * <em>buffer</em>, + </b></td> + </tr> + <tr> + <td></td> + <td><b> +int <em>buflen</em> ) + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Undocumented. </td> + </tr> +</table> +<a name="a7" doxytag="THelpTopic::getNumCrossRefs"></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> +int THelpTopic::getNumCrossRefs ( + </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> +Undocumented. </td> + </tr> +</table> +<a name="a8" doxytag="THelpTopic::numLines"></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> +int THelpTopic::numLines ( + </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> +Undocumented. </td> + </tr> +</table> +<a name="b1" doxytag="THelpTopic::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 * THelpTopic::read ( + </b></td> + <td valign="bottom"><b> +<a class="el" href="classipstream.html">ipstream</a> & <em>is</em> )<code> [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="classTHelpTopic.html#b1">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="classTHelpTopic.html#b1">read</a>() is usually implemented by calling the base class's <a class="el" href="classTHelpTopic.html#b1">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>. </td> + </tr> +</table> +<a name="a9" doxytag="THelpTopic::setCrossRef"></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 THelpTopic::setCrossRef ( + </b></td> + <td valign="bottom"><b> +int <em>i</em>, + </b></td> + </tr> + <tr> + <td></td> + <td><b> +<a class="el" href="classTCrossRef.html">TCrossRef</a> & <em>ref</em> ) + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Undocumented. </td> + </tr> +</table> +<a name="a10" doxytag="THelpTopic::setNumCrossRefs"></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 THelpTopic::setNumCrossRefs ( + </b></td> + <td valign="bottom"><b> +int <em>i</em> ) + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Undocumented. </td> + </tr> +</table> +<a name="a11" doxytag="THelpTopic::setWidth"></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 THelpTopic::setWidth ( + </b></td> + <td valign="bottom"><b> +int <em>aWidth</em> ) + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Undocumented. </td> + </tr> +</table> +<a name="b0" doxytag="THelpTopic::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 THelpTopic::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> +This pure virtual function must be overridden (or redeclared as pure virtual) in every derived class. The overriding <a class="el" href="classTHelpTopic.html#b0">write</a>() function for each streamable class must write the necessary data members to the <a class="el" href="classopstream.html">opstream</a> object `os'. <a class="el" href="classTHelpTopic.html#b0">write</a>() is usually implemented by calling the base class's <a class="el" href="classTHelpTopic.html#b0">write</a>() (if any), then inserting any additional data members for the derived class. +<p> +Reimplemented from <a class="el" href="classTStreamable.html#b1">TStreamable</a>. </td> + </tr> +</table> +<hr><h2>Member Data Documentation</h2> +<a name="m2" doxytag="THelpTopic::crossRefs"></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="classTCrossRef.html">TCrossRef</a> * THelpTopic::crossRefs + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Undocumented. +<p> +Definition at line <a class="el" href="helpbase_8h-source.html#l00153">153</a> of file <a class="el" href="helpbase_8h-source.html">helpbase.h</a>. </td> + </tr> +</table> +<a name="p0" doxytag="THelpTopic::name"></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> +const char *const THelpTopic::name<code> [static]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Undocumented. +<p> +Definition at line <a class="el" href="helpbase_8h-source.html#l00174">174</a> of file <a class="el" href="helpbase_8h-source.html">helpbase.h</a>. </td> + </tr> +</table> +<a name="m1" doxytag="THelpTopic::numRefs"></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> +int THelpTopic::numRefs + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Undocumented. +<p> +Definition at line <a class="el" href="helpbase_8h-source.html#l00149">149</a> of file <a class="el" href="helpbase_8h-source.html">helpbase.h</a>. </td> + </tr> +</table> +<a name="m0" doxytag="THelpTopic::paragraphs"></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="classTParagraph.html">TParagraph</a> * THelpTopic::paragraphs + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Undocumented. +<p> +Definition at line <a class="el" href="helpbase_8h-source.html#l00145">145</a> of file <a class="el" href="helpbase_8h-source.html">helpbase.h</a>. </td> + </tr> +</table> +<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="helpbase_8h-source.html">helpbase.h</a></ul> +<hr><address><small>Generated at Sat Sep 22 20:19:26 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> |