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 2020 Thomas E. Dickey                                          --
  11 -- Copyright 1998-2009,2011 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 with Terminal_Interface.Curses; use  Terminal_Interface.Curses;
  43 with Terminal_Interface.Curses.Panels; use  Terminal_Interface.Curses.Panels;
  44 with Terminal_Interface.Curses.Forms;  use  Terminal_Interface.Curses.Forms;
  45
  46 package Sample.Form_Demo.Aux is
  47
  48    procedure Geometry (F  : Form;
  49                        L  : out Line_Count;
  50                        C  : out Column_Count;
  51                        Y  : out Line_Position;
  52                        X  : out Column_Position);
  53    --  Calculate the geometry for a panel being able to be used to display
  54    --  the menu.
  55
  56    function Create (F     : Form;
  57                     Title : String;
  58                     Lin   : Line_Position;
  59                     Col   : Column_Position) return Panel;
  60    --  Create a panel decorated with a frame and the title at the specified
  61    --  position. The dimension of the panel is derived from the menus layout.
  62
  63    procedure Destroy (F : Form;
  64                       P : in out Panel);
  65    --  Destroy all the windowing structures associated with this menu and
  66    --  panel.
  67
  68    function Get_Request (F           : Form;
  69                          P           : Panel;
  70                          Handle_CRLF : Boolean := True) return Key_Code;
  71    --  Centralized request driver for all menus in this sample. This
  72    --  gives us a common key binding for all menus.
  73
  74    function Make (Top         : Line_Position;
  75                   Left        : Column_Position;
  76                   Text        : String) return Field;
  77    --  create a label
  78
  79    function Make  (Height      : Line_Count := 1;
  80                    Width       : Column_Count;
  81                    Top         : Line_Position;
  82                    Left        : Column_Position;
  83                    Off_Screen  : Natural := 0) return Field;
  84    --  create a editable field
  85
  86    function Default_Driver (F : Form;
  87                             K : Key_Code;
  88                             P : Panel) return Boolean;
  89
  90    function Count_Active (F : Form) return Natural;
  91    --  Count the number of active fields in the form
  92
  93 end Sample.Form_Demo.Aux;