diff options
Diffstat (limited to 'freebsdtvision/doc/html/classTRadioButtons.html')
| -rw-r--r-- | freebsdtvision/doc/html/classTRadioButtons.html | 365 |
1 files changed, 365 insertions, 0 deletions
diff --git a/freebsdtvision/doc/html/classTRadioButtons.html b/freebsdtvision/doc/html/classTRadioButtons.html new file mode 100644 index 0000000..67ecb47 --- /dev/null +++ b/freebsdtvision/doc/html/classTRadioButtons.html @@ -0,0 +1,365 @@ +<!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>TRadioButtons 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>TRadioButtons Class Reference</h1>Cluster of radio buttons. +<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 TRadioButtons: +<p><center><img src="classTRadioButtons.png" usemap="#TRadioButtons_map" border="0" alt=""></center> +<map name="TRadioButtons_map"> +<area href="classTCluster.html" alt="TCluster" shape="rect" coords="51,112,143,136"> +<area href="classTView.html" alt="TView" shape="rect" coords="51,56,143,80"> +<area href="classTObject.html" alt="TObject" shape="rect" coords="0,0,92,24"> +<area href="classTStreamable.html" alt="TStreamable" shape="rect" coords="102,0,194,24"> +</map> +<a href="classTRadioButtons-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="classTRadioButtons.html#a0">TRadioButtons</a> (const <a class="el" href="classTRect.html">TRect</a> &bounds, <a class="el" href="classTSItem.html">TSItem</a> *aStrings)</td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classTRadioButtons.html#a1">draw</a> ()</td></tr> +<tr><td nowrap align=right valign=top>virtual <a class="el" href="ttypes_8h.html#a13">Boolean</a> </td><td valign=bottom><a class="el" href="classTRadioButtons.html#a2">mark</a> (int item)</td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classTRadioButtons.html#a3">movedTo</a> (int item)</td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classTRadioButtons.html#a4">press</a> (int item)</td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classTRadioButtons.html#a5">setData</a> (void *rec)</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="classTRadioButtons.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="classTRadioButtons.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="classTRadioButtons.html#b0">TRadioButtons</a> (<a class="el" href="ttypes_8h.html#a14">StreamableInit</a>)</td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +This view implements a cluster of radio buttons. +<p> +TRadioButtons objects are clusters controls with the special property that only one control button in the cluster can be selected at any moment. Selecting an unselected button will automatically deselect (restore) the previously selected button. +<p> +The user can select a button with mouse clicks, cursor movements, and Alt-letter shortcuts. Each radio button can be highlighted and selected (with the Spacebar). An "." appears in the radio button when it is selected. +<p> +Other parts of your application typically examine the state of the radio buttons to determine which option has been chosen by the user. +<p> +Radio button clusters often have associated <a class="el" href="classTLabel.html">TLabel</a> objects to give the user an overview of the clustered options. +<p> +TRadioButtons interprets value as the number of the "pressed" button, with the first button in the cluster being number 0. <dl compact><dt><b>See also: </b></dt><dd> +<a class="el" href="classTCheckBoxes.html">TCheckBoxes</a> </dl> +<p> + +<p> +Definition at line <a class="el" href="dialogs_8h-source.html#l01181">1181</a> of file <a class="el" href="dialogs_8h-source.html">dialogs.h</a>.<hr><h2>Constructor & Destructor Documentation</h2> +<a name="a0" doxytag="TRadioButtons::TRadioButtons"></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"> TRadioButtons::TRadioButtons </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="classTSItem.html">TSItem</a> * </td> + <td class="mdname" nowrap> <em>aStrings</em></td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"><code> [inline]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Constructor. +<p> +`bounds' is the bounding rectangle of the view. `aStrings' points to a linked list of <a class="el" href="classTSItem.html">TSItem</a> objects, one for each radio button, and is assigned to strings data member. +<p> +Every <a class="el" href="classTSItem.html">TSItem</a> object stores the caption of the related radio button. TRadioButtons handles a maximum of 2^32 radio buttons. +<p> +The sel and value data members are set to zero; options is set to (<a class="el" href="views_8h.html#a38">ofSelectable</a> | <a class="el" href="views_8h.html#a40">ofFirstClick</a> | <a class="el" href="views_8h.html#a42">ofPreProcess</a> | <a class="el" href="views_8h.html#a43">ofPostProcess</a>). +<p> +Definition at line <a class="el" href="dialogs_8h-source.html#l01292">1292</a> of file <a class="el" href="dialogs_8h-source.html">dialogs.h</a>. </td> + </tr> +</table> +<a name="b0" doxytag="TRadioButtons::TRadioButtons"></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"> TRadioButtons::TRadioButtons </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> +Constructor. +<p> +Used to recover the view from a stream. 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="TRadioButtons::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>* TRadioButtons::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> +Creates a new TRadioButtons view. +<p> +Called to create an object in certain stream-reading situations. +<p> +Reimplemented from <a class="el" href="classTCluster.html#d0">TCluster</a>. </td> + </tr> +</table> +<a name="a1" doxytag="TRadioButtons::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 TRadioButtons::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 TRadioButtons object by calling the inherited <a class="el" href="classTCluster.html#a3">TCluster::drawBox()</a> member function. +<p> +The default radio button is " ( ) " when unselected and " (.) " when selected. Note that if the boundaries of the view are sufficiently wide, radio buttons can be displayed in multiple columns. +<p> +Reimplemented from <a class="el" href="classTView.html#a19">TView</a>. </td> + </tr> +</table> +<a name="a2" doxytag="TRadioButtons::mark"></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#a13">Boolean</a> TRadioButtons::mark </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">int </td> + <td class="mdname1" valign="top" nowrap> <em>item</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> +Returns True if the specified radio button is pressed; that is, if `item' is equal to value data member. +<p> +Integer `item' specifies which radio button to check. 0 is the first radio button, 1 is the second radio button, etc. +<p> +Reimplemented from <a class="el" href="classTCluster.html#a9">TCluster</a>. </td> + </tr> +</table> +<a name="a3" doxytag="TRadioButtons::movedTo"></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 TRadioButtons::movedTo </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">int </td> + <td class="mdname1" valign="top" nowrap> <em>item</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> +Called whenever the user moves the selection to another radio button. +<p> +Sets value data member to `item'. This will press `item' radio button and release the previously pressed radio button. <dl compact><dt><b>See also: </b></dt><dd> +<a class="el" href="classTCluster.html#a12">TCluster::movedTo</a> , <a class="el" href="classTCluster.html#n0">TCluster::value</a> </dl> +<p> +Reimplemented from <a class="el" href="classTCluster.html#a12">TCluster</a>. </td> + </tr> +</table> +<a name="a4" doxytag="TRadioButtons::press"></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 TRadioButtons::press </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">int </td> + <td class="mdname1" valign="top" nowrap> <em>item</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> +Called to press another radio button. +<p> +Integer `item' specifies which radio button to press. The previous radio button is released. 0 is the first radio button, 1 the second radio button, etc. <dl compact><dt><b>See also: </b></dt><dd> +<a class="el" href="classTCluster.html#a11">TCluster::press</a> </dl> +<p> +Reimplemented from <a class="el" href="classTCluster.html#a11">TCluster</a>. </td> + </tr> +</table> +<a name="a5" doxytag="TRadioButtons::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 TRadioButtons::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> +Writes the data record of this view. +<p> +This method calls <a class="el" href="classTCluster.html#a13">TCluster::setData()</a> and after sets sel data member to value data member. This will move the selection on the currently pressed radio button. +<p> +Reimplemented from <a class="el" href="classTCluster.html#a13">TCluster</a>. </td> + </tr> +</table> +<hr><h2>Member Data Documentation</h2> +<a name="p0" doxytag="TRadioButtons::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 TRadioButtons::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="classTCluster.html#p0">TCluster</a>. +<p> +Definition at line <a class="el" href="dialogs_8h-source.html#l01261">1261</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:16 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> |