diff options
Diffstat (limited to 'freebsdtvision/doc/html/classTMenuBox.html')
| -rw-r--r-- | freebsdtvision/doc/html/classTMenuBox.html | 271 |
1 files changed, 271 insertions, 0 deletions
diff --git a/freebsdtvision/doc/html/classTMenuBox.html b/freebsdtvision/doc/html/classTMenuBox.html new file mode 100644 index 0000000..758c744 --- /dev/null +++ b/freebsdtvision/doc/html/classTMenuBox.html @@ -0,0 +1,271 @@ +<!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>TMenuBox 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>TMenuBox Class Reference</h1>These objects represent vertical menu boxes. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="menus_8h-source.html">menus.h</a>></code> +<p> +<p>Inheritance diagram for TMenuBox: +<p><center><img src="classTMenuBox.png" usemap="#TMenuBox_map" border="0" alt=""></center> +<map name="TMenuBox_map"> +<area href="classTMenuView.html" alt="TMenuView" shape="rect" coords="48,112,135,136"> +<area href="classTView.html" alt="TView" shape="rect" coords="48,56,135,80"> +<area href="classTObject.html" alt="TObject" shape="rect" coords="0,0,87,24"> +<area href="classTStreamable.html" alt="TStreamable" shape="rect" coords="97,0,184,24"> +<area href="classTMenuPopup.html" alt="TMenuPopup" shape="rect" coords="48,224,135,248"> +</map> +<a href="classTMenuBox-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="classTMenuBox.html#a0">TMenuBox</a> (const <a class="el" href="classTRect.html">TRect</a> &bounds, <a class="el" href="classTMenu.html">TMenu</a> *aMenu, <a class="el" href="classTMenuView.html">TMenuView</a> *aParentMenu)</td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classTMenuBox.html#a1">draw</a> ()</td></tr> +<tr><td nowrap align=right valign=top>virtual <a class="el" href="classTRect.html">TRect</a> </td><td valign=bottom><a class="el" href="classTMenuBox.html#a2">getItemRect</a> (<a class="el" href="classTMenuItem.html">TMenuItem</a> *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="classTMenuBox.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="classTMenuBox.html#p0">frameChars</a></td></tr> +<tr><td nowrap align=right valign=top>const char *const </td><td valign=bottom><a class="el" href="classTMenuBox.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="classTMenuBox.html#b0">TMenuBox</a> (<a class="el" href="ttypes_8h.html#a14">StreamableInit</a>)</td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +TMenuBox objects represent vertical menu boxes. Color coding is used to indicate disabled items. Menu boxes can be instantiated as submenus of the menu bar or other menu boxes, or can be used alone as pop-up menus. +<p> + +<p> +Definition at line <a class="el" href="menus_8h-source.html#l00569">569</a> of file <a class="el" href="menus_8h-source.html">menus.h</a>.<hr><h2>Constructor & Destructor Documentation</h2> +<a name="a0" doxytag="TMenuBox::TMenuBox"></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"> TMenuBox::TMenuBox </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="classTMenu.html">TMenu</a> * </td> + <td class="mdname" nowrap> <em>aMenu</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap><a class="el" href="classTMenuView.html">TMenuView</a> * </td> + <td class="mdname" nowrap> <em>aParentMenu</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 TMenuBox object by calling TMenuView::TMenuView(bounds). The `bounds' parameter is then adjusted to accommodate the width and length of the items in `aMenu'. <dl compact><dt><b>See also: </b></dt><dd> +<a class="el" href="classTMenuView.html#a0">TMenuView::TMenuView</a></dl>The <a class="el" href="views_8h.html#a42">ofPreProcess</a> bit in the options data member is set so that hot keys will operate. Data member state is set to include <a class="el" href="views_8h.html#a29">sfShadow</a>. +<p> +The menu data member is set to `aMenu', which provides the menu selections. Allows an explicit `aParentMenu' which is set to <a class="el" href="classTMenuView.html#n0">parentMenu</a>. </td> + </tr> +</table> +<a name="b0" doxytag="TMenuBox::TMenuBox"></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"> TMenuBox::TMenuBox </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="TMenuBox::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>* TMenuBox::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="classTMenuView.html#d0">TMenuView</a>. </td> + </tr> +</table> +<a name="a1" doxytag="TMenuBox::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 TMenuBox::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 framed menu box and associated menu items in the default colors. +<p> +Reimplemented from <a class="el" href="classTView.html#a19">TView</a>. </td> + </tr> +</table> +<a name="a2" doxytag="TMenuBox::getItemRect"></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="classTRect.html">TRect</a> TMenuBox::getItemRect </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="classTMenuItem.html">TMenuItem</a> * </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 the rectangle occupied by the given menu item. It can be used to determine if a mouse click has occurred on a given menu selection. +<p> +Reimplemented from <a class="el" href="classTMenuView.html#a5">TMenuView</a>. </td> + </tr> +</table> +<hr><h2>Member Data Documentation</h2> +<a name="p0" doxytag="TMenuBox::frameChars"></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* TMenuBox::frameChars<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="menus_8h-source.html#l00600">600</a> of file <a class="el" href="menus_8h-source.html">menus.h</a>. </td> + </tr> +</table> +<a name="p1" doxytag="TMenuBox::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 TMenuBox::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="classTMenuView.html#p0">TMenuView</a>. +<p> +Reimplemented in <a class="el" href="classTMenuPopup.html#p0">TMenuPopup</a>. +<p> +Definition at line <a class="el" href="menus_8h-source.html#l00618">618</a> of file <a class="el" href="menus_8h-source.html">menus.h</a>. </td> + </tr> +</table> +<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="menus_8h-source.html">menus.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> |