diff options
Diffstat (limited to 'sigalatvision/doc/html/classTDeskTop.html')
| -rw-r--r-- | sigalatvision/doc/html/classTDeskTop.html | 474 |
1 files changed, 474 insertions, 0 deletions
diff --git a/sigalatvision/doc/html/classTDeskTop.html b/sigalatvision/doc/html/classTDeskTop.html new file mode 100644 index 0000000..4555273 --- /dev/null +++ b/sigalatvision/doc/html/classTDeskTop.html @@ -0,0 +1,474 @@ +<!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>TDeskTop class Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.8.1 --> +<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>TDeskTop Class Reference</h1>The desktop of the application. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="app_8h-source.html">app.h</a>></code> +<p> +<p>Inheritance diagram for TDeskTop:: +<p><center><img src="classTDeskTop.gif" usemap="#TDeskTop_map" border="0"></center> +<map name="TDeskTop_map"> +<area href="classTGroup.html" alt="TGroup" shape="rect" coords="46,112,128,136"> +<area href="classTDeskInit.html" alt="TDeskInit" shape="rect" coords="138,112,220,136"> +<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="classTDeskTop-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> +<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="classTDeskTop.html#a0">TDeskTop</a> (const <a class="el" href="classTRect.html">TRect</a> &bounds)</td></tr> +<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classTDeskTop.html#a1">cascade</a> (const <a class="el" href="classTRect.html">TRect</a> &)</td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classTDeskTop.html#a2">handleEvent</a> (<a class="el" href="structTEvent.html">TEvent</a> &)</td></tr> +<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classTDeskTop.html#a3">tile</a> (const <a class="el" href="classTRect.html">TRect</a> &)</td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classTDeskTop.html#a4">tileError</a> ()</td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classTDeskTop.html#a5">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="classTBackground.html">TBackground</a>* </td><td valign=bottom><a class="el" href="classTDeskTop.html#d0">initBackground</a> (<a class="el" href="classTRect.html">TRect</a>)</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="classTDeskTop.html#d1">build</a> ()</td></tr> +<tr><td colspan=2><br><h2>Static Public Attributes</h2></td></tr> +<tr><td nowrap align=right valign=top>char </td><td valign=bottom><a class="el" href="classTDeskTop.html#p0">defaultBkgrnd</a></td></tr> +<tr><td nowrap align=right valign=top>const char* const </td><td valign=bottom><a class="el" href="classTDeskTop.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="classTDeskTop.html#b0">TDeskTop</a> (<a class="el" href="ttypes_8h.html#a14">StreamableInit</a>)</td></tr> +<tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr> +<tr><td nowrap align=right valign=top><a class="el" href="classTBackground.html">TBackground</a>* </td><td valign=bottom><a class="el" href="classTDeskTop.html#n0">background</a></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="classTDeskTop.html#n1">tileColumnsFirst</a></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +The desktop of the application. <dl compact><dt> +<b>See also: </b><dd> +<a class="el" href="classTApplication.html">TApplication</a> +<p> +</dl>TDeskTop inherits multiply from <a class="el" href="classTGroup.html">TGroup</a> and the virtual base class <a class="el" href="classTDeskInit.html">TDeskInit</a>. <a class="el" href="classTDeskInit.html">TDeskInit</a> provides a constructor and a create background member function used in creating and inserting a background object. TDeskTop is a simple group that owns the <a class="el" href="classTBackground.html">TBackground</a> view upon which the application's windows and other views appear. +<p> +TDeskTop represents the desk top area of the screen between the top menu bar and bottom status line (but only when the bar and line exist). By default, TDeskTop has a <a class="el" href="classTBackground.html">TBackground</a> object inside which paints its background. +<p> +TDeskTop objects can be written to and read from streams using the overloaded >> and << operators. +<p> + +<p> +Definition at line <a class="el" href="app_8h-source.html#l00179">179</a> of file <a class="el" href="app_8h-source.html">app.h</a>.<hr><h2>Constructor & Destructor Documentation</h2> +<a name="a0" doxytag="TDeskTop::TDeskTop"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +TDeskTop::TDeskTop ( + </b></td> + <td valign="bottom"><b> +const <a class="el" href="classTRect.html">TRect</a> & <em>bounds</em> ) + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Constructor. +<p> +Creates a TDeskTop group with size `bounds' by calling its base constructors <a class="el" href="classTGroup.html#a0">TGroup::TGroup</a> and TDeskInit::TDeskInit(&initBackground). The resulting <a class="el" href="classTBackground.html">TBackground</a> object created by <a class="el" href="classTDeskTop.html#d0">initBackground</a> is then inserted into the desk top. <dl compact><dt> +<b>See also: </b><dd> +<a class="el" href="classTDeskInit.html">TDeskInit</a>:<a class="el" href="classTDeskInit.html">TDeskInit</a> , <a class="el" href="classTGroup.html#a0">TGroup::TGroup</a> +<p> +</dl><a class="el" href="classTView.html#m7">growMode</a> is set to <a class="el" href="views_8h.html#a52">gfGrowHiX</a> | <a class="el" href="views_8h.html#a53">gfGrowHiY</a>. </td> + </tr> +</table> +<a name="b0" doxytag="TDeskTop::TDeskTop"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +TDeskTop::TDeskTop ( + </b></td> + <td valign="bottom"><b> +<a class="el" href="ttypes_8h.html#a14">StreamableInit</a> )<code> [protected]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Constructor used to recover the view from a stream. +<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="d1" doxytag="TDeskTop::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 nowrap valign="top"><b> +<a class="el" href="classTStreamable.html">TStreamable</a> * TDeskTop::build ( + </b></td> + <td valign="bottom"><b> +)<code> [static]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Creates a new TDeskTop. +<p> +Used to recover the view from a stream. Called to create an object in certain stream-reading situations. +<p> +Reimplemented from <a class="el" href="classTGroup.html#d0">TGroup</a>. </td> + </tr> +</table> +<a name="a1" doxytag="TDeskTop::cascade"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +void TDeskTop::cascade ( + </b></td> + <td valign="bottom"><b> +const <a class="el" href="classTRect.html">TRect</a> & ) + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Moves all the windows in a cascade-like fashion. +<p> +Redisplays all tileable windows owned by the desk top in cascaded format. The first tileable window in Z-order (the window "in back") is zoomed to fill the desk top, and each succeeding window fills a region beginning one line lower and one space further to the right than the one before. The active window appears "on top" as the smallest window. </td> + </tr> +</table> +<a name="a2" doxytag="TDeskTop::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 nowrap valign="top"><b> +void TDeskTop::handleEvent ( + </b></td> + <td valign="bottom"><b> +<a class="el" href="structTEvent.html">TEvent</a> & <em>event</em> )<code> [virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Standard TDeskTop event handler. +<p> +Calls <a class="el" href="classTGroup.html#a23">TGroup::handleEvent</a>() and takes care of the commands cmNext (usually the hot key F6) and cmPrev by cycling through the windows owned by the desk top, starting with the currently selected view. +<p> +Reimplemented from <a class="el" href="classTGroup.html#a23">TGroup</a>. </td> + </tr> +</table> +<a name="d0" doxytag="TDeskTop::initBackground"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +<a class="el" href="classTBackground.html">TBackground</a> * TDeskTop::initBackground ( + </b></td> + <td valign="bottom"><b> +<a class="el" href="classTRect.html">TRect</a> )<code> [static]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Creates a new background. +<p> +Returns a pointer to a newly-allocated <a class="el" href="classTBackground.html">TBackground</a> object. The address of this member function is passed as an argument to the <a class="el" href="classTDeskInit.html">TDeskInit</a> constructor. The latter invokes <a class="el" href="classTDeskTop.html#d0">initBackground</a>() to create a new <a class="el" href="classTBackground.html">TBackground</a> object with the same bounds as the calling TDeskTop object. The <a class="el" href="classTDeskTop.html#n0">background</a> data member is set to point at the new <a class="el" href="classTBackground.html">TBackground</a> object. +<p> +Redefine this method if you want a custom background. </td> + </tr> +</table> +<a name="a5" doxytag="TDeskTop::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 nowrap valign="top"><b> +void TDeskTop::shutDown ( + </b></td> + <td valign="bottom"><b> +)<code> [virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Releases TDeskTop resources. +<p> +This function is derived from <a class="el" href="classTObject.html">TObject</a>. Used internally by <a class="el" href="classTObject.html#d0">TObject::destroy</a>() to ensure correct destruction of derived and related objects. <a class="el" href="classTDeskTop.html#a5">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> +This method releases all the resources allocated by the TDeskTop. It sets pointer <a class="el" href="classTDeskTop.html#n0">background</a> to 0 and then calls <a class="el" href="classTGroup.html#a2">TGroup::shutDown</a>(). +<p> +Reimplemented from <a class="el" href="classTGroup.html#a2">TGroup</a>. </td> + </tr> +</table> +<a name="a3" doxytag="TDeskTop::tile"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +void TDeskTop::tile ( + </b></td> + <td valign="bottom"><b> +const <a class="el" href="classTRect.html">TRect</a> & ) + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Moves all the windows in a tile-like fashion. </td> + </tr> +</table> +<a name="a4" doxytag="TDeskTop::tileError"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +void TDeskTop::tileError ( + </b></td> + <td valign="bottom"><b> +)<code> [virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Called on tiling error. +<p> +This method is called whenever <a class="el" href="classTDeskTop.html#a1">cascade</a>() or <a class="el" href="classTDeskTop.html#a3">tile</a>() run into troubles in moving the windows. You can redefine it if you want to give an error message to the user. By default, it does nothing. </td> + </tr> +</table> +<hr><h2>Member Data Documentation</h2> +<a name="n0" doxytag="TDeskTop::background"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +<a class="el" href="classTBackground.html">TBackground</a> * TDeskTop::background<code> [protected]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +This variable stores a pointer to the background object associated with this desk top. +<p> +Definition at line <a class="el" href="app_8h-source.html#l00261">261</a> of file <a class="el" href="app_8h-source.html">app.h</a>. </td> + </tr> +</table> +<a name="p0" doxytag="TDeskTop::defaultBkgrnd"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +char TDeskTop::defaultBkgrnd<code> [static]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +The default pattern which will be used for painting the background. +<p> +Definition at line <a class="el" href="app_8h-source.html#l00255">255</a> of file <a class="el" href="app_8h-source.html">app.h</a>. </td> + </tr> +</table> +<a name="p1" doxytag="TDeskTop::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 nowrap valign="top"><b> +const char *const TDeskTop::name<code> [static]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Undocumented. +<p> +Reimplemented from <a class="el" href="classTGroup.html#p0">TGroup</a>. +<p> +Definition at line <a class="el" href="app_8h-source.html#l00285">285</a> of file <a class="el" href="app_8h-source.html">app.h</a>. </td> + </tr> +</table> +<a name="n1" doxytag="TDeskTop::tileColumnsFirst"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +<a class="el" href="ttypes_8h.html#a13">Boolean</a> TDeskTop::tileColumnsFirst<code> [protected]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +True if method <a class="el" href="classTDeskTop.html#a3">tile</a>() should favour columns first. Set to False in TDeskTop constructor. <dl compact><dt> +<b>See also: </b><dd> +<a class="el" href="classTDeskTop.html#a0">TDeskTop::TDeskTop</a> </dl> +<p> +Definition at line <a class="el" href="app_8h-source.html#l00267">267</a> of file <a class="el" href="app_8h-source.html">app.h</a>. </td> + </tr> +</table> +<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="app_8h-source.html">app.h</a></ul> +<hr><address><small>Generated at Sat Sep 22 20:19:23 2001 for TVision by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.8.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> |