ncurses 4.1
[ncurses.git] / Ada95 / html / terminal_interface-curses-text_io_s.html
1 <HTML>
2 <HEAD>
3 <TITLE></TITLE>
4 </HEAD>
5 <BODY BGCOLOR="#99ccbb" TEXT="#000000" LINK="#4060b0" VLINK="#000080" ALINK="#ff4040">
6 <PRE>
7 <I>------------------------------------------------------------------------------</I>
8 <I>--                                                                          --</I>
9 <I>--                           <A HREF="http://www.gnat.com">GNAT</A> ncurses Binding                           --</I>
10 <I>--                                                                          --</I>
11 <I>--                     Terminal_Interface.Curses.Text_IO                    --</I>
12 <I>--                                                                          --</I>
13 <I>--                                 S P E C                                  --</I>
14 <I>--                                                                          --</I>
15 <I>--  Version 00.92                                                           --</I>
16 <I>--                                                                          --</I>
17 <I>--  The ncurses Ada95 binding is copyrighted 1996 by                        --</I>
18 <I>--  <A HREF="http://home.t-online.de/home/Juergen.Pfeifer">J&uuml;rgen Pfeifer</A>, Email: <A HREF="mailto:Juergen.Pfeifer@T-Online.de">Juergen.Pfeifer@T-Online.de</A>                      --</I>
19 <I>--                                                                          --</I>
20 <I>--  Permission is hereby granted to reproduce and distribute this           --</I>
21 <I>--  binding by any means and for any fee, whether alone or as part          --</I>
22 <I>--  of a larger distribution, in source or in binary form, PROVIDED         --</I>
23 <I>--  this notice is included with any such distribution, and is not          --</I>
24 <I>--  removed from any of its header files. Mention of ncurses and the        --</I>
25 <I>--  author of this binding in any applications linked with it is            --</I>
26 <I>--  highly appreciated.                                                     --</I>
27 <I>--                                                                          --</I>
28 <I>--  This binding comes AS IS with no warranty, implied or expressed.        --</I>
29 <I>------------------------------------------------------------------------------</I>
30 <I>--  Version Control:</I>
31 <I>--  @Revision: 1.5 @</I>
32 <I>------------------------------------------------------------------------------</I>
33 <B>with</B> System;
34 <B>with</B> System.Parameters;
35 <B>with</B> Ada.Text_IO;
36 <B>with</B> Ada.IO_Exceptions;
37
38 <B>package</B> Terminal_Interface.Curses.Text_IO <B>is</B>
39
40    <B>use</B> type Ada.Text_IO.Count;
41    <B>subtype</B> Count <B>is</B> Ada.Text_IO.Count;
42    <B>subtype</B> Positive_Count <B>is</B> Count <B>range</B> 1 .. Count'Last;
43
44    <B>subtype</B> Field <B>is</B> Integer <B>range</B> 0 .. System.Parameters.Field_Max;
45    <B>subtype</B> Number_Base <B>is</B> Integer <B>range</B> 2 .. 16;
46
47    type Type_Set <B>is</B> (Lower_Case, Upper_Case, Mixed_Case);
48
49    <I>--  For most of the routines you will see a version without a Window</I>
50    <I>--  type parameter. They will operate on a default window, which can</I>
51    <I>--  be set by the user. It is initially equal to Standard_Window.</I>
52
53    <B>procedure</B> Set_Window (Win : <B>in</B> Window);
54    <I>--  Set Win as the default window</I>
55
56    <B>function</B> Get_Window <B>return</B> Window;
57    <I>--  Get the current default window</I>
58
59    <B>procedure</B> Flush (Win : <B>in</B> Window);
60    <B>procedure</B> Flush;
61
62    <I>--------------------------------------------</I>
63    <I>-- Specification of line and page lengths --</I>
64    <I>--------------------------------------------</I>
65
66    <I>--  There are no set routines in this package. I assume, that you allocate</I>
67    <I>--  the window with an appropriate size.</I>
68    <I>--  A scroll-window is interpreted as an page with unbounded page length,</I>
69    <I>--  i.e. it returns the conventional 0 as page length.</I>
70
71    <B>function</B> Line_Length (Win : <B>in</B> Window) <B>return</B> Count;
72    <B>function</B> Line_Length <B>return</B> Count;
73
74    <B>function</B> Page_Length (Win : <B>in</B> Window) <B>return</B> Count;
75    <B>function</B> Page_Length <B>return</B> Count;
76
77    <I>------------------------------------</I>
78    <I>-- Column, Line, and Page Control --</I>
79    <I>------------------------------------</I>
80    <B>procedure</B> New_Line (Win : <B>in</B> Window; Spacing : <B>in</B> Positive_Count := 1);
81    <B>procedure</B> New_Line (Spacing : <B>in</B> Positive_Count := 1);
82
83    <B>procedure</B> New_Page (Win : <B>in</B> Window);
84    <B>procedure</B> New_Page;
85
86    <B>procedure</B> Set_Col (Win : <B>in</B> Window;  To : <B>in</B> Positive_Count);
87    <B>procedure</B> Set_Col (To : <B>in</B> Positive_Count);
88
89    <B>procedure</B> Set_Line (Win : <B>in</B> Window; To : <B>in</B> Positive_Count);
90    <B>procedure</B> Set_Line (To : <B>in</B> Positive_Count);
91
92    <B>function</B> Col (Win : <B>in</B> Window) <B>return</B> Positive_Count;
93    <B>function</B> Col <B>return</B> Positive_Count;
94
95    <B>function</B> Line (Win : <B>in</B> Window) <B>return</B> Positive_Count;
96    <B>function</B> Line <B>return</B> Positive_Count;
97
98    <I>-----------------------</I>
99    <I>-- Characters-Output --</I>
100    <I>-----------------------</I>
101
102    <B>procedure</B> Put (Win  : <B>in</B> Window; Item : <B>in</B> Character);
103    <B>procedure</B> Put (Item : <B>in</B> Character);
104
105    <I>--------------------</I>
106    <I>-- Strings-Output --</I>
107    <I>--------------------</I>
108
109    <B>procedure</B> Put (Win  : <B>in</B> Window; Item : <B>in</B> String);
110    <B>procedure</B> Put (Item : <B>in</B> String);
111
112    <B>procedure</B> Put_Line
113      (Win  : <B>in</B> Window;
114       Item : <B>in</B> String);
115
116    <B>procedure</B> Put_Line
117      (Item : <B>in</B> String);
118
119    <I>--  Exceptions</I>
120
121    Status_Error : <B>exception</B> <B>renames</B> Ada.IO_Exceptions.Status_Error;
122    Mode_Error   : <B>exception</B> <B>renames</B> Ada.IO_Exceptions.Mode_Error;
123    Name_Error   : <B>exception</B> <B>renames</B> Ada.IO_Exceptions.Name_Error;
124    Use_Error    : <B>exception</B> <B>renames</B> Ada.IO_Exceptions.Use_Error;
125    Device_Error : <B>exception</B> <B>renames</B> Ada.IO_Exceptions.Device_Error;
126    End_Error    : <B>exception</B> <B>renames</B> Ada.IO_Exceptions.End_Error;
127    Data_Error   : <B>exception</B> <B>renames</B> Ada.IO_Exceptions.Data_Error;
128    Layout_Error : <B>exception</B> <B>renames</B> Ada.IO_Exceptions.Layout_Error;
129
130 <B>end</B> Terminal_Interface.Curses.Text_IO;
131
132 </PRE>
133
134 <P><HR><P>
135 <P>
136 This is BETA software. The interface is subject to change without notice.<P>
137 <!-- Do NOT delete my name or the tool name from below; -->
138 <!-- giving me credit is a condition of use of ada2html -->
139 <P><I>This hypertext format was generated by <A HREF="http://www.adahome.com/Tutorials/Lovelace/dwheeler.htm">David A. Wheeler</A>'s <A HREF="http://www.adahome.com/Resources/Tools/ada2html/ada2html.htm">ada2html</A></I>
140 </BODY>
141 </HTML>
142