ncurses 4.2
[ncurses.git] / Ada95 / samples / sample-form_demo-aux.ads
1 ------------------------------------------------------------------------------
2 --                                                                          --
3 --                       GNAT ncurses Binding Samples                       --
4 --                                                                          --
5 --                            Sample.Form_Demo.Aux                          --
6 --                                                                          --
7 --                                 S P E C                                  --
8 --                                                                          --
9 ------------------------------------------------------------------------------
10 -- Copyright (c) 1998 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 <Juergen.Pfeifer@T-Online.de> 1996
37 --  Version Control
38 --  $Revision: 1.5 $
39 --  Binding Version 00.93
40 ------------------------------------------------------------------------------
41 with Terminal_Interface.Curses; use  Terminal_Interface.Curses;
42 with Terminal_Interface.Curses.Panels; use  Terminal_Interface.Curses.Panels;
43 with Terminal_Interface.Curses.Forms;  use  Terminal_Interface.Curses.Forms;
44
45 package Sample.Form_Demo.Aux is
46
47    procedure Geometry (F  : in  Form;
48                        L  : out Line_Count;
49                        C  : out Column_Count;
50                        Y  : out Line_Position;
51                        X  : out Column_Position);
52    --  Calculate the geometry for a panel beeing able to be used to display
53    --  the menu.
54
55    function Create (F     : Form;
56                     Title : String;
57                     Lin   : Line_Position;
58                     Col   : Column_Position) return Panel;
59    --  Create a panel decorated with a frame and the title at the specified
60    --  position. The dimension of the panel is derived from the menus layout.
61
62    procedure Destroy (F : in Form;
63                       P : in out Panel);
64    --  Destroy all the windowing structures associated with this menu and
65    --  panel.
66
67    function Get_Request (F           : Form;
68                          P           : Panel;
69                          Handle_CRLF : Boolean := True) return Key_Code;
70    --  Centralized request driver for all menus in this sample. This
71    --  gives us a common key binding for all menus.
72
73    function Make (Top         : Line_Position;
74                   Left        : Column_Position;
75                   Text        : String) return Field;
76    --  create a label
77
78    function Make  (Height      : Line_Count := 1;
79                    Width       : Column_Count;
80                    Top         : Line_Position;
81                    Left        : Column_Position;
82                    Off_Screen  : Natural := 0) return Field;
83    --  create a editable field
84
85    function Default_Driver (F : Form;
86                             K : Key_Code;
87                             P : Panel) return Boolean;
88
89    function Count_Active (F : Form) return Natural;
90    --  Count the number of active fields in the form
91
92 end Sample.Form_Demo.Aux;