doc/html/ada/terminal_interface-curses-panels__ads.htm

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
   2 <html>
   3 <head>
   4 <title>terminal_interface-curses-panels.ads</title>
   5 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
   6 <style type="text/css">
   7 *.comment {
   8         color: green;
   9 }
  10 *.symbol {
  11         color: red;
  12 }
  13 </style>
  14 </head>
  15 <body>
  16 <hr><div style="text-align:center"><h1> File : terminal_interface-curses-panels.ads </h1></div><hr>
  17 <pre>
  18 <span class="comment"><em>------------------------------------------------------------------------------</em></span>
  19 <span class="comment"><em>--                                                                          --</em></span>
  20 <span class="comment"><em>--                           <strong>GNAT</strong> ncurses Binding                           --</em></span>
  21 <span class="comment"><em>--                                                                          --</em></span>
  22 <span class="comment"><em>--                      Terminal_Interface.Curses.Panels                    --</em></span>
  23 <span class="comment"><em>--                                                                          --</em></span>
  24 <span class="comment"><em>--                                 S P E C                                  --</em></span>
  25 <span class="comment"><em>--                                                                          --</em></span>
  26 <span class="comment"><em>------------------------------------------------------------------------------</em></span>
  27 <span class="comment"><em>-- Copyright 2020 Thomas E. Dickey                                          --</em></span>
  28 <span class="comment"><em>-- Copyright 1998-2009,2014 Free Software Foundation, Inc.                  --</em></span>
  29 <span class="comment"><em>--                                                                          --</em></span>
  30 <span class="comment"><em>-- Permission is hereby granted, free of charge, to any person obtaining a  --</em></span>
  31 <span class="comment"><em>-- copy of this software and associated documentation files (the            --</em></span>
  32 <span class="comment"><em>-- "Software"), to deal in the Software without restriction, including      --</em></span>
  33 <span class="comment"><em>-- without limitation the rights to use, copy, modify, merge, publish,      --</em></span>
  34 <span class="comment"><em>-- distribute, distribute with modifications, sublicense, and/or sell       --</em></span>
  35 <span class="comment"><em>-- copies of the Software, and to permit persons to whom the Software is    --</em></span>
  36 <span class="comment"><em>-- furnished to do so, subject to the following conditions:                 --</em></span>
  37 <span class="comment"><em>--                                                                          --</em></span>
  38 <span class="comment"><em>-- The above copyright notice and this permission notice shall be included  --</em></span>
  39 <span class="comment"><em>-- in all copies or substantial portions of the Software.                   --</em></span>
  40 <span class="comment"><em>--                                                                          --</em></span>
  41 <span class="comment"><em>-- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  --</em></span>
  42 <span class="comment"><em>-- OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               --</em></span>
  43 <span class="comment"><em>-- MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   --</em></span>
  44 <span class="comment"><em>-- IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   --</em></span>
  45 <span class="comment"><em>-- DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    --</em></span>
  46 <span class="comment"><em>-- OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    --</em></span>
  47 <span class="comment"><em>-- THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               --</em></span>
  48 <span class="comment"><em>--                                                                          --</em></span>
  49 <span class="comment"><em>-- Except as contained in this notice, the name(s) of the above copyright   --</em></span>
  50 <span class="comment"><em>-- holders shall not be used in advertising or otherwise to promote the     --</em></span>
  51 <span class="comment"><em>-- sale, use or other dealings in this Software without prior written       --</em></span>
  52 <span class="comment"><em>-- authorization.                                                           --</em></span>
  53 <span class="comment"><em>------------------------------------------------------------------------------</em></span>
  54 <span class="comment"><em>--  Author:  Juergen Pfeifer, 1996</em></span>
  55 <span class="comment"><em>--  Version Control:</em></span>
  56 <span class="comment"><em>--  @Revision: 1.23 @</em></span>
  57 <span class="comment"><em>--  @Date: 2020/02/02 23:34:34 @</em></span>
  58 <span class="comment"><em>--  Binding Version 01.00</em></span>
  59 <span class="comment"><em>------------------------------------------------------------------------------</em></span>
  60 <b>with</b> System;
  61
  62 <b>package</b> <a href="terminal_interface__ads.htm#ref_43_9">Terminal_Interface</a>.<a href="terminal_interface-curses__ads.htm#ref_48_28">Curses</a>.<span class="symbol"><a name="ref_45_35" href="terminal_interface-curses-panels__adb.htm#ref_46_40">Panels</a></span> <b>is</b>
  63    <b>pragma</b> Preelaborate (<a href="terminal_interface__ads.htm#ref_43_9">Terminal_Interface</a>.<a href="terminal_interface-curses__ads.htm#ref_48_28">Curses</a>.<a href="terminal_interface-curses-panels__ads.htm#ref_45_35">Panels</a>);
  64    <b>pragma</b> Linker_Options ("-lpanel" &amp; <a href="terminal_interface-curses_constants__ads.htm#ref_6_28">Curses_Constants</a>.<a href="terminal_interface-curses_constants__ads.htm#ref_9_4">DFT_ARG_SUFFIX</a>);
  65
  66    <b>type</b> <span class="symbol"><a name="ref_49_9">Panel</a></span> <b>is</b> <b>private</b>;
  67
  68    <span class="comment"><em>---------------------------</em></span>
  69    <span class="comment"><em>--  Interface constants  --</em></span>
  70    <span class="comment"><em>---------------------------</em></span>
  71    <span class="symbol"><a name="ref_54_4">Null_Panel</a></span> : <b>constant</b> <a href="terminal_interface-curses-panels__ads.htm#ref_49_9">Panel</a>;
  72
  73    <span class="comment"><em>-------------------</em></span>
  74    <span class="comment"><em>--  Exceptions   --</em></span>
  75    <span class="comment"><em>-------------------</em></span>
  76
  77    <span class="symbol"><a name="ref_60_4">Panel_Exception</a></span> : <b>exception</b>;
  78
  79    <span class="comment"><em>--  |=====================================================================</em></span>
  80    <span class="comment"><em>--  | Man page <A HREF="../man/panel.3x.html">panel.3x</A></em></span>
  81    <span class="comment"><em>--  |=====================================================================</em></span>
  82
  83    <span class="comment"><em>--  <A NAME="AFU_1">|</A></em></span>
  84    <b>function</b> <span class="symbol"><a name="ref_67_13" href="terminal_interface-curses-panels__adb.htm#ref_50_13">Create</a></span> (<span class="symbol"><a name="ref_67_21" href="terminal_interface-curses-panels__adb.htm#ref_50_21">Win</a></span> : <a href="terminal_interface-curses__ads.htm#ref_56_9">Window</a>) <b>return</b> <a href="terminal_interface-curses-panels__ads.htm#ref_49_9">Panel</a>;
  85    <span class="comment"><em>--  AKA: <A HREF="../man/panel.3x.html">new_panel()</A></em></span>
  86    <b>pragma</b> Inline (Create);
  87
  88    <span class="comment"><em>--  <A NAME="AFU_2">|</A></em></span>
  89    <b>function</b> New_Panel (<span class="symbol"><a name="ref_72_24">Win</a></span> : <a href="terminal_interface-curses__ads.htm#ref_56_9">Window</a>) <b>return</b> <a href="terminal_interface-curses-panels__ads.htm#ref_49_9">Panel</a> <b>renames</b> <a href="terminal_interface-curses-panels__ads.htm#ref_67_13">Create</a>;
  90    <span class="comment"><em>--  AKA: <A HREF="../man/panel.3x.html">new_panel()</A></em></span>
  91    <span class="comment"><em>--  pragma Inline (New_Panel);</em></span>
  92
  93    <span class="comment"><em>--  <A NAME="AFU_3">|</A></em></span>
  94    <b>procedure</b> <span class="symbol"><a name="ref_77_14" href="terminal_interface-curses-panels__adb.htm#ref_64_14">Bottom</a></span> (<span class="symbol"><a name="ref_77_22" href="terminal_interface-curses-panels__adb.htm#ref_64_22">Pan</a></span> : <a href="terminal_interface-curses-panels__ads.htm#ref_49_9">Panel</a>);
  95    <span class="comment"><em>--  AKA: <A HREF="../man/panel.3x.html">bottom_panel()</A></em></span>
  96    <b>pragma</b> Inline (<a href="terminal_interface-curses-panels__ads.htm#ref_77_14">Bottom</a>);
  97
  98    <span class="comment"><em>--  <A NAME="AFU_4">|</A></em></span>
  99    <b>procedure</b> <span class="symbol"><a name="ref_82_14" href="terminal_interface-curses-panels__adb.htm#ref_74_14">Top</a></span> (<span class="symbol"><a name="ref_82_19" href="terminal_interface-curses-panels__adb.htm#ref_74_19">Pan</a></span> : <a href="terminal_interface-curses-panels__ads.htm#ref_49_9">Panel</a>);
 100    <span class="comment"><em>--  AKA: <A HREF="../man/panel.3x.html">top_panel()</A></em></span>
 101    <b>pragma</b> Inline (<a href="terminal_interface-curses-panels__ads.htm#ref_82_14">Top</a>);
 102
 103    <span class="comment"><em>--  <A NAME="AFU_5">|</A></em></span>
 104    <b>procedure</b> <span class="symbol"><a name="ref_87_14" href="terminal_interface-curses-panels__adb.htm#ref_84_14">Show</a></span> (<span class="symbol"><a name="ref_87_20" href="terminal_interface-curses-panels__adb.htm#ref_84_20">Pan</a></span> : <a href="terminal_interface-curses-panels__ads.htm#ref_49_9">Panel</a>);
 105    <span class="comment"><em>--  AKA: <A HREF="../man/panel.3x.html">show_panel()</A></em></span>
 106    <b>pragma</b> Inline (<a href="terminal_interface-curses-panels__ads.htm#ref_87_14">Show</a>);
 107
 108    <span class="comment"><em>--  <A NAME="AFU_6">|</A></em></span>
 109    <b>procedure</b> <span class="symbol"><a name="ref_92_14">Update_Panels</a></span>;
 110    <span class="comment"><em>--  AKA: <A HREF="../man/panel.3x.html">update_panels()</A></em></span>
 111    <b>pragma</b> Import (C, Update_Panels, "update_panels");
 112
 113    <span class="comment"><em>--  <A NAME="AFU_7">|</A></em></span>
 114    <b>procedure</b> <span class="symbol"><a name="ref_97_14" href="terminal_interface-curses-panels__adb.htm#ref_94_14">Hide</a></span> (<span class="symbol"><a name="ref_97_20" href="terminal_interface-curses-panels__adb.htm#ref_94_20">Pan</a></span> : <a href="terminal_interface-curses-panels__ads.htm#ref_49_9">Panel</a>);
 115    <span class="comment"><em>--  AKA: <A HREF="../man/panel.3x.html">hide_panel()</A></em></span>
 116    <b>pragma</b> Inline (<a href="terminal_interface-curses-panels__ads.htm#ref_97_14">Hide</a>);
 117
 118    <span class="comment"><em>--  <A NAME="AFU_8">|</A></em></span>
 119    <b>function</b> <span class="symbol"><a name="ref_102_13" href="terminal_interface-curses-panels__adb.htm#ref_104_13">Get_Window</a></span> (<span class="symbol"><a name="ref_102_25" href="terminal_interface-curses-panels__adb.htm#ref_104_25">Pan</a></span> : <a href="terminal_interface-curses-panels__ads.htm#ref_49_9">Panel</a>) <b>return</b> <a href="terminal_interface-curses__ads.htm#ref_56_9">Window</a>;
 120    <span class="comment"><em>--  AKA: <A HREF="../man/panel.3x.html">panel_window()</A></em></span>
 121    <b>pragma</b> Inline (<a href="terminal_interface-curses-panels__ads.htm#ref_102_13">Get_Window</a>);
 122
 123    <span class="comment"><em>--  <A NAME="AFU_9">|</A></em></span>
 124    <b>function</b> Panel_Window (<span class="symbol"><a name="ref_107_27">Pan</a></span> : <a href="terminal_interface-curses-panels__ads.htm#ref_49_9">Panel</a>) <b>return</b> <a href="terminal_interface-curses__ads.htm#ref_56_9">Window</a> <b>renames</b> <a href="terminal_interface-curses-panels__ads.htm#ref_102_13">Get_Window</a>;
 125    <span class="comment"><em>--  pragma Inline (Panel_Window);</em></span>
 126
 127    <span class="comment"><em>--  <A NAME="AFU_10">|</A></em></span>
 128    <b>procedure</b> <span class="symbol"><a name="ref_111_14" href="terminal_interface-curses-panels__adb.htm#ref_117_14">Replace</a></span> (<span class="symbol"><a name="ref_111_23" href="terminal_interface-curses-panels__adb.htm#ref_117_23">Pan</a></span> : <a href="terminal_interface-curses-panels__ads.htm#ref_49_9">Panel</a>;
 129                       <span class="symbol"><a name="ref_112_23" href="terminal_interface-curses-panels__adb.htm#ref_118_23">Win</a></span> : <a href="terminal_interface-curses__ads.htm#ref_56_9">Window</a>);
 130    <span class="comment"><em>--  AKA: <A HREF="../man/panel.3x.html">replace_panel()</A></em></span>
 131    <b>pragma</b> Inline (<a href="terminal_interface-curses-panels__ads.htm#ref_111_14">Replace</a>);
 132
 133    <span class="comment"><em>--  <A NAME="AFU_11">|</A></em></span>
 134    <b>procedure</b> <span class="symbol"><a name="ref_117_14" href="terminal_interface-curses-panels__adb.htm#ref_129_14">Move</a></span> (<span class="symbol"><a name="ref_117_20" href="terminal_interface-curses-panels__adb.htm#ref_129_20">Pan</a></span>    : <a href="terminal_interface-curses-panels__ads.htm#ref_49_9">Panel</a>;
 135                    <span class="symbol"><a name="ref_118_20" href="terminal_interface-curses-panels__adb.htm#ref_130_20">Line</a></span>   : <a href="terminal_interface-curses__ads.htm#ref_59_9">Line_Position</a>;
 136                    <span class="symbol"><a name="ref_119_20" href="terminal_interface-curses-panels__adb.htm#ref_131_20">Column</a></span> : <a href="terminal_interface-curses__ads.htm#ref_60_9">Column_Position</a>);
 137    <span class="comment"><em>--  AKA: <A HREF="../man/panel.3x.html">move_panel()</A></em></span>
 138    <b>pragma</b> Inline (<a href="terminal_interface-curses-panels__ads.htm#ref_117_14">Move</a>);
 139
 140    <span class="comment"><em>--  <A NAME="AFU_12">|</A></em></span>
 141    <b>function</b> <span class="symbol"><a name="ref_124_13" href="terminal_interface-curses-panels__adb.htm#ref_143_13">Is_Hidden</a></span> (<span class="symbol"><a name="ref_124_24" href="terminal_interface-curses-panels__adb.htm#ref_143_24">Pan</a></span> : <a href="terminal_interface-curses-panels__ads.htm#ref_49_9">Panel</a>) <b>return</b> Boolean;
 142    <span class="comment"><em>--  AKA: <A HREF="../man/panel.3x.html">panel_hidden()</A></em></span>
 143    <b>pragma</b> Inline (<a href="terminal_interface-curses-panels__ads.htm#ref_124_13">Is_Hidden</a>);
 144
 145    <span class="comment"><em>--  <A NAME="AFU_13">|</A></em></span>
 146    <b>function</b> <span class="symbol"><a name="ref_129_13">Above</a></span> (<span class="symbol"><a name="ref_129_20">Pan</a></span> : <a href="terminal_interface-curses-panels__ads.htm#ref_49_9">Panel</a>) <b>return</b> <a href="terminal_interface-curses-panels__ads.htm#ref_49_9">Panel</a>;
 147    <span class="comment"><em>--  AKA: <A HREF="../man/panel.3x.html">panel_above()</A></em></span>
 148    <b>pragma</b> Import (C, Above, "panel_above");
 149
 150    <span class="comment"><em>--  <A NAME="AFU_14">|</A></em></span>
 151    <b>function</b> <span class="symbol"><a name="ref_134_13">Below</a></span> (<span class="symbol"><a name="ref_134_20">Pan</a></span> : <a href="terminal_interface-curses-panels__ads.htm#ref_49_9">Panel</a>) <b>return</b> <a href="terminal_interface-curses-panels__ads.htm#ref_49_9">Panel</a>;
 152    <span class="comment"><em>--  AKA: <A HREF="../man/panel.3x.html">panel_below()</A></em></span>
 153    <b>pragma</b> Import (C, Below, "panel_below");
 154
 155    <span class="comment"><em>--  <A NAME="AFU_15">|</A></em></span>
 156    <b>procedure</b> <span class="symbol"><a name="ref_139_14" href="terminal_interface-curses-panels__adb.htm#ref_155_14">Delete</a></span> (<span class="symbol"><a name="ref_139_22" href="terminal_interface-curses-panels__adb.htm#ref_155_22">Pan</a></span> : <b>in</b> <b>out</b> <a href="terminal_interface-curses-panels__ads.htm#ref_49_9">Panel</a>);
 157    <span class="comment"><em>--  AKA: <A HREF="../man/panel.3x.html">del_panel()</A></em></span>
 158    <b>pragma</b> Inline (Delete);
 159
 160 <b>private</b>
 161       <b>type</b> <a href="terminal_interface-curses-panels__ads.htm#ref_49_9">Panel</a> <b>is</b> <b>new</b> System.Storage_Elements.Integer_Address;
 162       <a href="terminal_interface-curses-panels__ads.htm#ref_54_4">Null_Panel</a> : <b>constant</b> <a href="terminal_interface-curses-panels__ads.htm#ref_49_9">Panel</a> := 0;
 163
 164 <b>end</b> <a href="terminal_interface__ads.htm#ref_43_9">Terminal_Interface</a>.<a href="terminal_interface-curses__ads.htm#ref_48_28">Curses</a>.<a href="terminal_interface-curses-panels__ads.htm#ref_45_35">Panels</a>;
 165 </pre></body></html>