ncurses 6.2 - patch 20210418
[ncurses.git] / Ada95 / src / terminal_interface-curses-forms-field_types-enumeration-ada.ads
1 ------------------------------------------------------------------------------
2 --                                                                          --
3 --                           GNAT ncurses Binding                           --
4 --                                                                          --
5 --         Terminal_Interface.Curses.Forms.Field_Types.Enumeration.Ada      --
6 --                                                                          --
7 --                                 S P E C                                  --
8 --                                                                          --
9 ------------------------------------------------------------------------------
10 -- Copyright 2020 Thomas E. Dickey                                          --
11 -- Copyright 1999-2002,2003 Free Software Foundation, Inc.                  --
12 --                                                                          --
13 -- Permission is hereby granted, free of charge, to any person obtaining a  --
14 -- copy of this software and associated documentation files (the            --
15 -- "Software"), to deal in the Software without restriction, including      --
16 -- without limitation the rights to use, copy, modify, merge, publish,      --
17 -- distribute, distribute with modifications, sublicense, and/or sell       --
18 -- copies of the Software, and to permit persons to whom the Software is    --
19 -- furnished to do so, subject to the following conditions:                 --
20 --                                                                          --
21 -- The above copyright notice and this permission notice shall be included  --
22 -- in all copies or substantial portions of the Software.                   --
23 --                                                                          --
24 -- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  --
25 -- OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               --
26 -- MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   --
27 -- IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   --
28 -- DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    --
29 -- OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    --
30 -- THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               --
31 --                                                                          --
32 -- Except as contained in this notice, the name(s) of the above copyright   --
33 -- holders shall not be used in advertising or otherwise to promote the     --
34 -- sale, use or other dealings in this Software without prior written       --
35 -- authorization.                                                           --
36 ------------------------------------------------------------------------------
37 --  Author:  Juergen Pfeifer, 1996
38 --  Version Control:
39 --  $Revision: 1.12 $
40 --  Binding Version 01.00
41 ------------------------------------------------------------------------------
42 generic
43    type T is (<>);
44
45 package Terminal_Interface.Curses.Forms.Field_Types.Enumeration.Ada is
46    pragma Preelaborate
47      (Terminal_Interface.Curses.Forms.Field_Types.Enumeration.Ada);
48
49    function Create (Set            : Type_Set := Mixed_Case;
50                     Case_Sensitive : Boolean  := False;
51                     Must_Be_Unique : Boolean  := False)
52                     return Enumeration_Field;
53
54    function Value (Fld : Field;
55                    Buf : Buffer_Number := Buffer_Number'First) return T;
56    --  Translate the content of the fields buffer - indicated by the
57    --  buffer number - into an enumeration value. If the buffer is empty
58    --  or the content is invalid, a Constraint_Error is raises.
59
60 end Terminal_Interface.Curses.Forms.Field_Types.Enumeration.Ada;