ncurses 5.9 - patch 20140802
[ncurses.git] / Ada95 / samples / sample-function_key_setting.ads
1 ------------------------------------------------------------------------------
2 --                                                                          --
3 --                       GNAT ncurses Binding Samples                       --
4 --                                                                          --
5 --                         Sample.Function_Key_Setting                      --
6 --                                                                          --
7 --                                 S P E C                                  --
8 --                                                                          --
9 ------------------------------------------------------------------------------
10 -- Copyright (c) 1998-2009,2011 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.11 $
39 --  Binding Version 01.00
40 ------------------------------------------------------------------------------
41 with Terminal_Interface.Curses; use Terminal_Interface.Curses;
42 with Terminal_Interface.Curses.Panels; use Terminal_Interface.Curses.Panels;
43
44 --  This package implements a simple stack of function key label environments.
45 --
46 package Sample.Function_Key_Setting is
47
48    procedure Push_Environment (Key   : String;
49                                Reset : Boolean := True);
50    --  Push the definition of the current function keys on an internal
51    --  stack. If the reset flag is true, all labels are reset while
52    --  pushed, so the new environment can assume a tabula rasa.
53    --  The Key defines the new Help Context associated with the new
54    --  Environment. This saves also the currently active Notepad.
55
56    procedure Pop_Environment;
57    --  Pop the Definitions from the stack and make them the current ones.
58    --  This also restores the Help context and the previous Notepad.
59
60    procedure Initialize (Mode : Soft_Label_Key_Format := PC_Style;
61                          Just : Label_Justification := Left);
62    --  Initialize the environment
63
64    function Context return String;
65    --  Return the current context identifier
66
67    function Find_Context (Key : String) return Boolean;
68    --  Look for a context, return true if it is in the stack,
69    --  false otherwise.
70
71    procedure Notepad_To_Context (Pan : Panel);
72    --  Add a panel representing a notepad to the current context.
73
74    Function_Key_Stack_Error : exception;
75
76    procedure Default_Labels;
77    --  Set the default labels used in all environments
78
79    function Notepad_Window return Window;
80    --  Return the current notepad window or Null_Window if there is none.
81
82 end Sample.Function_Key_Setting;