diff options
Diffstat (limited to 'freebsdtvision/doc/html/classTCluster.html')
| -rw-r--r-- | freebsdtvision/doc/html/classTCluster.html | 955 |
1 files changed, 955 insertions, 0 deletions
diff --git a/freebsdtvision/doc/html/classTCluster.html b/freebsdtvision/doc/html/classTCluster.html new file mode 100644 index 0000000..5c2d270 --- /dev/null +++ b/freebsdtvision/doc/html/classTCluster.html @@ -0,0 +1,955 @@ +<!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>TCluster 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>TCluster Class Reference</h1>The base class of <a class="el" href="classTCheckBoxes.html">TCheckBoxes</a> and <a class="el" href="classTRadioButtons.html">TRadioButtons</a>. +<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 TCluster: +<p><center><img src="classTCluster.png" usemap="#TCluster_map" border="0" alt=""></center> +<map name="TCluster_map"> +<area href="classTView.html" alt="TView" shape="rect" coords="189,56,305,80"> +<area href="classTObject.html" alt="TObject" shape="rect" coords="126,0,242,24"> +<area href="classTStreamable.html" alt="TStreamable" shape="rect" coords="252,0,368,24"> +<area href="classTCheckBoxes.html" alt="TCheckBoxes" shape="rect" coords="0,168,116,192"> +<area href="classTMonoSelector.html" alt="TMonoSelector" shape="rect" coords="126,168,242,192"> +<area href="classTMultiCheckBoxes.html" alt="TMultiCheckBoxes" shape="rect" coords="252,168,368,192"> +<area href="classTRadioButtons.html" alt="TRadioButtons" shape="rect" coords="378,168,494,192"> +</map> +<a href="classTCluster-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="classTCluster.html#a0">TCluster</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> </td><td valign=bottom><a class="el" href="classTCluster.html#a1">~TCluster</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="classTCluster.html#a2">dataSize</a> ()</td></tr> +<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classTCluster.html#a3">drawBox</a> (const char *icon, char marker)</td></tr> +<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classTCluster.html#a4">drawMultiBox</a> (const char *icon, const char *marker)</td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classTCluster.html#a5">getData</a> (void *rec)</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="classTCluster.html#a6">getHelpCtx</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="classTCluster.html#a7">getPalette</a> () const</td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classTCluster.html#a8">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="ttypes_8h.html#a13">Boolean</a> </td><td valign=bottom><a class="el" href="classTCluster.html#a9">mark</a> (int item)</td></tr> +<tr><td nowrap align=right valign=top>virtual <a class="el" href="ttypes_8h.html#a1">uchar</a> </td><td valign=bottom><a class="el" href="classTCluster.html#a10">multiMark</a> (int item)</td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classTCluster.html#a11">press</a> (int item)</td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classTCluster.html#a12">movedTo</a> (int item)</td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classTCluster.html#a13">setData</a> (void *rec)</td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classTCluster.html#a14">setState</a> (<a class="el" href="ttypes_8h.html#a0">ushort</a> aState, <a class="el" href="ttypes_8h.html#a13">Boolean</a> enable)</td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classTCluster.html#a15">setButtonState</a> (unsigned long aMask, <a class="el" href="ttypes_8h.html#a13">Boolean</a> enable)</td></tr> +<tr><td nowrap align=right valign=top><a class="el" href="ttypes_8h.html#a13">Boolean</a> </td><td valign=bottom><a class="el" href="classTCluster.html#a16">buttonState</a> (int item)</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="classTCluster.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="classTCluster.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="classTCluster.html#b0">TCluster</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="classTCluster.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="classTCluster.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>unsigned long </td><td valign=bottom><a class="el" href="classTCluster.html#n0">value</a></td></tr> +<tr><td nowrap align=right valign=top>unsigned long </td><td valign=bottom><a class="el" href="classTCluster.html#n1">enableMask</a></td></tr> +<tr><td nowrap align=right valign=top>int </td><td valign=bottom><a class="el" href="classTCluster.html#n2">sel</a></td></tr> +<tr><td nowrap align=right valign=top><a class="el" href="classTStringCollection.html">TStringCollection</a> * </td><td valign=bottom><a class="el" href="classTCluster.html#n3">strings</a></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +The base class used both by <a class="el" href="classTCheckBoxes.html">TCheckBoxes</a> and <a class="el" href="classTRadioButtons.html">TRadioButtons</a>. +<p> +A cluster is a group of controls that all respond in the same way. TCluster is an abstract class from which the useful group controls such as <a class="el" href="classTRadioButtons.html">TRadioButtons</a>, <a class="el" href="classTCheckBoxes.html">TCheckBoxes</a>, and <a class="el" href="classTMonoSelector.html">TMonoSelector</a> are derived. +<p> +Cluster controls are often associated with <a class="el" href="classTLabel.html">TLabel</a> objects, letting you select the control by selecting on the adjacent explanatory label. Clusters are used to toggle bit values in the value data member, which is of type unsigned long. +<p> +The two standard descendants of TCluster use different algorithms when changing value: <a class="el" href="classTCheckBoxes.html">TCheckBoxes</a> simply toggles a bit, while <a class="el" href="classTRadioButtons.html">TRadioButtons</a> toggles the enabled one and clears the previously selected bit. Both inherit most of their behavior from TCluster. +<p> + +<p> +Definition at line <a class="el" href="dialogs_8h-source.html#l00856">856</a> of file <a class="el" href="dialogs_8h-source.html">dialogs.h</a>.<hr><h2>Constructor & Destructor Documentation</h2> +<a name="a0" doxytag="TCluster::TCluster"></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"> TCluster::TCluster </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"></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Constructor. +<p> +Calls TView::TView(bounds) to create a TCluster object with the given `bounds', where `bounds' is the desired bounding rectangle of the view. The strings data member is set to `aStrings', a pointer to a linked list of <a class="el" href="classTSItem.html">TSItem</a> objects, one for each cluster item. Every <a class="el" href="classTSItem.html">TSItem</a> object stores the caption of the related item. <dl compact><dt><b>See also: </b></dt><dd> +<a class="el" href="classTView.html#a0">TView::TView</a></dl>TCluster handles a maximum of 32 items. The constructor clears the value and sel data members. </td> + </tr> +</table> +<a name="a1" doxytag="TCluster::~TCluster"></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"> TCluster::~TCluster </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> +Deletes the cluster's string collection, then destroys the view with <a class="el" href="classTView.html#a1">TView::~TView()</a>. <dl compact><dt><b>See also: </b></dt><dd> +<a class="el" href="classTView.html#a1">TView::~TView</a> </dl> </td> + </tr> +</table> +<a name="b0" doxytag="TCluster::TCluster"></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"> TCluster::TCluster </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="TCluster::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>* TCluster::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 TCluster view. +<p> +Called to create an object in certain stream-reading situations. +<p> +Reimplemented from <a class="el" href="classTView.html#d8">TView</a>. +<p> +Reimplemented in <a class="el" href="classTMonoSelector.html#d0">TMonoSelector</a>, <a class="el" href="classTRadioButtons.html#d0">TRadioButtons</a>, <a class="el" href="classTCheckBoxes.html#d0">TCheckBoxes</a>, and <a class="el" href="classTMultiCheckBoxes.html#d0">TMultiCheckBoxes</a>. </td> + </tr> +</table> +<a name="a16" doxytag="TCluster::buttonState"></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#a13">Boolean</a> TCluster::buttonState </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></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Returns True if the specified item is enabled. +<p> +Parameter `item' specifies which item to check. 0 is the first item, 1 is the second item, etc. <dl compact><dt><b>See also: </b></dt><dd> +<a class="el" href="classTCluster.html#n1">TCluster::enableMask</a> </dl> </td> + </tr> +</table> +<a name="a2" doxytag="TCluster::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> TCluster::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 record of this view (composed by the value data member). Must be overridden in derived classes that change value or add other data members, in order to work with <a class="el" href="classTCluster.html#a5">getData()</a> and <a class="el" href="classTCluster.html#a13">setData()</a>. +<p> +It returns `sizeof(short)' for compatibility with earlier TV, even if value data member is now an unsigned long; <a class="el" href="classTMultiCheckBoxes.html">TMultiCheckBoxes</a> returns sizeof(long). +<p> +Reimplemented from <a class="el" href="classTView.html#a28">TView</a>. +<p> +Reimplemented in <a class="el" href="classTMultiCheckBoxes.html#a2">TMultiCheckBoxes</a>. </td> + </tr> +</table> +<a name="a3" doxytag="TCluster::drawBox"></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"> void TCluster::drawBox </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const char * </td> + <td class="mdname" nowrap> <em>icon</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap>char </td> + <td class="mdname" nowrap> <em>marker</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> +Redraws the view. +<p> +Called within the <a class="el" href="classTView.html#a19">draw()</a> method of derived classes to draw the box in front of the string for each item in the cluster. <dl compact><dt><b>See also: </b></dt><dd> +<a class="el" href="classTCheckBoxes.html#a1">TCheckBoxes::draw</a> , <a class="el" href="classTRadioButtons.html#a1">TRadioButtons::draw</a> , <a class="el" href="classTView.html#a19">TView::draw</a></dl>Parameter `icon' is a five-character string that points to a string which will be written at the left side of every item (" [ ] " for check boxes, " () " for radio buttons). +<p> +Parameter `marker' is the character to use to indicate the box has been marked ("X" for check boxes, "." for radio buttons). A space character will be used if the box is unmarked. <dl compact><dt><b>See also: </b></dt><dd> +<a class="el" href="classTCluster.html#a4">TCluster::drawMultiBox</a> </dl> </td> + </tr> +</table> +<a name="a4" doxytag="TCluster::drawMultiBox"></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"> void TCluster::drawMultiBox </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const char * </td> + <td class="mdname" nowrap> <em>icon</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap>const char * </td> + <td class="mdname" nowrap> <em>marker</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> +Redraws the view. +<p> +Called within the <a class="el" href="classTView.html#a19">draw()</a> method of derived classes. <dl compact><dt><b>See also: </b></dt><dd> +<a class="el" href="classTCheckBoxes.html#a1">TCheckBoxes::draw</a> , <a class="el" href="classTRadioButtons.html#a1">TRadioButtons::draw</a> , <a class="el" href="classTView.html#a19">TView::draw</a></dl>Parameter `icon' points to a string which will be written at the left side of every item. For example <a class="el" href="classTCheckBoxes.html#a1">TCheckBoxes::draw()</a> calls this method with string " [ ] " as `icon' parameter. TRadioButton::draw() calls this method with string " ( ) " as parameter `icon'. +<p> +Parameter `marker' is a pointer to an array of 2 characters. If the item is not checked the first character will be written. Otherwise the second character will be used. <dl compact><dt><b>See also: </b></dt><dd> +<a class="el" href="classTCluster.html#a3">TCluster::drawBox</a> </dl> </td> + </tr> +</table> +<a name="a5" doxytag="TCluster::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 TCluster::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> +Reads the data record of this view. +<p> +Writes the value data member to the given `rec' address and calls <a class="el" href="classTView.html#a20">drawView()</a>. +<p> +Must be overridden in derived classes that change the value data member in order to work with <a class="el" href="classTCluster.html#a2">dataSize()</a> and <a class="el" href="classTCluster.html#a13">setData()</a>. +<p> +Reimplemented from <a class="el" href="classTView.html#a29">TView</a>. +<p> +Reimplemented in <a class="el" href="classTMultiCheckBoxes.html#a4">TMultiCheckBoxes</a>. </td> + </tr> +</table> +<a name="a6" doxytag="TCluster::getHelpCtx"></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> TCluster::getHelpCtx </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 help context of the selected item. +<p> +The help context is calculated by summing view variable <a class="el" href="classTView.html#m9">helpCtx</a> and the number of the currently selected item (0 for the first item, 1 for the second item, etc). Redefines <a class="el" href="classTView.html#a15">TView::getHelpCtx()</a>. +<p> +Enables you to have separate help contexts for each item in the cluster. Use it to reserve a range of help contexts equal to <a class="el" href="classTView.html#m9">helpCtx</a> plus the number of cluster items minus one. +<p> +Reimplemented from <a class="el" href="classTView.html#a15">TView</a>. </td> + </tr> +</table> +<a name="a7" doxytag="TCluster::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>& TCluster::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 standard TCluster palette. +<p> +Reimplemented from <a class="el" href="classTView.html#a46">TView</a>. </td> + </tr> +</table> +<a name="a8" doxytag="TCluster::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 TCluster::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 <a class="el" href="classTView.html#a41">TView::handleEvent()</a>, then handles all mouse and keyboard events appropriate to this cluster. +<p> +Controls are selected by mouse click or cursor movement keys (including Spacebar). The cluster is redrawn to show the selected controls. +<p> +Reimplemented from <a class="el" href="classTView.html#a41">TView</a>. +<p> +Reimplemented in <a class="el" href="classTMonoSelector.html#a2">TMonoSelector</a>. </td> + </tr> +</table> +<a name="a9" doxytag="TCluster::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> TCluster::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> +Called by the <a class="el" href="classTView.html#a19">draw()</a> method redefined both in <a class="el" href="classTCheckBoxes.html">TCheckBoxes</a> and <a class="el" href="classTRadioButtons.html">TRadioButtons</a> classes to determine which items are marked. <a class="el" href="classTCluster.html#a9">mark()</a> should be overridden to return True if the item'th control in the cluster is marked; otherwise, it should return False. <dl compact><dt><b>See also: </b></dt><dd> +<a class="el" href="classTCheckBoxes.html#a1">TCheckBoxes::draw</a> , TRadioButton::draw</dl>The default <a class="el" href="classTCluster.html#a9">mark()</a> returns False. Redefined in <a class="el" href="classTCheckBoxes.html">TCheckBoxes</a> and in <a class="el" href="classTRadioButtons.html">TRadioButtons</a>. <dl compact><dt><b>See also: </b></dt><dd> +<a class="el" href="classTCheckBoxes.html#a2">TCheckBoxes::mark</a> , <a class="el" href="classTRadioButtons.html#a2">TRadioButtons::mark</a> </dl> +<p> +Reimplemented in <a class="el" href="classTMonoSelector.html#a3">TMonoSelector</a>, <a class="el" href="classTRadioButtons.html#a2">TRadioButtons</a>, and <a class="el" href="classTCheckBoxes.html#a2">TCheckBoxes</a>. </td> + </tr> +</table> +<a name="a12" doxytag="TCluster::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 TCluster::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 by <a class="el" href="classTCluster.html#a8">handleEvent()</a> to move the selection bar to the item'th control of the cluster. +<p> +This member function does nothing and must be overridden. Redefined in <a class="el" href="classTRadioButtons.html">TRadioButtons</a>. <dl compact><dt><b>See also: </b></dt><dd> +<a class="el" href="classTRadioButtons.html#a3">TRadioButtons::movedTo</a> </dl> +<p> +Reimplemented in <a class="el" href="classTMonoSelector.html#a6">TMonoSelector</a>, and <a class="el" href="classTRadioButtons.html#a3">TRadioButtons</a>. </td> + </tr> +</table> +<a name="a10" doxytag="TCluster::multiMark"></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#a1">uchar</a> TCluster::multiMark </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> +It just returns `(uchar)(mark(item) == True)'. +<p> +Reimplemented in <a class="el" href="classTMultiCheckBoxes.html#a5">TMultiCheckBoxes</a>. </td> + </tr> +</table> +<a name="a11" doxytag="TCluster::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 TCluster::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 by <a class="el" href="classTCluster.html#a8">handleEvent()</a> when the item'th control in the cluster is pressed either by mouse click or keyboard event. +<p> +This member function does nothing and must be overridden. Redefined in <a class="el" href="classTCheckBoxes.html">TCheckBoxes</a> and in <a class="el" href="classTRadioButtons.html">TRadioButtons</a>. <dl compact><dt><b>See also: </b></dt><dd> +<a class="el" href="classTCheckBoxes.html#a3">TCheckBoxes::press</a> , <a class="el" href="classTRadioButtons.html#a4">TRadioButtons::press</a> </dl> +<p> +Reimplemented in <a class="el" href="classTMonoSelector.html#a5">TMonoSelector</a>, <a class="el" href="classTRadioButtons.html#a4">TRadioButtons</a>, <a class="el" href="classTCheckBoxes.html#a3">TCheckBoxes</a>, and <a class="el" href="classTMultiCheckBoxes.html#a6">TMultiCheckBoxes</a>. </td> + </tr> +</table> +<a name="b2" doxytag="TCluster::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* TCluster::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> +Used to recover the view from a stream. Reads from the input stream `is'. +<p> +Reimplemented from <a class="el" href="classTView.html#b2">TView</a>. +<p> +Reimplemented in <a class="el" href="classTMultiCheckBoxes.html#b2">TMultiCheckBoxes</a>. </td> + </tr> +</table> +<a name="a15" doxytag="TCluster::setButtonState"></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 TCluster::setButtonState </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">unsigned long </td> + <td class="mdname" nowrap> <em>aMask</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap><a class="el" href="ttypes_8h.html#a13">Boolean</a> </td> + <td class="mdname" nowrap> <em>enable</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 the state of one or more items. +<p> +`aMask` is a bitmap which specifies what items to enable or disable. `enable' is the action to perform: False to disable, True to enable. </td> + </tr> +</table> +<a name="a13" doxytag="TCluster::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 TCluster::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. Reads the value data member from the given `rec' address and calls <a class="el" href="classTView.html#a20">drawView()</a>. +<p> +Must be overridden in derived cluster types that require other data members to work with <a class="el" href="classTCluster.html#a2">dataSize()</a> and <a class="el" href="classTCluster.html#a5">getData()</a>. +<p> +Reimplemented from <a class="el" href="classTView.html#a30">TView</a>. +<p> +Reimplemented in <a class="el" href="classTRadioButtons.html#a5">TRadioButtons</a>, and <a class="el" href="classTMultiCheckBoxes.html#a7">TMultiCheckBoxes</a>. </td> + </tr> +</table> +<a name="a14" doxytag="TCluster::setState"></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 TCluster::setState </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="ttypes_8h.html#a0">ushort</a> </td> + <td class="mdname" nowrap> <em>aState</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap><a class="el" href="ttypes_8h.html#a13">Boolean</a> </td> + <td class="mdname" nowrap> <em>enable</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> +Changes the state of the view. Calls TView::setState(aState), then calls <a class="el" href="classTView.html#a20">drawView()</a> if `aState' is <a class="el" href="views_8h.html#a31">sfSelected</a>. <dl compact><dt><b>See also: </b></dt><dd> +<a class="el" href="classTView.html#a50">TView::setState</a> , <a class="el" href="classTView.html#m4">TView::state</a> </dl> +<p> +Reimplemented from <a class="el" href="classTView.html#a50">TView</a>. </td> + </tr> +</table> +<a name="b1" doxytag="TCluster::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 TCluster::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> +Used to store the view in a stream. Writes to the output stream `os'. +<p> +Reimplemented from <a class="el" href="classTView.html#b1">TView</a>. +<p> +Reimplemented in <a class="el" href="classTMultiCheckBoxes.html#b1">TMultiCheckBoxes</a>. </td> + </tr> +</table> +<hr><h2>Member Data Documentation</h2> +<a name="n1" doxytag="TCluster::enableMask"></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"> unsigned long TCluster::enableMask<code> [protected]</code> + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +This variable stores a bitmap which selectively enables cluster items. +<p> +If bit 0 is set the first item is enabled, if bit 1 is set the second item is enabled, etc. If a bit is cleared the related item is disabled. Its initial value is 0xffffffff. +<p> +Definition at line <a class="el" href="dialogs_8h-source.html#l01054">1054</a> of file <a class="el" href="dialogs_8h-source.html">dialogs.h</a>. </td> + </tr> +</table> +<a name="p0" doxytag="TCluster::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 TCluster::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> +Reimplemented in <a class="el" href="classTMonoSelector.html#p0">TMonoSelector</a>, <a class="el" href="classTRadioButtons.html#p0">TRadioButtons</a>, <a class="el" href="classTCheckBoxes.html#p0">TCheckBoxes</a>, and <a class="el" href="classTMultiCheckBoxes.html#p0">TMultiCheckBoxes</a>. +<p> +Definition at line <a class="el" href="dialogs_8h-source.html#l01106">1106</a> of file <a class="el" href="dialogs_8h-source.html">dialogs.h</a>. </td> + </tr> +</table> +<a name="n2" doxytag="TCluster::sel"></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"> int TCluster::sel<code> [protected]</code> + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +This integer contains the current selected item. +<p> +If its value is 0 the first item is selected, if its value is 1 the second item is selected, etc. Its initial value is 0. +<p> +Definition at line <a class="el" href="dialogs_8h-source.html#l01061">1061</a> of file <a class="el" href="dialogs_8h-source.html">dialogs.h</a>. </td> + </tr> +</table> +<a name="n3" doxytag="TCluster::strings"></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="classTStringCollection.html">TStringCollection</a>* TCluster::strings<code> [protected]</code> + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +This object contains all the item captions. +<p> +Definition at line <a class="el" href="dialogs_8h-source.html#l01065">1065</a> of file <a class="el" href="dialogs_8h-source.html">dialogs.h</a>. </td> + </tr> +</table> +<a name="n0" doxytag="TCluster::value"></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"> unsigned long TCluster::value<code> [protected]</code> + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +This variable stores the item status bitmap (current value of the control). Its initial value is 0. +<p> +The actual meaning of this data member is determined by the member functions developed in the classes derived from TCluster. +<p> +For example, <a class="el" href="classTCheckBoxes.html">TCheckBoxes</a> interprets each of the 32 bits of value as the state (on or off) of 32 distinct check boxes. If bit 0 is set the first box is checked, if bit 1 is set the second box is checked, etc. If a bit is cleared the related box is unchecked. +<p> +In <a class="el" href="classTRadioButtons.html">TRadioButtons</a>, value can represent the state of a cluster of up to 2^32 buttons, since only one radio button can be "on" at any one time. +<p> +Note: unsigned long is currently a 32-bit unsigned integer giving a range of 0 to 2^32-1. +<p> +Definition at line <a class="el" href="dialogs_8h-source.html#l01046">1046</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:12 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> |