ncurses 4.2
[ncurses.git] / Ada95 / html / terminal_interface-curses-forms-field_types-enumeration_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.Forms.Field_Types.Enumeration        --</I>
12 <I>--                                                                          --</I>
13 <I>--                                 S P E C                                  --</I>
14 <I>--                                                                          --</I>
15 <I>------------------------------------------------------------------------------</I>
16 <I>-- Copyright (c) 1998 Free Software Foundation, Inc.                        --</I>
17 <I>--                                                                          --</I>
18 <I>-- Permission is hereby granted, free of charge, to any person obtaining a  --</I>
19 <I>-- copy of this software and associated documentation files (the            --</I>
20 <I>-- "Software"), to deal in the Software without restriction, including      --</I>
21 <I>-- without limitation the rights to use, copy, modify, merge, publish,      --</I>
22 <I>-- distribute, distribute with modifications, sublicense, and/or sell       --</I>
23 <I>-- copies of the Software, and to permit persons to whom the Software is    --</I>
24 <I>-- furnished to do so, subject to the following conditions:                 --</I>
25 <I>--                                                                          --</I>
26 <I>-- The above copyright notice and this permission notice shall be included  --</I>
27 <I>-- in all copies or substantial portions of the Software.                   --</I>
28 <I>--                                                                          --</I>
29 <I>-- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  --</I>
30 <I>-- OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               --</I>
31 <I>-- MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   --</I>
32 <I>-- IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   --</I>
33 <I>-- DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    --</I>
34 <I>-- OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    --</I>
35 <I>-- THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               --</I>
36 <I>--                                                                          --</I>
37 <I>-- Except as contained in this notice, the name(s) of the above copyright   --</I>
38 <I>-- holders shall not be used in advertising or otherwise to promote the     --</I>
39 <I>-- sale, use or other dealings in this Software without prior written       --</I>
40 <I>-- authorization.                                                           --</I>
41 <I>------------------------------------------------------------------------------</I>
42 <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>
43 <I>--  Version Control:</I>
44 <I>--  @Revision: 1.1 @</I>
45 <I>------------------------------------------------------------------------------</I>
46 <B>with</B> Interfaces.C.Strings;
47
48 <B>package</B> Terminal_Interface.Curses.Forms.Field_Types.Enumeration <B>is</B>
49
50    type String_Access <B>is</B> <B>access</B> String;
51
52    <I>--  Type_Set is used by the child package Ada</I>
53    type Type_Set <B>is</B> (Lower_Case, Upper_Case, Mixed_Case);
54
55    type Enum_Array <B>is</B> <B>array</B> (Positive <B>range</B> &lt;&gt;)
56      <B>of</B> String_Access;
57
58    type Enumeration_Info (C : Positive) <B>is</B>
59       <B>record</B>
60          Names                : Enum_Array (1 .. C);
61          Case_Sensitive       : Boolean := False;
62          Match_Must_Be_Unique : Boolean := False;
63       <B>end</B> <B>record</B>;
64
65    type Enumeration_Field <B>is</B> <B>new</B> Field_Type <B>with</B> <B>private</B>;
66
67    <B>function</B> Create (Info : Enumeration_Info;
68                     Auto_Release_Names : Boolean := False)
69                     <B>return</B> Enumeration_Field;
70    <I>--  Make an fieldtype from the info. Enumerations are special, because</I>
71    <I>--  they normally don't copy the enum values into a private store, so</I>
72    <I>--  we have to care for the lifetime of the info we provide.</I>
73    <I>--  The Auto_Release_Names flag may be used to automatically releases</I>
74    <I>--  the strings in the Names array of the Enumeration_Info.</I>
75
76    <B>function</B> Make_Enumeration_Type (Info : Enumeration_Info;
77                                    Auto_Release_Names : Boolean := False)
78                                    <B>return</B> Enumeration_Field <B>renames</B> Create;
79
80    <B>procedure</B> Release (Enum : <B>in</B> <B>out</B> Enumeration_Field);
81    <I>--  But we may want to release the field to release the memory allocated</I>
82    <I>--  by it internally. After that the Enumeration field is no longer usable.</I>
83
84    <I>--  The next type defintions are all ncurses extensions. They are typically</I>
85    <I>--  not available in other curses implementations.</I>
86
87    <B>procedure</B> Set_Field_Type (Fld : <B>in</B> Field;
88                              Typ : <B>in</B> Enumeration_Field);
89
90 <B>private</B>
91    type CPA_Access <B>is</B> <B>access</B> Interfaces.C.Strings.chars_ptr_array;
92
93    type Enumeration_Field <B>is</B> <B>new</B> Field_Type <B>with</B>
94       <B>record</B>
95          Case_Sensitive       : Boolean := False;
96          Match_Must_Be_Unique : Boolean := False;
97          Arr                  : CPA_Access := <B>null</B>;
98       <B>end</B> <B>record</B>;
99
100 <B>end</B> Terminal_Interface.Curses.Forms.Field_Types.Enumeration;
101
102 </PRE>
103
104 <P><HR><P>
105 <P>
106 This is BETA software. The interface is subject to change without notice.<P>
107 <!-- Do NOT delete my name or the tool name from below; -->
108 <!-- giving me credit is a condition of use of ada2html -->
109 <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>
110 </BODY>
111 </HTML>
112