diff options
Diffstat (limited to 'freebsdtvision/doc/html/classTListBox.html')
| -rw-r--r-- | freebsdtvision/doc/html/classTListBox.html | 538 |
1 files changed, 538 insertions, 0 deletions
diff --git a/freebsdtvision/doc/html/classTListBox.html b/freebsdtvision/doc/html/classTListBox.html new file mode 100644 index 0000000..e9fd940 --- /dev/null +++ b/freebsdtvision/doc/html/classTListBox.html @@ -0,0 +1,538 @@ +<!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>TListBox 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>TListBox Class Reference</h1>Displays a list of items, in one or more columns, with an optional vertical scroll bar. +<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 TListBox: +<p><center><img src="classTListBox.png" usemap="#TListBox_map" border="0" alt=""></center> +<map name="TListBox_map"> +<area href="classTListViewer.html" alt="TListViewer" shape="rect" coords="53,112,149,136"> +<area href="classTView.html" alt="TView" shape="rect" coords="53,56,149,80"> +<area href="classTObject.html" alt="TObject" shape="rect" coords="0,0,96,24"> +<area href="classTStreamable.html" alt="TStreamable" shape="rect" coords="106,0,202,24"> +<area href="classTDirListBox.html" alt="TDirListBox" shape="rect" coords="0,224,96,248"> +<area href="classTSortedListBox.html" alt="TSortedListBox" shape="rect" coords="106,224,202,248"> +<area href="classTFileList.html" alt="TFileList" shape="rect" coords="106,280,202,304"> +</map> +<a href="classTListBox-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="classTListBox.html#a0">TListBox</a> (const <a class="el" href="classTRect.html">TRect</a> &bounds, <a class="el" href="ttypes_8h.html#a0">ushort</a> aNumCols, <a class="el" href="classTScrollBar.html">TScrollBar</a> *aScrollBar)</td></tr> +<tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classTListBox.html#a1">~TListBox</a> ()</td></tr> +<tr><td nowrap align=right valign=top>virtual <a class="el" href="ttypes_8h.html#a0">ushort</a> </td><td valign=bottom><a class="el" href="classTListBox.html#a2">dataSize</a> ()</td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classTListBox.html#a3">getData</a> (void *rec)</td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classTListBox.html#a4">getText</a> (char *dest, short item, short maxLen)</td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classTListBox.html#a5">newList</a> (<a class="el" href="classTCollection.html">TCollection</a> *aList)</td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classTListBox.html#a6">setData</a> (void *rec)</td></tr> +<tr><td nowrap align=right valign=top><a class="el" href="classTCollection.html">TCollection</a> * </td><td valign=bottom><a class="el" href="classTListBox.html#a7">list</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="classTListBox.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 *const </td><td valign=bottom><a class="el" href="classTListBox.html#p0">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="classTListBox.html#b0">TListBox</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="classTListBox.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="classTListBox.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="classTCollection.html">TCollection</a> * </td><td valign=bottom><a class="el" href="classTListBox.html#n0">items</a></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +TListBox is derived from <a class="el" href="classTListViewer.html">TListViewer</a> to help you set up the most commonly used list boxes, namely those displaying collections of strings, such as file names. +<p> +TListBox objects represent displayed lists of such items in one or more columns with an optional vertical scroll bar. +<p> + +<p> +Definition at line <a class="el" href="dialogs_8h-source.html#l01643">1643</a> of file <a class="el" href="dialogs_8h-source.html">dialogs.h</a>.<hr><h2>Constructor & Destructor Documentation</h2> +<a name="a0" doxytag="TListBox::TListBox"></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"> TListBox::TListBox </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="ttypes_8h.html#a0">ushort</a> </td> + <td class="mdname" nowrap> <em>aNumCols</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap><a class="el" href="classTScrollBar.html">TScrollBar</a> * </td> + <td class="mdname" nowrap> <em>aScrollBar</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 list box control with the given size, number of columns, and a vertical scroll bar referenced by the `aScrollBar' pointer. +<p> +This constructor calls <a class="el" href="classTListViewer.html#a0">TListViewer::TListViewer</a>(bounds, aNumCols, 0, aScrollBar), thereby supressing the horizontal scroll bar. <dl compact><dt><b>See also: </b></dt><dd> +<a class="el" href="classTListViewer.html#a0">TListViewer::TListViewer</a></dl>The items data member is initially empty collection, and the inherited range data member is set to zero. +<p> +Your application must provide a suitable <a class="el" href="classTCollection.html">TCollection</a> holding the strings (or other objects) to be listed. The items data member must be set to point to this collection using <a class="el" href="classTListBox.html#a5">newList()</a>. </td> + </tr> +</table> +<a name="a1" doxytag="TListBox::~TListBox"></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"> TListBox::~TListBox </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap></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="TListBox::TListBox"></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"> TListBox::TListBox </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="TListBox::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>* TListBox::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="classTListViewer.html#d0">TListViewer</a>. +<p> +Reimplemented in <a class="el" href="classTSortedListBox.html#d0">TSortedListBox</a>, <a class="el" href="classTFileList.html#d0">TFileList</a>, and <a class="el" href="classTDirListBox.html#d0">TDirListBox</a>. </td> + </tr> +</table> +<a name="a2" doxytag="TListBox::dataSize"></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="ttypes_8h.html#a0">ushort</a> TListBox::dataSize </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 the size of the data read and written to the records passed to <a class="el" href="classTListBox.html#a3">getData()</a> and <a class="el" href="classTListBox.html#a6">setData()</a>. These three member functions are useful for initializing groups. +<p> +By default, <a class="el" href="classTListBox.html#a2">dataSize()</a> returns the size of <a class="el" href="classTCollection.html">TCollection</a> plus the size of ushort (for items and the selected item). You may need to override this member function for your own applications. <dl compact><dt><b>See also: </b></dt><dd> +<a class="el" href="classTListBox.html#n0">TListBox::items</a> , <a class="el" href="structTListBoxRec.html">TListBoxRec</a> </dl> +<p> +Reimplemented from <a class="el" href="classTView.html#a28">TView</a>. +<p> +Reimplemented in <a class="el" href="classTFileList.html#a8">TFileList</a>. </td> + </tr> +</table> +<a name="a3" doxytag="TListBox::getData"></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 TListBox::getData </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">void * </td> + <td class="mdname1" valign="top" nowrap> <em>rec</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> +Writes TListBox object data to the target record. By default, <a class="el" href="classTListBox.html#a3">getData()</a> writes the current items and focused data members to `rec'. You may need to override this member function for your own applications. <dl compact><dt><b>See also: </b></dt><dd> +<a class="el" href="classTListBox.html#a2">TListBox::dataSize</a> , <a class="el" href="classTListBox.html#a6">TListBox::setData</a> </dl> +<p> +Reimplemented from <a class="el" href="classTView.html#a29">TView</a>. +<p> +Reimplemented in <a class="el" href="classTFileList.html#a9">TFileList</a>. </td> + </tr> +</table> +<a name="a4" doxytag="TListBox::getText"></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 TListBox::getText </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">char * </td> + <td class="mdname" nowrap> <em>dest</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap>short </td> + <td class="mdname" nowrap> <em>item</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap>short </td> + <td class="mdname" nowrap> <em>maxLen</em></td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"><code> [virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Sets a string in `dest' from the calling TListBox object. By default, the returned string is obtained from the item'th item in the <a class="el" href="classTCollection.html">TCollection</a> using (char *) ((<a class="el" href="classTListBox.html#a7">list()</a>)->at(item)). <dl compact><dt><b>See also: </b></dt><dd> +<a class="el" href="classTNSCollection.html#a3">TCollection::at</a> , <a class="el" href="classTListBox.html#a7">TListBox::list</a></dl>If <a class="el" href="classTListBox.html#a7">list()</a> returns a collection containing non-string objects, you will need to override this member function. If <a class="el" href="classTListBox.html#a7">list()</a> returns 0, <a class="el" href="classTListBox.html#a4">getText()</a> sets `dest' to " ". +<p> +Reimplemented from <a class="el" href="classTListViewer.html#a5">TListViewer</a>. +<p> +Reimplemented in <a class="el" href="classTFileList.html#a4">TFileList</a>, and <a class="el" href="classTDirListBox.html#a2">TDirListBox</a>. </td> + </tr> +</table> +<a name="a7" doxytag="TListBox::list"></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="classTCollection.html">TCollection</a> * TListBox::list </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> [inline]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Returns the private items pointer. +<p> +Reimplemented in <a class="el" href="classTSortedListBox.html#a4">TSortedListBox</a>, <a class="el" href="classTFileList.html#a11">TFileList</a>, and <a class="el" href="classTDirListBox.html#a7">TDirListBox</a>. +<p> +Definition at line <a class="el" href="dialogs_8h-source.html#l01775">1775</a> of file <a class="el" href="dialogs_8h-source.html">dialogs.h</a>. +<p> +References <a class="el" href="dialogs_8h-source.html#l01726">items</a>. +<p> +Referenced by <a class="el" href="stddlg_8h-source.html#l01275">TDirListBox::list()</a>, and <a class="el" href="stddlg_8h-source.html#l00460">TSortedListBox::list()</a>. </td> + </tr> +</table> +<a name="a5" doxytag="TListBox::newList"></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 TListBox::newList </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="classTCollection.html">TCollection</a> * </td> + <td class="mdname1" valign="top" nowrap> <em>aList</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 new list by deleting the current one and replacing it with the given `aList'. </td> + </tr> +</table> +<a name="b2" doxytag="TListBox::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* TListBox::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="classTListViewer.html#b2">TListViewer</a>. +<p> +Reimplemented in <a class="el" href="classTSortedListBox.html#a3">TSortedListBox</a>. </td> + </tr> +</table> +<a name="a6" doxytag="TListBox::setData"></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 TListBox::setData </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">void * </td> + <td class="mdname1" valign="top" nowrap> <em>rec</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> +Replaces the current list with items and focused values read from the given `rec' array. <a class="el" href="classTListBox.html#a6">setData()</a> calls <a class="el" href="classTListBox.html#a5">newList()</a> so that the new list is displayed with the correct focused item. As with <a class="el" href="classTListBox.html#a3">getData()</a> and <a class="el" href="classTListBox.html#a2">dataSize()</a>, you may need to override this member function for your own applications. +<p> +Reimplemented from <a class="el" href="classTView.html#a30">TView</a>. +<p> +Reimplemented in <a class="el" href="classTFileList.html#a10">TFileList</a>. </td> + </tr> +</table> +<a name="b1" doxytag="TListBox::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 TListBox::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="classTListViewer.html#b1">TListViewer</a>. </td> + </tr> +</table> +<hr><h2>Member Data Documentation</h2> +<a name="n0" doxytag="TListBox::items"></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="classTCollection.html">TCollection</a>* TListBox::items<code> [protected]</code> + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Points at the collection of items to scroll through. +<p> +Typically, this might be a collection of strings representing the item texts. User can access this private member only by calling the function <a class="el" href="classTListBox.html#a7">list()</a>. +<p> +Definition at line <a class="el" href="dialogs_8h-source.html#l01726">1726</a> of file <a class="el" href="dialogs_8h-source.html">dialogs.h</a>. +<p> +Referenced by <a class="el" href="dialogs_8h-source.html#l01775">list()</a>. </td> + </tr> +</table> +<a name="p0" doxytag="TListBox::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 TListBox::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="classTListViewer.html#p1">TListViewer</a>. +<p> +Reimplemented in <a class="el" href="classTSortedListBox.html#p0">TSortedListBox</a>, <a class="el" href="classTFileList.html#p0">TFileList</a>, and <a class="el" href="classTDirListBox.html#p5">TDirListBox</a>. +<p> +Definition at line <a class="el" href="dialogs_8h-source.html#l01746">1746</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:15 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> |