ncurses 4.1
[ncurses.git] / Ada95 / gen / terminal_interface-curses-forms-field_user_data.ads.m4
1 --  -*- ada -*-
2 define(`HTMLNAME',`terminal_interface-curses-forms-field_user_data_s.html')dnl
3 include(M4MACRO)dnl
4 ------------------------------------------------------------------------------
5 --                                                                          --
6 --                           GNAT ncurses Binding                           --
7 --                                                                          --
8 --               Terminal_Interface.Curses.Forms.Field_User_Data            --
9 --                                                                          --
10 --                                 S P E C                                  --
11 --                                                                          --
12 --  Version 00.92                                                           --
13 --                                                                          --
14 --  The ncurses Ada95 binding is copyrighted 1996 by                        --
15 --  Juergen Pfeifer, Email: Juergen.Pfeifer@T-Online.de                     --
16 --                                                                          --
17 --  Permission is hereby granted to reproduce and distribute this           --
18 --  binding by any means and for any fee, whether alone or as part          --
19 --  of a larger distribution, in source or in binary form, PROVIDED         --
20 --  this notice is included with any such distribution, and is not          --
21 --  removed from any of its header files. Mention of ncurses and the        --
22 --  author of this binding in any applications linked with it is            --
23 --  highly appreciated.                                                     --
24 --                                                                          --
25 --  This binding comes AS IS with no warranty, implied or expressed.        --
26 ------------------------------------------------------------------------------
27 --  Version Control:
28 --  $Revision: 1.3 $
29 ------------------------------------------------------------------------------
30
31 generic
32    type User is limited private;
33    type User_Access is access User;
34 package Terminal_Interface.Curses.Forms.Field_User_Data is
35
36    --  The binding uses the C level user pointer already for its own
37    --  internal purposes. So you can´t easily manipulate the user pointer
38    --  with the low level C routines for this field without taking care of
39    --  this special situation. If you want to read or write with C routines
40    --  the user pointer of this field, you should get first the low level
41    --  user pointer. This points to a record, that always has as its first
42    --  member the Ada95 user pointer for this field. You should never change
43    --  the low level user pointer of an Ada created field.
44    --
45    --  MANPAGE(`form_field_userptr.3x')
46
47    --  ANCHOR(`set_field_userptr',`Set_User_Data')
48    procedure Set_User_Data (Fld  : in Field;
49                             Data : in User_Access);
50    --  AKA
51    pragma Convention (C, Set_User_Data);
52
53    --  ANCHOR(`field_userptr',`Get_User_Data')
54    procedure Get_User_Data (Fld  : in  Field;
55                             Data : out User_Access);
56    --  AKA
57    pragma Convention (C, Get_User_Data);
58
59 end Terminal_Interface.Curses.Forms.Field_User_Data;