diff options
Diffstat (limited to 'freebsdtvision/doc/html/classTHistory.html')
| -rw-r--r-- | freebsdtvision/doc/html/classTHistory.html | 512 |
1 files changed, 512 insertions, 0 deletions
diff --git a/freebsdtvision/doc/html/classTHistory.html b/freebsdtvision/doc/html/classTHistory.html new file mode 100644 index 0000000..2a6bf59 --- /dev/null +++ b/freebsdtvision/doc/html/classTHistory.html @@ -0,0 +1,512 @@ +<!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>THistory class Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.2.18 --> +<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>THistory Class Reference</h1>Implements a pick list of previous entries, actions, or choices from which the user can select a "rerun". +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="dialogs_8h-source.html">dialogs.h</a>></code> +<p> +<p>Inheritance diagram for THistory: +<p><center><img src="classTHistory.png" usemap="#THistory_map" border="0" alt=""></center> +<map name="THistory_map"> +<area href="classTView.html" alt="TView" shape="rect" coords="46,56,128,80"> +<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="classTHistory-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 Methods</h2></td></tr> +<tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classTHistory.html#a0">THistory</a> (const <a class="el" href="classTRect.html">TRect</a> &bounds, <a class="el" href="classTInputLine.html">TInputLine</a> *aLink, <a class="el" href="ttypes_8h.html#a0">ushort</a> aHistoryId)</td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classTHistory.html#a1">draw</a> ()</td></tr> +<tr><td nowrap align=right valign=top>virtual <a class="el" href="classTPalette.html">TPalette</a> & </td><td valign=bottom><a class="el" href="classTHistory.html#a2">getPalette</a> () const</td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classTHistory.html#a3">handleEvent</a> (<a class="el" href="structTEvent.html">TEvent</a> &event)</td></tr> +<tr><td nowrap align=right valign=top>virtual <a class="el" href="classTHistoryWindow.html">THistoryWindow</a> * </td><td valign=bottom><a class="el" href="classTHistory.html#a4">initHistoryWindow</a> (const <a class="el" href="classTRect.html">TRect</a> &bounds)</td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classTHistory.html#a5">recordHistory</a> (const char *s)</td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classTHistory.html#a6">shutDown</a> ()</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="classTHistory.html#d0">build</a> ()</td></tr> +<tr><td colspan=2><br><h2>Static Public Attributes</h2></td></tr> +<tr><td nowrap align=right valign=top>const char * </td><td valign=bottom><a class="el" href="classTHistory.html#p0">icon</a></td></tr> +<tr><td nowrap align=right valign=top>const char *const </td><td valign=bottom><a class="el" href="classTHistory.html#p1">name</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="classTHistory.html#b0">THistory</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="classTHistory.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="classTHistory.html#b2">read</a> (<a class="el" href="classipstream.html">ipstream</a> &is)</td></tr> +<tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr> +<tr><td nowrap align=right valign=top><a class="el" href="classTInputLine.html">TInputLine</a> * </td><td valign=bottom><a class="el" href="classTHistory.html#n0">link</a></td></tr> +<tr><td nowrap align=right valign=top><a class="el" href="ttypes_8h.html#a0">ushort</a> </td><td valign=bottom><a class="el" href="classTHistory.html#n1">historyId</a></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +A THistory object implements a pick list of previous entries, actions, or choices from which the user can select a "rerun". THistory objects are linked to a <a class="el" href="classTInputLine.html">TInputLine</a> object and to a history list. <dl compact><dt><b>See also: </b></dt><dd> +<a class="el" href="classTHistoryWindow.html">THistoryWindow</a></dl>History list information is stored in a block of memory on the heap. When the block fills up, the oldest history items are deleted as new ones are added. +<p> +Different input lines can share the same history list by using the same ID number. +<p> + +<p> +Definition at line <a class="el" href="dialogs_8h-source.html#l02404">2404</a> of file <a class="el" href="dialogs_8h-source.html">dialogs.h</a>.<hr><h2>Constructor & Destructor Documentation</h2> +<a name="a0" doxytag="THistory::THistory"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> THistory::THistory </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const <a class="el" href="classTRect.html">TRect</a> & </td> + <td class="mdname" nowrap> <em>bounds</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap><a class="el" href="classTInputLine.html">TInputLine</a> * </td> + <td class="mdname" nowrap> <em>aLink</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap><a class="el" href="ttypes_8h.html#a0">ushort</a> </td> + <td class="mdname" nowrap> <em>aHistoryId</em></td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Creates a THistory object of the given size by calling TView::TView(bounds), then setting the link and <a class="el" href="classTHistory.html#n1">historyId</a> data members with the given argument values `aLink' and `aHistoryId'. <dl compact><dt><b>See also: </b></dt><dd> +<a class="el" href="classTView.html#a0">TView::TView</a></dl>The options member is set to <a class="el" href="views_8h.html#a43">ofPostProcess</a>. The <a class="el" href="system_8h.html#a6">evBroadcast</a> bit is set in <a class="el" href="classTView.html#m3">eventMask</a> in addition to the <a class="el" href="system_8h.html#a0">evMouseDown</a>, <a class="el" href="system_8h.html#a4">evKeyDown</a>, and <a class="el" href="system_8h.html#a5">evCommand</a> bits set by TView(bounds). </td> + </tr> +</table> +<a name="b0" doxytag="THistory::THistory"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> THistory::THistory </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="ttypes_8h.html#a14">StreamableInit</a> </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap><code> [protected]</code></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="THistory::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 class="md" nowrap valign="top"> <a class="el" href="classTStreamable.html">TStreamable</a>* THistory::build </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap><code> [static]</code></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. +<p> +Reimplemented from <a class="el" href="classTView.html#d8">TView</a>. </td> + </tr> +</table> +<a name="a1" doxytag="THistory::draw"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual void THistory::draw </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap><code> [virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Draws the THistory icon in the default palette. +<p> +Reimplemented from <a class="el" href="classTView.html#a19">TView</a>. </td> + </tr> +</table> +<a name="a2" doxytag="THistory::getPalette"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual <a class="el" href="classTPalette.html">TPalette</a>& THistory::getPalette </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap><code> [virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Returns a reference to the default palette. +<p> +Reimplemented from <a class="el" href="classTView.html#a46">TView</a>. </td> + </tr> +</table> +<a name="a3" doxytag="THistory::handleEvent"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual void THistory::handleEvent </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="structTEvent.html">TEvent</a> & </td> + <td class="mdname1" valign="top" nowrap> <em>event</em> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap><code> [virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Calls TView::handleEvent(event), then handles relevant mouse and key events to select the linked input line and create a history window. <dl compact><dt><b>See also: </b></dt><dd> +<a class="el" href="classTView.html#a41">TView::handleEvent</a> </dl> +<p> +Reimplemented from <a class="el" href="classTView.html#a41">TView</a>. </td> + </tr> +</table> +<a name="a4" doxytag="THistory::initHistoryWindow"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual <a class="el" href="classTHistoryWindow.html">THistoryWindow</a>* THistory::initHistoryWindow </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const <a class="el" href="classTRect.html">TRect</a> & </td> + <td class="mdname1" valign="top" nowrap> <em>bounds</em> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap><code> [virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Creates a <a class="el" href="classTHistoryWindow.html">THistoryWindow</a> object and returns a pointer to it. The new object has the given bounds and the same <a class="el" href="classTHistory.html#n1">historyId</a> as the calling THistory object. <dl compact><dt><b>See also: </b></dt><dd> +<a class="el" href="classTHistoryWindow.html">THistoryWindow</a></dl>The new object gets its <a class="el" href="classTView.html#m9">helpCtx</a> from the calling object's linked <a class="el" href="classTInputLine.html">TInputLine</a>. <dl compact><dt><b>See also: </b></dt><dd> +<a class="el" href="classTHistory.html#n0">THistory::link</a> </dl> </td> + </tr> +</table> +<a name="b2" doxytag="THistory::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 class="md" nowrap valign="top"> virtual void* THistory::read </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="classipstream.html">ipstream</a> & </td> + <td class="mdname1" valign="top" nowrap> <em>is</em> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap><code> [protected, virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Reads from the input stream `is'. +<p> +Reimplemented from <a class="el" href="classTView.html#b2">TView</a>. </td> + </tr> +</table> +<a name="a5" doxytag="THistory::recordHistory"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual void THistory::recordHistory </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const char * </td> + <td class="mdname1" valign="top" nowrap> <em>s</em> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap><code> [virtual]</code></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="THistory::shutDown"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual void THistory::shutDown </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap><code> [virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Used internally by <a class="el" href="classTObject.html#d0">TObject::destroy()</a> to ensure correct destruction of derived and related objects. +<p> +<a class="el" href="classTHistory.html#a6">shutDown()</a> is overridden in many classes to ensure the proper setting of related data members when <a class="el" href="classTObject.html#d0">destroy()</a> is called. +<p> +Reimplemented from <a class="el" href="classTView.html#a67">TView</a>. </td> + </tr> +</table> +<a name="b1" doxytag="THistory::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 class="md" nowrap valign="top"> virtual void THistory::write </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="classopstream.html">opstream</a> & </td> + <td class="mdname1" valign="top" nowrap> <em>os</em> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap><code> [protected, virtual]</code></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="classTView.html#b1">TView</a>. </td> + </tr> +</table> +<hr><h2>Member Data Documentation</h2> +<a name="n1" doxytag="THistory::historyId"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> <a class="el" href="ttypes_8h.html#a0">ushort</a> THistory::historyId<code> [protected]</code> + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Each history list has a unique ID number, assigned by the programmer. +<p> +Different history objects in different windows may share a history list by using the same history ID. +<p> +Definition at line <a class="el" href="dialogs_8h-source.html#l02471">2471</a> of file <a class="el" href="dialogs_8h-source.html">dialogs.h</a>. </td> + </tr> +</table> +<a name="p0" doxytag="THistory::icon"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> const char* THistory::icon<code> [static]</code> + </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="dialogs_8h-source.html#l02459">2459</a> of file <a class="el" href="dialogs_8h-source.html">dialogs.h</a>. </td> + </tr> +</table> +<a name="n0" doxytag="THistory::link"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> <a class="el" href="classTInputLine.html">TInputLine</a>* THistory::link<code> [protected]</code> + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +A pointer to the linked <a class="el" href="classTInputLine.html">TInputLine</a> object. +<p> +Definition at line <a class="el" href="dialogs_8h-source.html#l02464">2464</a> of file <a class="el" href="dialogs_8h-source.html">dialogs.h</a>. </td> + </tr> +</table> +<a name="p1" doxytag="THistory::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 class="md" nowrap valign="top"> const char* const THistory::name<code> [static]</code> + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Undocumented. +<p> +Reimplemented from <a class="el" href="classTView.html#p4">TView</a>. +<p> +Definition at line <a class="el" href="dialogs_8h-source.html#l02495">2495</a> of file <a class="el" href="dialogs_8h-source.html">dialogs.h</a>. </td> + </tr> +</table> +<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="dialogs_8h-source.html">dialogs.h</a></ul> +<hr><address style="align: right;"><small>Generated on Wed Apr 2 22:13:14 2003 for TVision by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.png" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.18 </small></address> +</body> +</html> |