ncurses 5.7 - patch 20101127
[ncurses.git] / Ada95 / src / terminal_interface-curses-forms-field_types-user-choice.ads
1 ------------------------------------------------------------------------------
2 --                                                                          --
3 --                           GNAT ncurses Binding                           --
4 --                                                                          --
5 --           Terminal_Interface.Curses.Forms.Field_Types.User.Choice        --
6 --                                                                          --
7 --                                 S P E C                                  --
8 --                                                                          --
9 ------------------------------------------------------------------------------
10 -- Copyright (c) 1998,2008 Free Software Foundation, Inc.                   --
11 --                                                                          --
12 -- Permission is hereby granted, free of charge, to any person obtaining a  --
13 -- copy of this software and associated documentation files (the            --
14 -- "Software"), to deal in the Software without restriction, including      --
15 -- without limitation the rights to use, copy, modify, merge, publish,      --
16 -- distribute, distribute with modifications, sublicense, and/or sell       --
17 -- copies of the Software, and to permit persons to whom the Software is    --
18 -- furnished to do so, subject to the following conditions:                 --
19 --                                                                          --
20 -- The above copyright notice and this permission notice shall be included  --
21 -- in all copies or substantial portions of the Software.                   --
22 --                                                                          --
23 -- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  --
24 -- OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               --
25 -- MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   --
26 -- IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   --
27 -- DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    --
28 -- OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    --
29 -- THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               --
30 --                                                                          --
31 -- Except as contained in this notice, the name(s) of the above copyright   --
32 -- holders shall not be used in advertising or otherwise to promote the     --
33 -- sale, use or other dealings in this Software without prior written       --
34 -- authorization.                                                           --
35 ------------------------------------------------------------------------------
36 --  Author:  Juergen Pfeifer, 1996
37 --  Version Control:
38 --  $Revision: 1.12 $
39 --  $Date: 2008/07/26 18:49:20 $
40 --  Binding Version 01.00
41 ------------------------------------------------------------------------------
42 with Interfaces.C;
43
44 package Terminal_Interface.Curses.Forms.Field_Types.User.Choice is
45    pragma Preelaborate
46      (Terminal_Interface.Curses.Forms.Field_Types.User.Choice);
47
48    subtype C_Int is Interfaces.C.int;
49
50    type User_Defined_Field_Type_With_Choice is abstract new
51      User_Defined_Field_Type with null record;
52    --  This is the root of the mechanism we use to create field types in
53    --  Ada95 that allow the prev/next mechanism. You should your own type
54    --  derive from this one and implement the Field_Check, Character_Check
55    --  Next and Previous functions for your own type.
56
57    type User_Defined_Field_Type_With_Choice_Access is access all
58      User_Defined_Field_Type_With_Choice'Class;
59
60    function Next
61      (Fld : Field;
62       Typ : User_Defined_Field_Type_With_Choice) return Boolean
63       is abstract;
64    --  If True is returned, the function successfully generated a next
65    --  value into the fields buffer.
66
67    function Previous
68      (Fld : Field;
69       Typ : User_Defined_Field_Type_With_Choice) return Boolean
70       is abstract;
71    --  If True is returned, the function successfully generated a previous
72    --  value into the fields buffer.
73
74    --  +----------------------------------------------------------------------
75    --  | Private Part.
76    --  |
77 private
78    function C_Generic_Choice return C_Field_Type;
79
80    function Generic_Next (Fld : Field;
81                           Usr : System.Address) return C_Int;
82    pragma Convention (C, Generic_Next);
83    --  This is the generic next Choice_Function for the low-level fieldtype
84    --  representing all the User_Defined_Field_Type derivates. It routes
85    --  the call to the Next implementation for the type.
86
87    function Generic_Prev (Fld : Field;
88                           Usr : System.Address) return C_Int;
89    pragma Convention (C, Generic_Prev);
90    --  This is the generic prev Choice_Function for the low-level fieldtype
91    --  representing all the User_Defined_Field_Type derivates. It routes
92    --  the call to the Previous implementation for the type.
93
94 end Terminal_Interface.Curses.Forms.Field_Types.User.Choice;