1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140
|
<?xml version="1.0" encoding="ISO-8859-1"?>
<fpdoc-descriptions>
<package name="rtl">
<!--
====================================================================
wincrt
====================================================================
-->
<module name="wincrt">
<short>Auxiliary windows routines for the graph unit</short>
<descr>
The <file>wincrt</file> unit provides some auxiliary routines for use with
the <link id="#rtl.graph">graph</link> unit, namely keyboard support.
It has no connection with the <link id="#rtl.crt">crt</link> unit, nor
with the Turbo-Pascal for Windows <file>WinCrt</file> unit. As such,
it should not be used by end users.
Refer to the <link id="#rtl.crt">crt</link> unit instead.
</descr>
<!-- function Visibility: default -->
<element name="readkey">
<short>Read a key from the keyboard</short>
<descr>
<p>
<var>ReadKey</var> reads a key from the keyboard, and returns the ASCII
value of the key, or the scancode of the key in case it is a special key.
</p>
<p>
The function waits until a key is pressed.
</p>
</descr>
<seealso>
<link id="KeyPressed"/>
</seealso>
</element>
<!-- function result Visibility: default -->
<element name="readkey.Result">
<short>The pressed key</short>
</element>
<!-- function Visibility: default -->
<element name="keypressed">
<short>Check if a key was pressed.</short>
<descr>
<var>KeyPressed</var> returns <var>True</var> if the user pressed a key, or
<var>False</var> if not. It does not wait for the user to press a key.
</descr>
<seealso>
<link id="readkey"/>
</seealso>
</element>
<!-- function result Visibility: default -->
<element name="keypressed.Result">
<short><var>True</var> if the user pressed a key, <var>false</var> if not.</short>
</element>
<!-- procedure Visibility: default -->
<element name="delay">
<short>Pause program execution</short>
<descr>
<var>Delay</var> stops program execution for the indicated number
<var>ms</var> of milliseconds.
</descr>
<seealso>
<link id="sound"/>
<link id="nosound"/>
</seealso>
</element>
<!-- argument Visibility: default -->
<element name="delay.ms">
<short>Number of milliseconds to wait</short>
</element>
<!-- procedure Visibility: default -->
<element name="textmode">
<short>Set indicated text mode</short>
<descr>
<var>TextMode</var> does nothing.
</descr>
</element>
<!-- argument Visibility: default -->
<element name="textmode.mode">
<short>Currently ignored</short>
</element>
<!-- procedure Visibility: default -->
<element name="sound">
<short>Sound PC speaker</short>
<descr>
<var>Sound</var> sounds the PC speaker. It emits a tone with frequency
<var>Hz</var> for 500 milliseconds. (the time argument is required
by the windows API)
</descr>
<seealso>
<link id="nosound"/>
</seealso>
</element>
<!-- argument Visibility: default -->
<element name="sound.hz">
<short>Frequency of sound</short>
</element>
<!-- procedure Visibility: default -->
<element name="nosound">
<short>Stop the speaker</short>
<descr>
<var>NoSound</var> does nothing, windows does not support this.
</descr>
<seealso>
<link id="sound"/>
</seealso>
</element>
<!-- variable Visibility: default -->
<element name="directvideo">
<short>Direct video access</short>
<descr>
On windows, this variable is ignored.
</descr>
</element>
<!-- variable Visibility: default -->
<element name="lastmode">
<short>Unused</short>
<descr>
Is supposed to contain the last used video mode, but is actually unused.
</descr>
</element>
</module> <!-- wincrt -->
</package>
</fpdoc-descriptions>
|