ncurses 5.3
[ncurses.git] / doc / html / ada / terminal_interface-curses-text_io__ads.htm
1 <HTML><HEAD><TITLE>terminal_interface-curses-text_io.ads</TITLE></HEAD>
2 <BODY>
3 <HR><DIV ALIGN="center"><H1> File : terminal_interface-curses-text_io.ads </H1></DIV><HR>
4 <PRE>
5 <FONT COLOR=green><EM>------------------------------------------------------------------------------</EM></FONT>
6 <FONT COLOR=green><EM>--                                                                          --</EM></FONT>
7 <FONT COLOR=green><EM>--                           <A HREF="http://www.gnat.com">GNAT</A> ncurses Binding                           --</EM></FONT>
8 <FONT COLOR=green><EM>--                                                                          --</EM></FONT>
9 <FONT COLOR=green><EM>--                     Terminal_Interface.Curses.Text_IO                    --</EM></FONT>
10 <FONT COLOR=green><EM>--                                                                          --</EM></FONT>
11 <FONT COLOR=green><EM>--                                 S P E C                                  --</EM></FONT>
12 <FONT COLOR=green><EM>--                                                                          --</EM></FONT>
13 <FONT COLOR=green><EM>------------------------------------------------------------------------------</EM></FONT>
14 <FONT COLOR=green><EM>-- Copyright (c) 1998 Free Software Foundation, Inc.                        --</EM></FONT>
15 <FONT COLOR=green><EM>--                                                                          --</EM></FONT>
16 <FONT COLOR=green><EM>-- Permission is hereby granted, free of charge, to any person obtaining a  --</EM></FONT>
17 <FONT COLOR=green><EM>-- copy of this software and associated documentation files (the            --</EM></FONT>
18 <FONT COLOR=green><EM>-- "Software"), to deal in the Software without restriction, including      --</EM></FONT>
19 <FONT COLOR=green><EM>-- without limitation the rights to use, copy, modify, merge, publish,      --</EM></FONT>
20 <FONT COLOR=green><EM>-- distribute, distribute with modifications, sublicense, and/or sell       --</EM></FONT>
21 <FONT COLOR=green><EM>-- copies of the Software, and to permit persons to whom the Software is    --</EM></FONT>
22 <FONT COLOR=green><EM>-- furnished to do so, subject to the following conditions:                 --</EM></FONT>
23 <FONT COLOR=green><EM>--                                                                          --</EM></FONT>
24 <FONT COLOR=green><EM>-- The above copyright notice and this permission notice shall be included  --</EM></FONT>
25 <FONT COLOR=green><EM>-- in all copies or substantial portions of the Software.                   --</EM></FONT>
26 <FONT COLOR=green><EM>--                                                                          --</EM></FONT>
27 <FONT COLOR=green><EM>-- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  --</EM></FONT>
28 <FONT COLOR=green><EM>-- OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               --</EM></FONT>
29 <FONT COLOR=green><EM>-- MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   --</EM></FONT>
30 <FONT COLOR=green><EM>-- IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   --</EM></FONT>
31 <FONT COLOR=green><EM>-- DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    --</EM></FONT>
32 <FONT COLOR=green><EM>-- OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    --</EM></FONT>
33 <FONT COLOR=green><EM>-- THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               --</EM></FONT>
34 <FONT COLOR=green><EM>--                                                                          --</EM></FONT>
35 <FONT COLOR=green><EM>-- Except as contained in this notice, the name(s) of the above copyright   --</EM></FONT>
36 <FONT COLOR=green><EM>-- holders shall not be used in advertising or otherwise to promote the     --</EM></FONT>
37 <FONT COLOR=green><EM>-- sale, use or other dealings in this Software without prior written       --</EM></FONT>
38 <FONT COLOR=green><EM>-- authorization.                                                           --</EM></FONT>
39 <FONT COLOR=green><EM>------------------------------------------------------------------------------</EM></FONT>
40 <FONT COLOR=green><EM>--  Author:  <A HREF="http://www.familiepfeifer.de/juergen">J&uuml;rgen Pfeifer</A>, 1996</EM></FONT>
41 <FONT COLOR=green><EM>--  Contact: <A HREF="http://www.familiepfeifer.de/Contact.aspx?Lang=en">www.familiepfeifer.de/Contact.aspx?Lang=en</A></EM></FONT>
42 <FONT COLOR=green><EM>--  Version Control:</EM></FONT>
43 <FONT COLOR=green><EM>--  @Revision: 1.12 @</EM></FONT>
44 <FONT COLOR=green><EM>--  Binding Version 01.00</EM></FONT>
45 <FONT COLOR=green><EM>------------------------------------------------------------------------------</EM></FONT>
46 <b>with</b> Ada.Text_IO;
47 <b>with</b> Ada.IO_Exceptions;
48
49 <b>package</b> <A HREF="terminal_interface__ads.htm#42_9">Terminal_Interface</A>.<A HREF="terminal_interface-curses__ads.htm#49_28">Curses</A>.<A HREF="terminal_interface-curses-text_io__adb.htm#42_40">Text_IO</A><FONT COLOR=red><A NAME="45_35"></A></FONT> <b>is</b>
50
51    <b>use</b> <b>type</b> Ada.Text_IO.Count;
52    <b>subtype</b> <FONT COLOR=red><A NAME="48_12">Count</A></FONT> <b>is</b> Ada.Text_IO.Count;
53    <b>subtype</b> <FONT COLOR=red><A NAME="49_12">Positive_Count</A></FONT> <b>is</b> <A HREF="terminal_interface-curses-text_io__ads.htm#48_12">Count</A> <b>range</b> 1 .. <A HREF="terminal_interface-curses-text_io__ads.htm#48_12">Count</A>'Last;
54
55    <b>subtype</b> <FONT COLOR=red><A NAME="51_12">Field</A></FONT> <b>is</b> Ada.Text_IO.Field;
56    <b>subtype</b> <FONT COLOR=red><A NAME="52_12">Number_Base</A></FONT> <b>is</b> Integer <b>range</b> 2 .. 16;
57
58    <b>type</b> <FONT COLOR=red><A NAME="54_9">Type_Set</A></FONT> <b>is</b> (<FONT COLOR=red><A NAME="54_22">Lower_Case</A></FONT>, <FONT COLOR=red><A NAME="54_34">Upper_Case</A></FONT>, <FONT COLOR=red><A NAME="54_46">Mixed_Case</A></FONT>);
59
60    <FONT COLOR=green><EM>--  For most of the routines you will see a version without a Window</EM></FONT>
61    <FONT COLOR=green><EM>--  type parameter. They will operate on a default window, which can</EM></FONT>
62    <FONT COLOR=green><EM>--  be set by the user. It is initially equal to Standard_Window.</EM></FONT>
63
64    <b>procedure</b> <A HREF="terminal_interface-curses-text_io__adb.htm#46_14">Set_Window</A><FONT COLOR=red><A NAME="60_14"></A></FONT> (<FONT COLOR=red><A NAME="60_26">Win</A></FONT> : <b>in</b> <A HREF="terminal_interface-curses__ads.htm#57_9">Window</A>);
65    <FONT COLOR=green><EM>--  Set Win as the default window</EM></FONT>
66
67    <b>function</b> <A HREF="terminal_interface-curses-text_io__adb.htm#52_13">Get_Window</A><FONT COLOR=red><A NAME="63_13"></A></FONT> <b>return</b> <A HREF="terminal_interface-curses__ads.htm#57_9">Window</A>;
68    <FONT COLOR=green><EM>--  Get the current default window</EM></FONT>
69
70    <b>procedure</b> <A HREF="terminal_interface-curses-text_io__adb.htm#63_14">Flush</A><FONT COLOR=red><A NAME="66_14"></A></FONT> (<FONT COLOR=red><A NAME="66_21">Win</A></FONT> : <b>in</b> <A HREF="terminal_interface-curses__ads.htm#57_9">Window</A>);
71    <b>procedure</b> <A HREF="terminal_interface-curses-text_io__adb.htm#69_14">Flush</A><FONT COLOR=red><A NAME="67_14"></A></FONT>;
72
73    <FONT COLOR=green><EM>--------------------------------------------</EM></FONT>
74    <FONT COLOR=green><EM>-- Specification of line and page lengths --</EM></FONT>
75    <FONT COLOR=green><EM>--------------------------------------------</EM></FONT>
76
77    <FONT COLOR=green><EM>--  There are no set routines in this package. I assume, that you allocate</EM></FONT>
78    <FONT COLOR=green><EM>--  the window with an appropriate size.</EM></FONT>
79    <FONT COLOR=green><EM>--  A scroll-window is interpreted as an page with unbounded page length,</EM></FONT>
80    <FONT COLOR=green><EM>--  i.e. it returns the conventional 0 as page length.</EM></FONT>
81
82    <b>function</b> <A HREF="terminal_interface-curses-text_io__adb.htm#84_13">Line_Length</A><FONT COLOR=red><A NAME="78_13"></A></FONT> (<FONT COLOR=red><A NAME="78_26">Win</A></FONT> : <b>in</b> <A HREF="terminal_interface-curses__ads.htm#57_9">Window</A>) <b>return</b> <A HREF="terminal_interface-curses-text_io__ads.htm#48_12">Count</A>;
83    <b>function</b> <A HREF="terminal_interface-curses-text_io__adb.htm#96_13">Line_Length</A><FONT COLOR=red><A NAME="79_13"></A></FONT> <b>return</b> <A HREF="terminal_interface-curses-text_io__ads.htm#48_12">Count</A>;
84
85    <b>function</b> <A HREF="terminal_interface-curses-text_io__adb.htm#102_13">Page_Length</A><FONT COLOR=red><A NAME="81_13"></A></FONT> (<FONT COLOR=red><A NAME="81_26">Win</A></FONT> : <b>in</b> <A HREF="terminal_interface-curses__ads.htm#57_9">Window</A>) <b>return</b> <A HREF="terminal_interface-curses-text_io__ads.htm#48_12">Count</A>;
86    <b>function</b> <A HREF="terminal_interface-curses-text_io__adb.htm#118_13">Page_Length</A><FONT COLOR=red><A NAME="82_13"></A></FONT> <b>return</b> <A HREF="terminal_interface-curses-text_io__ads.htm#48_12">Count</A>;
87
88    <FONT COLOR=green><EM>------------------------------------</EM></FONT>
89    <FONT COLOR=green><EM>-- Column, Line, and Page Control --</EM></FONT>
90    <FONT COLOR=green><EM>------------------------------------</EM></FONT>
91    <b>procedure</b> <A HREF="terminal_interface-curses-text_io__adb.htm#127_14">New_Line</A><FONT COLOR=red><A NAME="87_14"></A></FONT> (<FONT COLOR=red><A NAME="87_24">Win</A></FONT> : <b>in</b> <A HREF="terminal_interface-curses__ads.htm#57_9">Window</A>; <FONT COLOR=red><A NAME="87_41">Spacing</A></FONT> : <b>in</b> <A HREF="terminal_interface-curses-text_io__ads.htm#49_12">Positive_Count</A> := 1);
92    <b>procedure</b> <A HREF="terminal_interface-curses-text_io__adb.htm#144_14">New_Line</A><FONT COLOR=red><A NAME="88_14"></A></FONT> (<FONT COLOR=red><A NAME="88_24">Spacing</A></FONT> : <b>in</b> <A HREF="terminal_interface-curses-text_io__ads.htm#49_12">Positive_Count</A> := 1);
93
94    <b>procedure</b> <A HREF="terminal_interface-curses-text_io__adb.htm#150_14">New_Page</A><FONT COLOR=red><A NAME="90_14"></A></FONT> (<FONT COLOR=red><A NAME="90_24">Win</A></FONT> : <b>in</b> <A HREF="terminal_interface-curses__ads.htm#57_9">Window</A>);
95    <b>procedure</b> <A HREF="terminal_interface-curses-text_io__adb.htm#156_14">New_Page</A><FONT COLOR=red><A NAME="91_14"></A></FONT>;
96
97    <b>procedure</b> <A HREF="terminal_interface-curses-text_io__adb.htm#162_14">Set_Col</A><FONT COLOR=red><A NAME="93_14"></A></FONT> (<FONT COLOR=red><A NAME="93_23">Win</A></FONT> : <b>in</b> <A HREF="terminal_interface-curses__ads.htm#57_9">Window</A>;  <FONT COLOR=red><A NAME="93_41">To</A></FONT> : <b>in</b> <A HREF="terminal_interface-curses-text_io__ads.htm#49_12">Positive_Count</A>);
98    <b>procedure</b> <A HREF="terminal_interface-curses-text_io__adb.htm#190_14">Set_Col</A><FONT COLOR=red><A NAME="94_14"></A></FONT> (<FONT COLOR=red><A NAME="94_23">To</A></FONT> : <b>in</b> <A HREF="terminal_interface-curses-text_io__ads.htm#49_12">Positive_Count</A>);
99
100    <b>procedure</b> <A HREF="terminal_interface-curses-text_io__adb.htm#196_14">Set_Line</A><FONT COLOR=red><A NAME="96_14"></A></FONT> (<FONT COLOR=red><A NAME="96_24">Win</A></FONT> : <b>in</b> <A HREF="terminal_interface-curses__ads.htm#57_9">Window</A>; <FONT COLOR=red><A NAME="96_41">To</A></FONT> : <b>in</b> <A HREF="terminal_interface-curses-text_io__ads.htm#49_12">Positive_Count</A>);
101    <b>procedure</b> <A HREF="terminal_interface-curses-text_io__adb.htm#219_14">Set_Line</A><FONT COLOR=red><A NAME="97_14"></A></FONT> (<FONT COLOR=red><A NAME="97_24">To</A></FONT> : <b>in</b> <A HREF="terminal_interface-curses-text_io__ads.htm#49_12">Positive_Count</A>);
102
103    <b>function</b> <A HREF="terminal_interface-curses-text_io__adb.htm#225_13">Col</A><FONT COLOR=red><A NAME="99_13"></A></FONT> (<FONT COLOR=red><A NAME="99_18">Win</A></FONT> : <b>in</b> <A HREF="terminal_interface-curses__ads.htm#57_9">Window</A>) <b>return</b> <A HREF="terminal_interface-curses-text_io__ads.htm#49_12">Positive_Count</A>;
104    <b>function</b> <A HREF="terminal_interface-curses-text_io__adb.htm#239_13">Col</A><FONT COLOR=red><A NAME="100_13"></A></FONT> <b>return</b> <A HREF="terminal_interface-curses-text_io__ads.htm#49_12">Positive_Count</A>;
105
106    <b>function</b> <A HREF="terminal_interface-curses-text_io__adb.htm#245_13">Line</A><FONT COLOR=red><A NAME="102_13"></A></FONT> (<FONT COLOR=red><A NAME="102_19">Win</A></FONT> : <b>in</b> <A HREF="terminal_interface-curses__ads.htm#57_9">Window</A>) <b>return</b> <A HREF="terminal_interface-curses-text_io__ads.htm#49_12">Positive_Count</A>;
107    <b>function</b> <A HREF="terminal_interface-curses-text_io__adb.htm#259_13">Line</A><FONT COLOR=red><A NAME="103_13"></A></FONT> <b>return</b> <A HREF="terminal_interface-curses-text_io__ads.htm#49_12">Positive_Count</A>;
108
109    <FONT COLOR=green><EM>-----------------------</EM></FONT>
110    <FONT COLOR=green><EM>-- Characters-Output --</EM></FONT>
111    <FONT COLOR=green><EM>-----------------------</EM></FONT>
112
113    <b>procedure</b> <A HREF="terminal_interface-curses-text_io__adb.htm#269_14">Put</A><FONT COLOR=red><A NAME="109_14"></A></FONT> (<FONT COLOR=red><A NAME="109_19">Win</A></FONT>  : <b>in</b> <A HREF="terminal_interface-curses__ads.htm#57_9">Window</A>; <FONT COLOR=red><A NAME="109_37">Item</A></FONT> : <b>in</b> Character);
114    <b>procedure</b> <A HREF="terminal_interface-curses-text_io__adb.htm#287_14">Put</A><FONT COLOR=red><A NAME="110_14"></A></FONT> (<FONT COLOR=red><A NAME="110_19">Item</A></FONT> : <b>in</b> Character);
115
116    <FONT COLOR=green><EM>--------------------</EM></FONT>
117    <FONT COLOR=green><EM>-- Strings-Output --</EM></FONT>
118    <FONT COLOR=green><EM>--------------------</EM></FONT>
119
120    <b>procedure</b> <A HREF="terminal_interface-curses-text_io__adb.htm#297_14">Put</A><FONT COLOR=red><A NAME="116_14"></A></FONT> (<FONT COLOR=red><A NAME="116_19">Win</A></FONT>  : <b>in</b> <A HREF="terminal_interface-curses__ads.htm#57_9">Window</A>; <FONT COLOR=red><A NAME="116_37">Item</A></FONT> : <b>in</b> String);
121    <b>procedure</b> <A HREF="terminal_interface-curses-text_io__adb.htm#315_14">Put</A><FONT COLOR=red><A NAME="117_14"></A></FONT> (<FONT COLOR=red><A NAME="117_19">Item</A></FONT> : <b>in</b> String);
122
123    <b>procedure</b> <A HREF="terminal_interface-curses-text_io__adb.htm#321_14">Put_Line</A><FONT COLOR=red><A NAME="119_14"></A></FONT>
124      (<FONT COLOR=red><A NAME="120_7">Win</A></FONT>  : <b>in</b> <A HREF="terminal_interface-curses__ads.htm#57_9">Window</A>;
125       <FONT COLOR=red><A NAME="121_7">Item</A></FONT> : <b>in</b> String);
126
127    <b>procedure</b> <A HREF="terminal_interface-curses-text_io__adb.htm#330_14">Put_Line</A><FONT COLOR=red><A NAME="123_14"></A></FONT>
128      (<FONT COLOR=red><A NAME="124_7">Item</A></FONT> : <b>in</b> String);
129
130    <FONT COLOR=green><EM>--  Exceptions</EM></FONT>
131
132    <FONT COLOR=red><A NAME="128_4">Status_Error</A></FONT> : <b>exception</b> <b>renames</b> Ada.IO_Exceptions.Status_Error;
133    <FONT COLOR=red><A NAME="129_4">Mode_Error</A></FONT>   : <b>exception</b> <b>renames</b> Ada.IO_Exceptions.Mode_Error;
134    <FONT COLOR=red><A NAME="130_4">Name_Error</A></FONT>   : <b>exception</b> <b>renames</b> Ada.IO_Exceptions.Name_Error;
135    <FONT COLOR=red><A NAME="131_4">Use_Error</A></FONT>    : <b>exception</b> <b>renames</b> Ada.IO_Exceptions.Use_Error;
136    <FONT COLOR=red><A NAME="132_4">Device_Error</A></FONT> : <b>exception</b> <b>renames</b> Ada.IO_Exceptions.Device_Error;
137    <FONT COLOR=red><A NAME="133_4">End_Error</A></FONT>    : <b>exception</b> <b>renames</b> Ada.IO_Exceptions.End_Error;
138    <FONT COLOR=red><A NAME="134_4">Data_Error</A></FONT>   : <b>exception</b> <b>renames</b> Ada.IO_Exceptions.Data_Error;
139    <FONT COLOR=red><A NAME="135_4">Layout_Error</A></FONT> : <b>exception</b> <b>renames</b> Ada.IO_Exceptions.Layout_Error;
140
141 <b>end</b> Terminal_Interface.Curses.Text_IO;
142 </PRE></BODY></HTML>