diff options
Diffstat (limited to 'freebsdtvision/doc/html/classTBackground.html')
| -rw-r--r-- | freebsdtvision/doc/html/classTBackground.html | 341 |
1 files changed, 341 insertions, 0 deletions
diff --git a/freebsdtvision/doc/html/classTBackground.html b/freebsdtvision/doc/html/classTBackground.html new file mode 100644 index 0000000..e4fa1a8 --- /dev/null +++ b/freebsdtvision/doc/html/classTBackground.html @@ -0,0 +1,341 @@ +<!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>TBackground 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>TBackground Class Reference</h1>The default desktop background. +<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 TBackground: +<p><center><img src="classTBackground.png" usemap="#TBackground_map" border="0" alt=""></center> +<map name="TBackground_map"> +<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"> +</map> +<a href="classTBackground-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="classTBackground.html#a0">TBackground</a> (const <a class="el" href="classTRect.html">TRect</a> &bounds, char aPattern)</td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classTBackground.html#a1">draw</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="classTBackground.html#a2">getPalette</a> () const</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="classTBackground.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="classTBackground.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="classTBackground.html#b0">TBackground</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="classTBackground.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="classTBackground.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>char </td><td valign=bottom><a class="el" href="classTBackground.html#n0">pattern</a></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +The default desktop background. +<p> +TBackground is a very simple view which by default is the background of the desktop. It is a rectangle painted with an uniform pattern. <dl compact><dt><b>See also: </b></dt><dd> +<a class="el" href="classTDeskTop.html">TDeskTop</a> </dl> +<p> + +<p> +Definition at line <a class="el" href="app_8h-source.html#l00029">29</a> of file <a class="el" href="app_8h-source.html">app.h</a>.<hr><h2>Constructor & Destructor Documentation</h2> +<a name="a0" doxytag="TBackground::TBackground"></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"> TBackground::TBackground </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>char </td> + <td class="mdname" nowrap> <em>aPattern</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> +`bounds' is the bounding rectangle of the background. +<p> +<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>, and the pattern data member is set to `aPattern'. </td> + </tr> +</table> +<a name="b0" doxytag="TBackground::TBackground"></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"> TBackground::TBackground </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. +<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="TBackground::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>* TBackground::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 TBackground. +<p> +Used to recover the view from a stream. +<p> +Called to create an object in certain stream-reading situations. +<p> +Reimplemented from <a class="el" href="classTView.html#d8">TView</a>. </td> + </tr> +</table> +<a name="a1" doxytag="TBackground::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 TBackground::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> +Fills the background view rectangle with the current pattern in the default color. +<p> +Reimplemented from <a class="el" href="classTView.html#a19">TView</a>. </td> + </tr> +</table> +<a name="a2" doxytag="TBackground::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>& TBackground::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 TBackground palette. +<p> +Reimplemented from <a class="el" href="classTView.html#a46">TView</a>. </td> + </tr> +</table> +<a name="b2" doxytag="TBackground::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* TBackground::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. +<p> +Reads from the input stream `is'. +<p> +Reimplemented from <a class="el" href="classTView.html#b2">TView</a>. </td> + </tr> +</table> +<a name="b1" doxytag="TBackground::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 TBackground::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. +<p> +Writes to the output stream `os'. +<p> +Reimplemented from <a class="el" href="classTView.html#b1">TView</a>. </td> + </tr> +</table> +<hr><h2>Member Data Documentation</h2> +<a name="p0" doxytag="TBackground::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 TBackground::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> +Definition at line <a class="el" href="app_8h-source.html#l00086">86</a> of file <a class="el" href="app_8h-source.html">app.h</a>. </td> + </tr> +</table> +<a name="n0" doxytag="TBackground::pattern"></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"> char TBackground::pattern<code> [protected]</code> + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Is the pattern used to fill the view. +<p> +Definition at line <a class="el" href="app_8h-source.html#l00054">54</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 style="align: right;"><small>Generated on Wed Apr 2 22:13:11 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> |