terminal_interface-curses-menus-item_user_data.ads

# File : terminal_interface-curses-menus-item_user_data.ads

    ------------------------------------------------------------------------------
    --                                                                          --
    --                           GNAT ncurses Binding                           --
    --                                                                          --
    --               Terminal_Interface.Curses.Menus.Item_User_Data             --
    --                                                                          --
    --                                 S P E C                                  --
    --                                                                          --
    ------------------------------------------------------------------------------
    -- Copyright (c) 1998-2006,2009 Free Software Foundation, Inc.              --
    --                                                                          --
    -- Permission is hereby granted, free of charge, to any person obtaining a  --
    -- copy of this software and associated documentation files (the            --
    -- "Software"), to deal in the Software without restriction, including      --
    -- without limitation the rights to use, copy, modify, merge, publish,      --
    -- distribute, distribute with modifications, sublicense, and/or sell       --
    -- copies of the Software, and to permit persons to whom the Software is    --
    -- furnished to do so, subject to the following conditions:                 --
    --                                                                          --
    -- The above copyright notice and this permission notice shall be included  --
    -- in all copies or substantial portions of the Software.                   --
    --                                                                          --
    -- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  --
    -- OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               --
    -- MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   --
    -- IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   --
    -- DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    --
    -- OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    --
    -- THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               --
    --                                                                          --
    -- Except as contained in this notice, the name(s) of the above copyright   --
    -- holders shall not be used in advertising or otherwise to promote the     --
    -- sale, use or other dealings in this Software without prior written       --
    -- authorization.                                                           --
    ------------------------------------------------------------------------------
    --  Author:  Juergen Pfeifer, 1996
    --  Version Control:
    --  @Revision: 1.17 @
    --  @Date: 2009/12/26 17:31:35 @
    --  Binding Version 01.00
    ------------------------------------------------------------------------------

    generic
       type User is limited private;
       type User_Access is access User;
    package Terminal_Interface.Curses.Menus.Item_User_Data is
       pragma Preelaborate (Terminal_Interface.Curses.Menus.Item_User_Data);

       --  The binding uses the same user pointer for menu items
       --  as the low level C implementation. So you can safely
       --  read or write the user pointer also with the C routines
       --
       --  |=====================================================================
       --  | Man page mitem_userptr.3x
       --  |=====================================================================

       --  #1A NAME="AFU_1"#2|
       procedure Set_User_Data (Itm  : Item;
                                Data : User_Access);
       --  AKA: set_item_userptr
       pragma Inline (Set_User_Data);

       --  #1A NAME="AFU_2"#2|
       procedure Get_User_Data (Itm  : Item;
                                Data : out User_Access);
       --  AKA: item_userptr

       --  #1A NAME="AFU_3"#2|
       function Get_User_Data (Itm  : Item) return User_Access;
       --  AKA: item_userptr
       --  Same as function
       pragma Inline (Get_User_Data);

    end Terminal_Interface.Curses.Menus.Item_User_Data;