X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fada%2Fterminal_interface-curses-menus__ads.htm;h=a8d9253a6d08b34102e72cce2aa1ed044b8aeb84;hp=d90df1a5625ec2cae4d7f18bd43c7792622d21a5;hb=97cb42f22c43eb31a4bf11475bd73ab0e0b10923;hpb=bca50d0d8592defee6c584fdedd25f4b1a31345b diff --git a/doc/html/ada/terminal_interface-curses-menus__ads.htm b/doc/html/ada/terminal_interface-curses-menus__ads.htm index d90df1a5..a8d9253a 100644 --- a/doc/html/ada/terminal_interface-curses-menus__ads.htm +++ b/doc/html/ada/terminal_interface-curses-menus__ads.htm @@ -115,10 +115,10 @@ REQ_NEXT_MATCH : Menu_Request_Code renames M_Next_Match; REQ_PREV_MATCH : Menu_Request_Code renames M_Previous_Match; - procedure Request_Name (Key : Menu_Request_Code; - Name : out String); + procedure Request_Name (Key : Menu_Request_Code; + Name : out String); - function Request_Name (Key : Menu_Request_Code) return String; + function Request_Name (Key : Menu_Request_Code) return String; -- Same as function ------------------ @@ -159,7 +159,7 @@ for Menu_Option_Set'Size use Curses_Constants.Menu_Options_Size; pragma Warnings (On); - function Default_Menu_Options return Menu_Option_Set; + function Default_Menu_Options return Menu_Option_Set; -- Initial default options for a menu. pragma Inline (Default_Menu_Options); -- @@ -180,7 +180,7 @@ for Item_Option_Set'Size use Curses_Constants.Item_Options_Size; pragma Warnings (On); - function Default_Item_Options return Item_Option_Set; + function Default_Item_Options return Item_Option_Set; -- Initial default options for an item. pragma Inline (Default_Item_Options); @@ -192,8 +192,8 @@ type Item_Array_Access is access Item_Array; - procedure Free (IA : in out Item_Array_Access; - Free_Items : Boolean := False); + procedure Free (IA : in out Item_Array_Access; + Free_Items : Boolean := False); -- Release the memory for an allocated item array -- If Free_Items is True, call Delete() for all the items in -- the array. @@ -202,20 +202,20 @@ -- | Man page mitem_new.3x -- |===================================================================== - -- #1A NAME="AFU_1"#2| - function Create (Name : String; - Description : String := "") return Item; + -- | + function Create (Name : String; + Description : String := "") return Item; -- AKA: new_item() -- Not inlined. - -- #1A NAME="AFU_2"#2| + -- | function New_Item (Name : String; Description : String := "") return Item renames Create; -- AKA: new_item() - -- #1A NAME="AFU_3"#2| - procedure Delete (Itm : in out Item); + -- | + procedure Delete (Itm : in out Item); -- AKA: free_item() -- Resets Itm to Null_Item @@ -223,14 +223,14 @@ -- | Man page mitem_value.3x -- |===================================================================== - -- #1A NAME="AFU_4"#2| - procedure Set_Value (Itm : Item; - Value : Boolean := True); + -- | + procedure Set_Value (Itm : Item; + Value : Boolean := True); -- AKA: set_item_value() pragma Inline (Set_Value); - -- #1A NAME="AFU_5"#2| - function Value (Itm : Item) return Boolean; + -- | + function Value (Itm : Item) return Boolean; -- AKA: item_value() pragma Inline (Value); @@ -238,8 +238,8 @@ -- | Man page mitem_visible.3x -- |===================================================================== - -- #1A NAME="AFU_6"#2| - function Visible (Itm : Item) return Boolean; + -- | + function Visible (Itm : Item) return Boolean; -- AKA: item_visible() pragma Inline (Visible); @@ -247,28 +247,28 @@ -- | Man page mitem_opts.3x -- |===================================================================== - -- #1A NAME="AFU_7"#2| - procedure Set_Options (Itm : Item; - Options : Item_Option_Set); + -- | + procedure Set_Options (Itm : Item; + Options : Item_Option_Set); -- AKA: set_item_opts() -- An overloaded Set_Options is defined later. Pragma Inline appears there - -- #1A NAME="AFU_8"#2| - procedure Switch_Options (Itm : Item; - Options : Item_Option_Set; - On : Boolean := True); + -- | + procedure Switch_Options (Itm : Item; + Options : Item_Option_Set; + On : Boolean := True); -- AKA: item_opts_on() -- AKA: item_opts_off() -- An overloaded Switch_Options is defined later. -- Pragma Inline appears there - -- #1A NAME="AFU_9"#2| - procedure Get_Options (Itm : Item; - Options : out Item_Option_Set); + -- | + procedure Get_Options (Itm : Item; + Options : out Item_Option_Set); -- AKA: item_opts() - -- #1A NAME="AFU_10"#2| - function Get_Options (Itm : Item := Null_Item) return Item_Option_Set; + -- | + function Get_Options (Itm : Item := Null_Item) return Item_Option_Set; -- AKA: item_opts() -- An overloaded Get_Options is defined later. Pragma Inline appears there @@ -276,21 +276,21 @@ -- | Man page mitem_name.3x -- |===================================================================== - -- #1A NAME="AFU_11"#2| - procedure Name (Itm : Item; - Name : out String); + -- | + procedure Name (Itm : Item; + Name : out String); -- AKA: item_name() - function Name (Itm : Item) return String; + function Name (Itm : Item) return String; -- AKA: item_name() -- Implemented as function pragma Inline (Name); - -- #1A NAME="AFU_12"#2| - procedure Description (Itm : Item; - Description : out String); + -- | + procedure Description (Itm : Item; + Description : out String); -- AKA: item_description(); - function Description (Itm : Item) return String; + function Description (Itm : Item) return String; -- AKA: item_description(); -- Implemented as function pragma Inline (Description); @@ -299,30 +299,30 @@ -- | Man page mitem_current.3x -- |===================================================================== - -- #1A NAME="AFU_13"#2| - procedure Set_Current (Men : Menu; - Itm : Item); + -- | + procedure Set_Current (Men : Menu; + Itm : Item); -- AKA: set_current_item() pragma Inline (Set_Current); - -- #1A NAME="AFU_14"#2| - function Current (Men : Menu) return Item; + -- | + function Current (Men : Menu) return Item; -- AKA: current_item() pragma Inline (Current); - -- #1A NAME="AFU_15"#2| - procedure Set_Top_Row (Men : Menu; - Line : Line_Position); + -- | + procedure Set_Top_Row (Men : Menu; + Line : Line_Position); -- AKA: set_top_row() pragma Inline (Set_Top_Row); - -- #1A NAME="AFU_16"#2| - function Top_Row (Men : Menu) return Line_Position; + -- | + function Top_Row (Men : Menu) return Line_Position; -- AKA: top_row() pragma Inline (Top_Row); - -- #1A NAME="AFU_17"#2| - function Get_Index (Itm : Item) return Positive; + -- | + function Get_Index (Itm : Item) return Positive; -- AKA: item_index() -- Please note that in this binding we start the numbering of items -- with 1. So this is number is one more than you get from the low @@ -333,9 +333,9 @@ -- | Man page menu_post.3x -- |===================================================================== - -- #1A NAME="AFU_18"#2| - procedure Post (Men : Menu; - Post : Boolean := True); + -- | + procedure Post (Men : Menu; + Post : Boolean := True); -- AKA: post_menu() -- AKA: unpost_menu() pragma Inline (Post); @@ -344,27 +344,27 @@ -- | Man page menu_opts.3x -- |===================================================================== - -- #1A NAME="AFU_19"#2| - procedure Set_Options (Men : Menu; - Options : Menu_Option_Set); + -- | + procedure Set_Options (Men : Menu; + Options : Menu_Option_Set); -- AKA: set_menu_opts() pragma Inline (Set_Options); - -- #1A NAME="AFU_20"#2| - procedure Switch_Options (Men : Menu; - Options : Menu_Option_Set; - On : Boolean := True); + -- | + procedure Switch_Options (Men : Menu; + Options : Menu_Option_Set; + On : Boolean := True); -- AKA: menu_opts_on() -- AKA: menu_opts_off() pragma Inline (Switch_Options); - -- #1A NAME="AFU_21"#2| - procedure Get_Options (Men : Menu; - Options : out Menu_Option_Set); + -- | + procedure Get_Options (Men : Menu; + Options : out Menu_Option_Set); -- AKA: menu_opts() - -- #1A NAME="AFU_22"#2| - function Get_Options (Men : Menu := Null_Menu) return Menu_Option_Set; + -- | + function Get_Options (Men : Menu := Null_Menu) return Menu_Option_Set; -- AKA: menu_opts() pragma Inline (Get_Options); @@ -372,32 +372,32 @@ -- | Man page menu_win.3x -- |===================================================================== - -- #1A NAME="AFU_23"#2| - procedure Set_Window (Men : Menu; - Win : Window); + -- | + procedure Set_Window (Men : Menu; + Win : Window); -- AKA: set_menu_win() pragma Inline (Set_Window); - -- #1A NAME="AFU_24"#2| - function Get_Window (Men : Menu) return Window; + -- | + function Get_Window (Men : Menu) return Window; -- AKA: menu_win() pragma Inline (Get_Window); - -- #1A NAME="AFU_25"#2| - procedure Set_Sub_Window (Men : Menu; - Win : Window); + -- | + procedure Set_Sub_Window (Men : Menu; + Win : Window); -- AKA: set_menu_sub() pragma Inline (Set_Sub_Window); - -- #1A NAME="AFU_26"#2| - function Get_Sub_Window (Men : Menu) return Window; + -- | + function Get_Sub_Window (Men : Menu) return Window; -- AKA: menu_sub() pragma Inline (Get_Sub_Window); - -- #1A NAME="AFU_27"#2| - procedure Scale (Men : Menu; - Lines : out Line_Count; - Columns : out Column_Count); + -- | + procedure Scale (Men : Menu; + Lines : out Line_Count; + Columns : out Column_Count); -- AKA: scale_menu() pragma Inline (Scale); @@ -405,8 +405,8 @@ -- | Man page menu_cursor.3x -- |===================================================================== - -- #1A NAME="AFU_28"#2| - procedure Position_Cursor (Men : Menu); + -- | + procedure Position_Cursor (Men : Menu); -- AKA: pos_menu_cursor() pragma Inline (Position_Cursor); @@ -414,18 +414,18 @@ -- | Man page menu_mark.3x -- |===================================================================== - -- #1A NAME="AFU_29"#2| - procedure Set_Mark (Men : Menu; - Mark : String); + -- | + procedure Set_Mark (Men : Menu; + Mark : String); -- AKA: set_menu_mark() pragma Inline (Set_Mark); - -- #1A NAME="AFU_30"#2| - procedure Mark (Men : Menu; - Mark : out String); + -- | + procedure Mark (Men : Menu; + Mark : out String); -- AKA: menu_mark() - function Mark (Men : Menu) return String; + function Mark (Men : Menu) return String; -- AKA: menu_mark() -- Implemented as function pragma Inline (Mark); @@ -434,76 +434,76 @@ -- | Man page menu_attributes.3x -- |===================================================================== - -- #1A NAME="AFU_31"#2| - procedure Set_Foreground - (Men : Menu; - Fore : Character_Attribute_Set := Normal_Video; - Color : Color_Pair := Color_Pair'First); + -- | + procedure Set_Foreground + (Men : Menu; + Fore : Character_Attribute_Set := Normal_Video; + Color : Color_Pair := Color_Pair'First); -- AKA: set_menu_fore() pragma Inline (Set_Foreground); - -- #1A NAME="AFU_32"#2| - procedure Foreground (Men : Menu; - Fore : out Character_Attribute_Set); + -- | + procedure Foreground (Men : Menu; + Fore : out Character_Attribute_Set); -- AKA: menu_fore() - -- #1A NAME="AFU_33"#2| - procedure Foreground (Men : Menu; - Fore : out Character_Attribute_Set; - Color : out Color_Pair); + -- | + procedure Foreground (Men : Menu; + Fore : out Character_Attribute_Set; + Color : out Color_Pair); -- AKA: menu_fore() pragma Inline (Foreground); - -- #1A NAME="AFU_34"#2| - procedure Set_Background - (Men : Menu; - Back : Character_Attribute_Set := Normal_Video; - Color : Color_Pair := Color_Pair'First); + -- | + procedure Set_Background + (Men : Menu; + Back : Character_Attribute_Set := Normal_Video; + Color : Color_Pair := Color_Pair'First); -- AKA: set_menu_back() pragma Inline (Set_Background); - -- #1A NAME="AFU_35"#2| - procedure Background (Men : Menu; - Back : out Character_Attribute_Set); + -- | + procedure Background (Men : Menu; + Back : out Character_Attribute_Set); -- AKA: menu_back() - -- #1A NAME="AFU_36"#2| + -- | - procedure Background (Men : Menu; - Back : out Character_Attribute_Set; - Color : out Color_Pair); + procedure Background (Men : Menu; + Back : out Character_Attribute_Set; + Color : out Color_Pair); -- AKA: menu_back() pragma Inline (Background); - -- #1A NAME="AFU_37"#2| - procedure Set_Grey - (Men : Menu; - Grey : Character_Attribute_Set := Normal_Video; - Color : Color_Pair := Color_Pair'First); + -- | + procedure Set_Grey + (Men : Menu; + Grey : Character_Attribute_Set := Normal_Video; + Color : Color_Pair := Color_Pair'First); -- AKA: set_menu_grey() pragma Inline (Set_Grey); - -- #1A NAME="AFU_38"#2| - procedure Grey (Men : Menu; - Grey : out Character_Attribute_Set); + -- | + procedure Grey (Men : Menu; + Grey : out Character_Attribute_Set); -- AKA: menu_grey() - -- #1A NAME="AFU_39"#2| - procedure Grey - (Men : Menu; - Grey : out Character_Attribute_Set; - Color : out Color_Pair); + -- | + procedure Grey + (Men : Menu; + Grey : out Character_Attribute_Set; + Color : out Color_Pair); -- AKA: menu_grey() pragma Inline (Grey); - -- #1A NAME="AFU_40"#2| - procedure Set_Pad_Character (Men : Menu; - Pad : Character := Space); + -- | + procedure Set_Pad_Character (Men : Menu; + Pad : Character := Space); -- AKA: set_menu_pad() pragma Inline (Set_Pad_Character); - -- #1A NAME="AFU_41"#2| - procedure Pad_Character (Men : Menu; - Pad : out Character); + -- | + procedure Pad_Character (Men : Menu; + Pad : out Character); -- AKA: menu_pad() pragma Inline (Pad_Character); @@ -511,19 +511,19 @@ -- | Man page menu_spacing.3x -- |===================================================================== - -- #1A NAME="AFU_42"#2| - procedure Set_Spacing (Men : Menu; - Descr : Column_Position := 0; - Row : Line_Position := 0; - Col : Column_Position := 0); + -- | + procedure Set_Spacing (Men : Menu; + Descr : Column_Position := 0; + Row : Line_Position := 0; + Col : Column_Position := 0); -- AKA: set_menu_spacing() pragma Inline (Set_Spacing); - -- #1A NAME="AFU_43"#2| - procedure Spacing (Men : Menu; - Descr : out Column_Position; - Row : out Line_Position; - Col : out Column_Position); + -- | + procedure Spacing (Men : Menu; + Descr : out Column_Position; + Row : out Line_Position; + Col : out Column_Position); -- AKA: menu_spacing() pragma Inline (Spacing); @@ -531,16 +531,16 @@ -- | Man page menu_pattern.3x -- |===================================================================== - -- #1A NAME="AFU_44"#2| - function Set_Pattern (Men : Menu; - Text : String) return Boolean; + -- | + function Set_Pattern (Men : Menu; + Text : String) return Boolean; -- AKA: set_menu_pattern() -- Return TRUE if the pattern matches, FALSE otherwise pragma Inline (Set_Pattern); - -- #1A NAME="AFU_45"#2| - procedure Pattern (Men : Menu; - Text : out String); + -- | + procedure Pattern (Men : Menu; + Text : out String); -- AKA: menu_pattern() pragma Inline (Pattern); @@ -548,10 +548,10 @@ -- | Man page menu_format.3x -- |===================================================================== - -- #1A NAME="AFU_46"#2| - procedure Set_Format (Men : Menu; - Lines : Line_Count; - Columns : Column_Count); + -- | + procedure Set_Format (Men : Menu; + Lines : Line_Count; + Columns : Column_Count); -- Not implemented: 0 argument for Lines or Columns; -- instead use Format to get the current sizes -- The default format is 16 rows, 1 column. Calling @@ -562,10 +562,10 @@ -- AKA: set_menu_format() pragma Inline (Set_Format); - -- #1A NAME="AFU_47"#2| - procedure Format (Men : Menu; - Lines : out Line_Count; - Columns : out Column_Count); + -- | + procedure Format (Men : Menu; + Lines : out Line_Count; + Columns : out Column_Count); -- AKA: menu_format() pragma Inline (Format); @@ -576,47 +576,47 @@ type Menu_Hook_Function is access procedure (Men : Menu); pragma Convention (C, Menu_Hook_Function); - -- #1A NAME="AFU_48"#2| - procedure Set_Item_Init_Hook (Men : Menu; - Proc : Menu_Hook_Function); + -- | + procedure Set_Item_Init_Hook (Men : Menu; + Proc : Menu_Hook_Function); -- AKA: set_item_init() pragma Inline (Set_Item_Init_Hook); - -- #1A NAME="AFU_49"#2| - procedure Set_Item_Term_Hook (Men : Menu; - Proc : Menu_Hook_Function); + -- | + procedure Set_Item_Term_Hook (Men : Menu; + Proc : Menu_Hook_Function); -- AKA: set_item_term() pragma Inline (Set_Item_Term_Hook); - -- #1A NAME="AFU_50"#2| - procedure Set_Menu_Init_Hook (Men : Menu; - Proc : Menu_Hook_Function); + -- | + procedure Set_Menu_Init_Hook (Men : Menu; + Proc : Menu_Hook_Function); -- AKA: set_menu_init() pragma Inline (Set_Menu_Init_Hook); - -- #1A NAME="AFU_51"#2| - procedure Set_Menu_Term_Hook (Men : Menu; - Proc : Menu_Hook_Function); + -- | + procedure Set_Menu_Term_Hook (Men : Menu; + Proc : Menu_Hook_Function); -- AKA: set_menu_term() pragma Inline (Set_Menu_Term_Hook); - -- #1A NAME="AFU_52"#2| - function Get_Item_Init_Hook (Men : Menu) return Menu_Hook_Function; + -- | + function Get_Item_Init_Hook (Men : Menu) return Menu_Hook_Function; -- AKA: item_init() pragma Inline (Get_Item_Init_Hook); - -- #1A NAME="AFU_53"#2| - function Get_Item_Term_Hook (Men : Menu) return Menu_Hook_Function; + -- | + function Get_Item_Term_Hook (Men : Menu) return Menu_Hook_Function; -- AKA: item_term() pragma Inline (Get_Item_Term_Hook); - -- #1A NAME="AFU_54"#2| - function Get_Menu_Init_Hook (Men : Menu) return Menu_Hook_Function; + -- | + function Get_Menu_Init_Hook (Men : Menu) return Menu_Hook_Function; -- AKA: menu_init() pragma Inline (Get_Menu_Init_Hook); - -- #1A NAME="AFU_55"#2| - function Get_Menu_Term_Hook (Men : Menu) return Menu_Hook_Function; + -- | + function Get_Menu_Term_Hook (Men : Menu) return Menu_Hook_Function; -- AKA: menu_term() pragma Inline (Get_Menu_Term_Hook); @@ -624,9 +624,9 @@ -- | Man page menu_items.3x -- |===================================================================== - -- #1A NAME="AFU_56"#2| - procedure Redefine (Men : Menu; - Items : Item_Array_Access); + -- | + procedure Redefine (Men : Menu; + Items : Item_Array_Access); -- AKA: set_menu_items() pragma Inline (Redefine); @@ -634,14 +634,14 @@ Items : Item_Array_Access) renames Redefine; -- pragma Inline (Set_Items); - -- #1A NAME="AFU_57"#2| - function Items (Men : Menu; - Index : Positive) return Item; + -- | + function Items (Men : Menu; + Index : Positive) return Item; -- AKA: menu_items() pragma Inline (Items); - -- #1A NAME="AFU_58"#2| - function Item_Count (Men : Menu) return Natural; + -- | + function Item_Count (Men : Menu) return Natural; -- AKA: item_count() pragma Inline (Item_Count); @@ -649,15 +649,15 @@ -- | Man page menu_new.3x -- |===================================================================== - -- #1A NAME="AFU_59"#2| - function Create (Items : Item_Array_Access) return Menu; + -- | + function Create (Items : Item_Array_Access) return Menu; -- AKA: new_menu() -- Not inlined function New_Menu (Items : Item_Array_Access) return Menu renames Create; - -- #1A NAME="AFU_60"#2| - procedure Delete (Men : in out Menu); + -- | + procedure Delete (Men : in out Menu); -- AKA: free_menu() -- Reset Men to Null_Menu -- Not inlined @@ -671,13 +671,13 @@ Unknown_Request, No_Match); - -- #1A NAME="AFU_61"#2| - function Driver (Men : Menu; - Key : Key_Code) return Driver_Result; + -- | + function Driver (Men : Menu; + Key : Key_Code) return Driver_Result; -- AKA: menu_driver() -- Driver is not inlined - -- #1A NAME="AFU_62"#2| + -- | -- Not Implemented: menu_request_name, menu_request_by_name ------------------------------------------------------------------------------- private