ncurses 6.2 - patch 20200314
[ncurses.git] / doc / html / ada / terminal_interface-curses-termcap__ads.htm
1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
2 <HTML>
3 <HEAD>
4 <TITLE>terminal_interface-curses-termcap.ads</TITLE>
5 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
6 <style type="text/css">
7 *.comment {
8         color: green;
9 }
10 *.symbol {
11         color: red;
12 }
13 </style>
14 </HEAD>
15 <BODY>
16 <HR><DIV style="text-align:center"><H1> File : terminal_interface-curses-termcap.ads </H1></DIV><HR>
17 <PRE>
18 <span class="comment"><EM>------------------------------------------------------------------------------</EM></span>
19 <span class="comment"><EM>--                                                                          --</EM></span>
20 <span class="comment"><EM>--                           <A HREF="http://www.gnat.com">GNAT</A> ncurses Binding                           --</EM></span>
21 <span class="comment"><EM>--                                                                          --</EM></span>
22 <span class="comment"><EM>--                     Terminal_Interface.Curses.Termcap                    --</EM></span>
23 <span class="comment"><EM>--                                                                          --</EM></span>
24 <span class="comment"><EM>--                                 S P E C                                  --</EM></span>
25 <span class="comment"><EM>--                                                                          --</EM></span>
26 <span class="comment"><EM>------------------------------------------------------------------------------</EM></span>
27 <span class="comment"><EM>-- Copyright 2020 Thomas E. Dickey                                          --</EM></span>
28 <span class="comment"><EM>-- Copyright 2000-2002,2003 Free Software Foundation, Inc.                  --</EM></span>
29 <span class="comment"><EM>--                                                                          --</EM></span>
30 <span class="comment"><EM>-- Permission is hereby granted, free of charge, to any person obtaining a  --</EM></span>
31 <span class="comment"><EM>-- copy of this software and associated documentation files (the            --</EM></span>
32 <span class="comment"><EM>-- "Software"), to deal in the Software without restriction, including      --</EM></span>
33 <span class="comment"><EM>-- without limitation the rights to use, copy, modify, merge, publish,      --</EM></span>
34 <span class="comment"><EM>-- distribute, distribute with modifications, sublicense, and/or sell       --</EM></span>
35 <span class="comment"><EM>-- copies of the Software, and to permit persons to whom the Software is    --</EM></span>
36 <span class="comment"><EM>-- furnished to do so, subject to the following conditions:                 --</EM></span>
37 <span class="comment"><EM>--                                                                          --</EM></span>
38 <span class="comment"><EM>-- The above copyright notice and this permission notice shall be included  --</EM></span>
39 <span class="comment"><EM>-- in all copies or substantial portions of the Software.                   --</EM></span>
40 <span class="comment"><EM>--                                                                          --</EM></span>
41 <span class="comment"><EM>-- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  --</EM></span>
42 <span class="comment"><EM>-- OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               --</EM></span>
43 <span class="comment"><EM>-- MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   --</EM></span>
44 <span class="comment"><EM>-- IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   --</EM></span>
45 <span class="comment"><EM>-- DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    --</EM></span>
46 <span class="comment"><EM>-- OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    --</EM></span>
47 <span class="comment"><EM>-- THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               --</EM></span>
48 <span class="comment"><EM>--                                                                          --</EM></span>
49 <span class="comment"><EM>-- Except as contained in this notice, the name(s) of the above copyright   --</EM></span>
50 <span class="comment"><EM>-- holders shall not be used in advertising or otherwise to promote the     --</EM></span>
51 <span class="comment"><EM>-- sale, use or other dealings in this Software without prior written       --</EM></span>
52 <span class="comment"><EM>-- authorization.                                                           --</EM></span>
53 <span class="comment"><EM>------------------------------------------------------------------------------</EM></span>
54 <span class="comment"><EM>--  Author:  Juergen Pfeifer, 1996</EM></span>
55 <span class="comment"><EM>--  Version Control:</EM></span>
56 <span class="comment"><EM>--  @Revision: 1.5 @</EM></span>
57 <span class="comment"><EM>--  Binding Version 01.00</EM></span>
58 <span class="comment"><EM>------------------------------------------------------------------------------</EM></span>
59
60 <b>package</b> <A HREF="terminal_interface__ads.htm#ref_43_9">Terminal_Interface</A>.<A HREF="terminal_interface-curses__ads.htm#ref_48_28">Curses</A>.<span class="symbol"><A NAME="ref_43_35" HREF="terminal_interface-curses-termcap__adb.htm#ref_48_40">Termcap</A></span> <b>is</b>
61    <b>pragma</b> Preelaborate (<A HREF="terminal_interface__ads.htm#ref_43_9">Terminal_Interface</A>.<A HREF="terminal_interface-curses__ads.htm#ref_48_28">Curses</A>.<A HREF="terminal_interface-curses-termcap__ads.htm#ref_43_35">Termcap</A>);
62
63    <span class="comment"><EM>--  |=====================================================================</EM></span>
64    <span class="comment"><EM>--  | Man page curs_termcap.3x</EM></span>
65    <span class="comment"><EM>--  |=====================================================================</EM></span>
66    <span class="comment"><EM>--  Not implemented:  tputs (see curs_terminfo)</EM></span>
67
68    <b>type</b> Termcap_String <b>is</b> <b>new</b> String;
69
70    <span class="comment"><EM>--  |</EM></span>
71    <b>function</b> <span class="symbol"><A NAME="ref_54_13" HREF="terminal_interface-curses-termcap__adb.htm#ref_149_13">TGoto</A></span> (<span class="symbol"><A NAME="ref_54_20" HREF="terminal_interface-curses-termcap__adb.htm#ref_149_20">Cap</A></span> : String;
72                    <span class="symbol"><A NAME="ref_55_20" HREF="terminal_interface-curses-termcap__adb.htm#ref_150_20">Col</A></span> : <A HREF="terminal_interface-curses__ads.htm#ref_60_9">Column_Position</A>;
73                    <span class="symbol"><A NAME="ref_56_20" HREF="terminal_interface-curses-termcap__adb.htm#ref_151_20">Row</A></span> : <A HREF="terminal_interface-curses__ads.htm#ref_59_9">Line_Position</A>) <b>return</b> Termcap_String;
74    <span class="comment"><EM>--  AKA: tgoto()</EM></span>
75
76    <span class="comment"><EM>--  |</EM></span>
77    <b>function</b> <span class="symbol"><A NAME="ref_60_13" HREF="terminal_interface-curses-termcap__adb.htm#ref_50_13">Get_Entry</A></span> (<span class="symbol"><A NAME="ref_60_24" HREF="terminal_interface-curses-termcap__adb.htm#ref_50_24">Name</A></span> : String) <b>return</b> Boolean;
78    <span class="comment"><EM>--  AKA: tgetent()</EM></span>
79
80    <span class="comment"><EM>--  |</EM></span>
81    <b>function</b> <span class="symbol"><A NAME="ref_64_13" HREF="terminal_interface-curses-termcap__adb.htm#ref_70_13">Get_Flag</A></span> (<span class="symbol"><A NAME="ref_64_23" HREF="terminal_interface-curses-termcap__adb.htm#ref_70_23">Name</A></span> : String) <b>return</b> Boolean;
82    <span class="comment"><EM>--  AKA: tgetflag()</EM></span>
83
84    <span class="comment"><EM>--  |</EM></span>
85    <b>procedure</b> <span class="symbol"><A NAME="ref_68_14" HREF="terminal_interface-curses-termcap__adb.htm#ref_86_14">Get_Number</A></span> (<span class="symbol"><A NAME="ref_68_26" HREF="terminal_interface-curses-termcap__adb.htm#ref_86_26">Name</A></span>   : String;
86                          <span class="symbol"><A NAME="ref_69_26" HREF="terminal_interface-curses-termcap__adb.htm#ref_87_26">Value</A></span>  : <b>out</b> Integer;
87                          <span class="symbol"><A NAME="ref_70_26" HREF="terminal_interface-curses-termcap__adb.htm#ref_88_26">Result</A></span> : <b>out</b> Boolean);
88    <span class="comment"><EM>--  AKA: tgetnum()</EM></span>
89
90    <span class="comment"><EM>--  |</EM></span>
91    <b>procedure</b> <span class="symbol"><A NAME="ref_74_14" HREF="terminal_interface-curses-termcap__adb.htm#ref_105_14">Get_String</A></span> (<span class="symbol"><A NAME="ref_74_26" HREF="terminal_interface-curses-termcap__adb.htm#ref_105_26">Name</A></span>   : String;
92                          <span class="symbol"><A NAME="ref_75_26" HREF="terminal_interface-curses-termcap__adb.htm#ref_106_26">Value</A></span>  : <b>out</b> String;
93                          <span class="symbol"><A NAME="ref_76_26" HREF="terminal_interface-curses-termcap__adb.htm#ref_107_26">Result</A></span> : <b>out</b> Boolean);
94    <b>function</b> <span class="symbol"><A NAME="ref_77_13" HREF="terminal_interface-curses-termcap__adb.htm#ref_128_13">Get_String</A></span> (<span class="symbol"><A NAME="ref_77_25" HREF="terminal_interface-curses-termcap__adb.htm#ref_128_25">Name</A></span> : String) <b>return</b> Boolean;
95    <span class="comment"><EM>--  Returns True if the string is found.</EM></span>
96    <span class="comment"><EM>--  AKA: tgetstr()</EM></span>
97
98 <b>end</b> <A HREF="terminal_interface__ads.htm#ref_43_9">Terminal_Interface</A>.<A HREF="terminal_interface-curses__ads.htm#ref_48_28">Curses</A>.<A HREF="terminal_interface-curses-termcap__ads.htm#ref_43_35">Termcap</A>;
99 </PRE></BODY></HTML>