diff options
Diffstat (limited to 'sigalatvision/doc/html/classTScreen.html')
| -rw-r--r-- | sigalatvision/doc/html/classTScreen.html | 729 |
1 files changed, 729 insertions, 0 deletions
diff --git a/sigalatvision/doc/html/classTScreen.html b/sigalatvision/doc/html/classTScreen.html new file mode 100644 index 0000000..4c8dec8 --- /dev/null +++ b/sigalatvision/doc/html/classTScreen.html @@ -0,0 +1,729 @@ +<!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>TScreen 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>TScreen Class Reference</h1>The interface to the system. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="system_8h-source.html">system.h</a>></code> +<p> +<p>Inheritance diagram for TScreen:: +<p><center><img src="classTScreen.gif" usemap="#TScreen_map" border="0"></center> +<map name="TScreen_map"> +<area href="classTDisplay.html" alt="TDisplay" shape="rect" coords="0,0,82,24"> +<area href="classTApplication.html" alt="TApplication" shape="rect" coords="0,112,82,136"> +</map> +<a href="classTScreen-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="classTScreen.html#a0">TScreen</a> ()</td></tr> +<tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classTScreen.html#a1">~TScreen</a> ()</td></tr> +<tr><td colspan=2><br><h2>Static Public Methods</h2></td></tr> +<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classTScreen.html#d0">getEvent</a> (<a class="el" href="structTEvent.html">TEvent</a> &event)</td></tr> +<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classTScreen.html#d1">makeBeep</a> ()</td></tr> +<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classTScreen.html#d2">putEvent</a> (<a class="el" href="structTEvent.html">TEvent</a> &event)</td></tr> +<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classTScreen.html#d3">resume</a> ()</td></tr> +<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classTScreen.html#d4">suspend</a> ()</td></tr> +<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classTScreen.html#d5">drawCursor</a> (int show)</td></tr> +<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classTScreen.html#d6">drawMouse</a> (int show)</td></tr> +<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classTScreen.html#d7">moveCursor</a> (int x, int y)</td></tr> +<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classTScreen.html#d8">writeRow</a> (int dst, <a class="el" href="ttypes_8h.html#a0">ushort</a> *src, int len)</td></tr> +<tr><td colspan=2><br><h2>Static Public Attributes</h2></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="classTScreen.html#p0">screenMode</a></td></tr> +<tr><td nowrap align=right valign=top><a class="el" href="ttypes_8h.html#a1">uchar</a> </td><td valign=bottom><a class="el" href="classTScreen.html#p1">screenWidth</a></td></tr> +<tr><td nowrap align=right valign=top><a class="el" href="ttypes_8h.html#a1">uchar</a> </td><td valign=bottom><a class="el" href="classTScreen.html#p2">screenHeight</a></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="classTScreen.html#p3">screenBuffer</a></td></tr> +<tr><td nowrap align=right valign=top>fd_set </td><td valign=bottom><a class="el" href="classTScreen.html#p4">fdSetRead</a></td></tr> +<tr><td nowrap align=right valign=top>fd_set </td><td valign=bottom><a class="el" href="classTScreen.html#p5">fdSetWrite</a></td></tr> +<tr><td nowrap align=right valign=top>fd_set </td><td valign=bottom><a class="el" href="classTScreen.html#p6">fdSetExcept</a></td></tr> +<tr><td nowrap align=right valign=top>fd_set </td><td valign=bottom><a class="el" href="classTScreen.html#p7">fdActualRead</a></td></tr> +<tr><td nowrap align=right valign=top>fd_set </td><td valign=bottom><a class="el" href="classTScreen.html#p8">fdActualWrite</a></td></tr> +<tr><td nowrap align=right valign=top>fd_set </td><td valign=bottom><a class="el" href="classTScreen.html#p9">fdActualExcept</a></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +A low-level class used to interface to the system. +<p> +TScreen provides low-level video attributes and functions. This class is used internally by TVision. You do not need to use it explicitly for normal applications. +<p> +Since this class was rewritten in the porting process, it is not a standard class and you should not use it. Otherwise you may end with a non-portable program. +<p> + +<p> +Definition at line <a class="el" href="system_8h-source.html#l00489">489</a> of file <a class="el" href="system_8h-source.html">system.h</a>.<hr><h2>Constructor & Destructor Documentation</h2> +<a name="a0" doxytag="TScreen::TScreen"></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> +TScreen::TScreen ( + </b></td> + <td valign="bottom"><b> +) + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Constructor. +<p> +Reads enviroment variables, acquires screen size, opens mouse and screen devices, catches some useful signals and starts an interval timer. </td> + </tr> +</table> +<a name="a1" doxytag="TScreen::~TScreen"></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> +TScreen::~TScreen ( + </b></td> + <td valign="bottom"><b> +) + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Destructor. +<p> +Releases the resources allocated by the constructor. </td> + </tr> +</table> +<hr><h2>Member Function Documentation</h2> +<a name="d5" doxytag="TScreen::drawCursor"></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 TScreen::drawCursor ( + </b></td> + <td valign="bottom"><b> +int <em>show</em> )<code> [static]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Shows or hides the cursor. +<p> +Flag `show' specifies the operation to perform. </td> + </tr> +</table> +<a name="d6" doxytag="TScreen::drawMouse"></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 TScreen::drawMouse ( + </b></td> + <td valign="bottom"><b> +int <em>show</em> )<code> [static]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Shows or hides the mouse pointer. +<p> +Flag `show' specifies the operation to perform. </td> + </tr> +</table> +<a name="d0" doxytag="TScreen::getEvent"></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 TScreen::getEvent ( + </b></td> + <td valign="bottom"><b> +<a class="el" href="structTEvent.html">TEvent</a> & <em>event</em> )<code> [static]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Returns the first available event. +<p> +Reimplemented in <a class="el" href="classTApplication.html#a2">TApplication</a>. </td> + </tr> +</table> +<a name="d1" doxytag="TScreen::makeBeep"></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 TScreen::makeBeep ( + </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> +Emits a beep. </td> + </tr> +</table> +<a name="d7" doxytag="TScreen::moveCursor"></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 TScreen::moveCursor ( + </b></td> + <td valign="bottom"><b> +int <em>x</em>, + </b></td> + </tr> + <tr> + <td></td> + <td><b> +int <em>y</em> )<code> [static]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Moves the cursor to another place. +<p> +Parameters `x' and `y' are 0-based. </td> + </tr> +</table> +<a name="d2" doxytag="TScreen::putEvent"></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 TScreen::putEvent ( + </b></td> + <td valign="bottom"><b> +<a class="el" href="structTEvent.html">TEvent</a> & <em>event</em> )<code> [static]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Puts an event in the event queue. +<p> +Do not use it, use <a class="el" href="classTProgram.html#a10">TProgram::putEvent</a>() if you need. </td> + </tr> +</table> +<a name="d3" doxytag="TScreen::resume"></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 TScreen::resume ( + </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> +Recovers the execution of the application. +<p> +Resumes the execution of the process after the user stopped it. Called by <a class="el" href="classTApplication.html#a1">TApplication::resume</a>(). You should call the latter method. +<p> +Reimplemented in <a class="el" href="classTApplication.html#a1">TApplication</a>. </td> + </tr> +</table> +<a name="d4" doxytag="TScreen::suspend"></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 TScreen::suspend ( + </b></td> + <td valign="bottom"><b> +void )<code> [static]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Stops the execution of the application. +<p> +Suspends execution of the process. Called by <a class="el" href="classTApplication.html#a0">TApplication::suspend</a>(). You should call the latter method. +<p> +Reimplemented in <a class="el" href="classTApplication.html#a0">TApplication</a>. </td> + </tr> +</table> +<a name="d8" doxytag="TScreen::writeRow"></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 TScreen::writeRow ( + </b></td> + <td valign="bottom"><b> +int <em>dst</em>, + </b></td> + </tr> + <tr> + <td></td> + <td><b> +<a class="el" href="ttypes_8h.html#a0">ushort</a> * <em>src</em>, + </b></td> + </tr> + <tr> + <td></td> + <td><b> +int <em>len</em> )<code> [static]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Writes a row of character & attribute pairs on the screen. +<p> +`dst' is the destination position, `src' is a pointer to the source buffer and `len' is the size of the buffer expressed as the number of pairs. </td> + </tr> +</table> +<hr><h2>Member Data Documentation</h2> +<a name="p9" doxytag="TScreen::fdActualExcept"></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> +fd_set TScreen::fdActualExcept<code> [static]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +File descriptor set to indicate I/O exceptions. +<p> +This set is returned by select() within <a class="el" href="classTScreen.html#d0">getEvent</a>(). It can be tested to handle exceptions on files mentioned in <a class="el" href="classTScreen.html#p6">fdSetExcept</a>. +<p> +Definition at line <a class="el" href="system_8h-source.html#l00630">630</a> of file <a class="el" href="system_8h-source.html">system.h</a>. </td> + </tr> +</table> +<a name="p7" doxytag="TScreen::fdActualRead"></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> +fd_set TScreen::fdActualRead<code> [static]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +File descriptor set to indicate read() availability. +<p> +This set is returned by select() within <a class="el" href="classTScreen.html#d0">getEvent</a>(). It can be tested to handle operations on files mentioned in <a class="el" href="classTScreen.html#p4">fdSetRead</a>. +<p> +Definition at line <a class="el" href="system_8h-source.html#l00616">616</a> of file <a class="el" href="system_8h-source.html">system.h</a>. </td> + </tr> +</table> +<a name="p8" doxytag="TScreen::fdActualWrite"></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> +fd_set TScreen::fdActualWrite<code> [static]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +File descriptor set to indicate write() completion. +<p> +This set is returned by select() within <a class="el" href="classTScreen.html#d0">getEvent</a>(). It can be tested to handle operations on files mentioned in <a class="el" href="classTScreen.html#p5">fdSetWrite</a>. +<p> +Definition at line <a class="el" href="system_8h-source.html#l00623">623</a> of file <a class="el" href="system_8h-source.html">system.h</a>. </td> + </tr> +</table> +<a name="p6" doxytag="TScreen::fdSetExcept"></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> +fd_set TScreen::fdSetExcept<code> [static]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +File descriptor set to watch for I/O exceptions. +<p> +This set is used in select() within <a class="el" href="classTScreen.html#d0">getEvent</a>(). It is empty by default and can be used freely. +<p> +Definition at line <a class="el" href="system_8h-source.html#l00609">609</a> of file <a class="el" href="system_8h-source.html">system.h</a>. </td> + </tr> +</table> +<a name="p4" doxytag="TScreen::fdSetRead"></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> +fd_set TScreen::fdSetRead<code> [static]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +File descriptor set to watch for read operations. +<p> +This set is used to watch for incoming mouse and keyboard data. Do not FD_ZERO() it in your program. However, FD_SET() and FD_CLR() are OK. +<p> +Definition at line <a class="el" href="system_8h-source.html#l00595">595</a> of file <a class="el" href="system_8h-source.html">system.h</a>. </td> + </tr> +</table> +<a name="p5" doxytag="TScreen::fdSetWrite"></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> +fd_set TScreen::fdSetWrite<code> [static]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +File descriptor set to watch for write operations. +<p> +This set is used in select() within <a class="el" href="classTScreen.html#d0">getEvent</a>(). It is empty by default and can be used freely. +<p> +Definition at line <a class="el" href="system_8h-source.html#l00602">602</a> of file <a class="el" href="system_8h-source.html">system.h</a>. </td> + </tr> +</table> +<a name="p3" doxytag="TScreen::screenBuffer"></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#a0">ushort</a> * TScreen::screenBuffer<code> [static]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Holds the current screen buffer address. +<p> +It is initialized by the constructor of this class. +<p> +Definition at line <a class="el" href="system_8h-source.html#l00587">587</a> of file <a class="el" href="system_8h-source.html">system.h</a>. </td> + </tr> +</table> +<a name="p2" doxytag="TScreen::screenHeight"></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#a1">uchar</a> TScreen::screenHeight<code> [static]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Holds the current screen height. +<p> +It is initialized by the constructor of this class. +<p> +Definition at line <a class="el" href="system_8h-source.html#l00581">581</a> of file <a class="el" href="system_8h-source.html">system.h</a>. </td> + </tr> +</table> +<a name="p0" doxytag="TScreen::screenMode"></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#a0">ushort</a> TScreen::screenMode<code> [static]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Holds the current screen mode. +<p> +It is initialized by the constructor if this class. It is read by <a class="el" href="classTProgram.html#a8">TProgram::initScreen</a>(). <dl compact><dt> +<b>See also: </b><dd> +<a class="el" href="classTDisplay.html">TDisplay</a> </dl> +<p> +Definition at line <a class="el" href="system_8h-source.html#l00569">569</a> of file <a class="el" href="system_8h-source.html">system.h</a>. </td> + </tr> +</table> +<a name="p1" doxytag="TScreen::screenWidth"></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#a1">uchar</a> TScreen::screenWidth<code> [static]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Holds the current screen width. +<p> +It is initialized by the constructor of this class. +<p> +Definition at line <a class="el" href="system_8h-source.html#l00575">575</a> of file <a class="el" href="system_8h-source.html">system.h</a>. </td> + </tr> +</table> +<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="system_8h-source.html">system.h</a></ul> +<hr><address><small>Generated at Sat Sep 22 20:19:33 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> |