ncurses 5.0
[ncurses.git] / Ada95 / gen / terminal_interface-curses-panels.ads.m4
1 --  -*- ada -*-
2 define(`HTMLNAME',`terminal_interface-curses-panels__ads.htm')dnl
3 include(M4MACRO)dnl
4 ------------------------------------------------------------------------------
5 --                                                                          --
6 --                           GNAT ncurses Binding                           --
7 --                                                                          --
8 --                      Terminal_Interface.Curses.Panels                    --
9 --                                                                          --
10 --                                 S P E C                                  --
11 --                                                                          --
12 ------------------------------------------------------------------------------
13 -- Copyright (c) 1998 Free Software Foundation, Inc.                        --
14 --                                                                          --
15 -- Permission is hereby granted, free of charge, to any person obtaining a  --
16 -- copy of this software and associated documentation files (the            --
17 -- "Software"), to deal in the Software without restriction, including      --
18 -- without limitation the rights to use, copy, modify, merge, publish,      --
19 -- distribute, distribute with modifications, sublicense, and/or sell       --
20 -- copies of the Software, and to permit persons to whom the Software is    --
21 -- furnished to do so, subject to the following conditions:                 --
22 --                                                                          --
23 -- The above copyright notice and this permission notice shall be included  --
24 -- in all copies or substantial portions of the Software.                   --
25 --                                                                          --
26 -- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  --
27 -- OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               --
28 -- MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   --
29 -- IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   --
30 -- DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    --
31 -- OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    --
32 -- THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               --
33 --                                                                          --
34 -- Except as contained in this notice, the name(s) of the above copyright   --
35 -- holders shall not be used in advertising or otherwise to promote the     --
36 -- sale, use or other dealings in this Software without prior written       --
37 -- authorization.                                                           --
38 ------------------------------------------------------------------------------
39 --  Author: Juergen Pfeifer <juergen.pfeifer@gmx.net> 1996
40 --  Version Control:
41 --  $Revision: 1.14 $
42 --  Binding Version 01.00
43 ------------------------------------------------------------------------------
44 with System;
45
46 package Terminal_Interface.Curses.Panels is
47    pragma Preelaborate (Terminal_Interface.Curses.Panels);
48 include(`Panel_Linker_Options')dnl
49 include(`Linker_Options')
50    type Panel is private;
51
52    ---------------------------
53    --  Interface constants  --
54    ---------------------------
55    Null_Panel : constant Panel;
56
57    -------------------
58    --  Exceptions   --
59    -------------------
60
61    Panel_Exception : exception;
62
63    --  MANPAGE(`panel.3x')
64
65    --  ANCHOR(`new_panel()',`Create')
66    function Create (Win : Window) return Panel;
67    --  AKA
68    pragma Inline (Create);
69
70    --  ANCHOR(`new_panel()',`New_Panel')
71    function New_Panel (Win : Window) return Panel renames Create;
72    --  AKA
73    pragma Inline (New_Panel);
74
75    --  ANCHOR(`bottom_panel()',`Bottom')
76    procedure Bottom (Pan : in Panel);
77    --  AKA
78    pragma Inline (Bottom);
79
80    --  ANCHOR(`top_panel()',`Top')
81    procedure Top (Pan : in Panel);
82    --  AKA
83    pragma Inline (Top);
84
85    --  ANCHOR(`show_panel()',`Show')
86    procedure Show (Pan : in Panel);
87    --  AKA
88    pragma Inline (Show);
89
90    --  ANCHOR(`update_panels()',`Update_Panels')
91    procedure Update_Panels;
92    --  AKA
93    pragma Import (C, Update_Panels, "update_panels");
94
95    --  ANCHOR(`hide_panel()',`Hide')
96    procedure Hide (Pan : in Panel);
97    --  AKA
98    pragma Inline (Hide);
99
100    --  ANCHOR(`panel_window()',`Get_Window')
101    function Get_Window (Pan : Panel) return Window;
102    --  AKA
103    pragma Inline (Get_Window);
104
105    --  ANCHOR(`panel_window()',`Panel_Window')
106    function Panel_Window (Pan : Panel) return Window renames Get_Window;
107    pragma Inline (Panel_Window);
108
109    --  ANCHOR(`replace_panel()',`Replace')
110    procedure Replace (Pan : in Panel;
111                       Win : in Window);
112    --  AKA
113    pragma Inline (Replace);
114
115    --  ANCHOR(`move_panel()',`Move')
116    procedure Move (Pan    : in Panel;
117                    Line   : in Line_Position;
118                    Column : in Column_Position);
119    --  AKA
120    pragma Inline (Move);
121
122    --  ANCHOR(`panel_hidden()',`Is_Hidden')
123    function Is_Hidden (Pan : Panel) return Boolean;
124    --  AKA
125    pragma Inline (Is_Hidden);
126
127    --  ANCHOR(`panel_above()',`Above')
128    function Above (Pan : Panel) return Panel;
129    --  AKA
130    pragma Import (C, Above, "panel_above");
131
132    --  ANCHOR(`panel_below()',`Below')
133    function Below (Pan : Panel) return Panel;
134    --  AKA
135    pragma Import (C, Below, "panel_below");
136
137    --  ANCHOR(`del_panel()',`Delete')
138    procedure Delete (Pan : in out Panel);
139    --  AKA
140    pragma Inline (Delete);
141
142    private
143       type Panel is new System.Storage_Elements.Integer_Address;
144       Null_Panel : constant Panel := 0;
145
146 end Terminal_Interface.Curses.Panels;