## Documentation

Table of Contents
Class Inheritance Tree
Widget Screenshots
Package groups

1.     -----------------------------------------------------------------------

2.     --               GtkAda - Ada95 binding for Gtk+/Gnome               --

3.     --                                                                   --

4.     --   Copyright (C) 1998-2000 E. Briot, J. Brobecker and A. Charlet   --

5.     --                Copyright (C) 2000-2007 AdaCore                    --

6.     --                                                                   --

7.     -- This library is free software; you can redistribute it and/or     --

8.     -- modify it under the terms of the GNU General Public               --

9.     -- License as published by the Free Software Foundation; either      --

10.     -- version 2 of the License, or (at your option) any later version.  --

11.     --                                                                   --

12.     -- This library is distributed in the hope that it will be useful,   --

13.     -- but WITHOUT ANY WARRANTY; without even the implied warranty of    --

14.     -- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU --

15.     -- General Public License for more details.                          --

16.     --                                                                   --

17.     -- You should have received a copy of the GNU General Public         --

18.     -- License along with this library; if not, write to the             --

19.     -- Free Software Foundation, Inc., 59 Temple Place - Suite 330,      --

20.     -- Boston, MA 02111-1307, USA.                                       --

21.     --                                                                   --

22.     -- As a special exception, if other files instantiate generics from  --

23.     -- this unit, or you link this unit with other files to produce an   --

24.     -- executable, this  unit  does not  by itself cause  the resulting  --

25.     -- executable to be covered by the GNU General Public License. This  --

26.     -- exception does not however invalidate any other reasons why the   --

27.     -- executable file  might be covered by the  GNU Public License.     --

28.     -----------------------------------------------------------------------

30.     --  <description>

31.     --  This widget provides a special kind of menu item that represents a

32.     --  radio button. Such a button can be checked or unchecked by the user, but

33.     --  only one button in a group can be selected at any given time, as opposed to

34.     --  a toggle menu item.

35.     --  </description>

36.     --  <c_version>2.8.17</c_version>

37.     --  <group>Menus and Toolbars</group>

39.     with Glib.PropertiesTo API docTo specTo body;

40.     with Gtk.Check_Menu_ItemTo API docTo specTo body;

41.     with Gtk.WidgetTo API docTo specTo body; use Gtk.WidgetTo API docTo specTo body;

43.     package Gtk.Radio_Menu_ItemTo API docTo specTo body is

45.        type Gtk_Radio_Menu_Item_RecordTo API docTo body is new

46.          Gtk.Check_Menu_Item.Gtk_Check_Menu_Item_RecordTo API docTo specTo body with private;

47.        type Gtk_Radio_Menu_Item is access all Gtk_Radio_Menu_Item_RecordTo API docTo specTo body'Class;

49.        procedure Gtk_NewTo API docTo body

50.          (Radio_Menu_Item : out Gtk_Radio_Menu_ItemTo API docTo spec;

51.           GroupTo API docTo body           : Widget_SList.GSlistTo API docTo specTo body;

52.           Label           : UTF8_StringTo API docTo spec := "");

53.        procedure InitializeTo API docTo body

54.          (Radio_Menu_Item : access Gtk_Radio_Menu_Item_RecordTo API docTo specTo body'Class;

55.           GroupTo API docTo body           : Widget_SList.GSlistTo API docTo specTo body;

56.           Label           : UTF8_StringTo API docTo spec := "");

57.        --  Creates or initializes a menu item

59.        procedure Gtk_New_With_MnemonicTo API docTo body

60.          (Radio_Menu_Item : out Gtk_Radio_Menu_ItemTo API docTo spec;

61.           GroupTo API docTo body           : Widget_SList.GSlistTo API docTo specTo body;

62.           Label           : UTF8_StringTo API docTo spec);

63.        procedure Initialize_With_MnemonicTo API docTo body

64.          (Radio_Menu_Item : access Gtk_Radio_Menu_Item_RecordTo API docTo specTo body'Class;

65.           GroupTo API docTo body           : Widget_SList.GSlistTo API docTo specTo body;

66.           Label           : UTF8_StringTo API docTo spec);

67.        --  Creates or initializes a menu item.

68.        --  The first underscore sign in Label will be used as a key shortcut to

69.        --  this item when the menu is displayed. For instance, if you use "_Open",

70.        --  then pressing alt-o when the menu is open will select the menu item

72.        procedure Gtk_New_From_WidgetTo API docTo body

73.          (Radio_Menu_Item : out Gtk_Radio_Menu_ItemTo API docTo spec;

74.           Group           : access Gtk_Radio_Menu_Item_RecordTo API docTo specTo body'Class);

75.        procedure Initialize_From_WidgetTo API docTo body

76.          (Radio_Menu_Item : access Gtk_Radio_Menu_Item_RecordTo API docTo specTo body'Class;

77.           Group           : access Gtk_Radio_Menu_Item_RecordTo API docTo specTo body'Class);

78.        --  Creates or initializes a menu item. It initially belongs to the same

79.        --  group as Group

81.        procedure Gtk_New_With_Label_From_WidgetTo API docTo body

82.          (Radio_Menu_Item : out Gtk_Radio_Menu_ItemTo API docTo spec;

83.           Group           : access Gtk_Radio_Menu_Item_RecordTo API docTo specTo body'Class;

84.           Label           : String);

85.        procedure Initialize_With_Label_From_WidgetTo API docTo body

86.          (Radio_Menu_Item : access Gtk_Radio_Menu_Item_RecordTo API docTo specTo body'Class;

87.           Group           : access Gtk_Radio_Menu_Item_RecordTo API docTo specTo body'Class;

88.           Label           : String);

89.        --  Creates or initializes a menu item. It initially belongs to the same

90.        --  group as Group.

92.        procedure Gtk_New_With_Mnemonic_From_WidgetTo API docTo body

93.          (Radio_Menu_Item : out Gtk_Radio_Menu_ItemTo API docTo spec;

94.           Group           : access Gtk_Radio_Menu_Item_RecordTo API docTo specTo body'Class;

95.           Label           : String);

96.        procedure Initialize_With_Mnemonic_From_WidgetTo API docTo body

97.          (Radio_Menu_Item : access Gtk_Radio_Menu_Item_RecordTo API docTo specTo body'Class;

98.           Group           : access Gtk_Radio_Menu_Item_RecordTo API docTo specTo body'Class;

99.           Label           : String);

100.        --  Same as Gtk_New_With_Mnemonic, except the group is given by a widget

102.        function Get_TypeTo API docTo body return Gtk.Gtk_TypeTo API docTo spec;

103.        --  Return the internal value associated with a Gtk_Radio_Menu_Item.

105.        procedure Set_GroupTo API docTo body

106.          (Radio_Menu_Item : access Gtk_Radio_Menu_Item_RecordTo API docTo specTo body;

107.           GroupTo API docTo body           : Widget_SList.GSlistTo API docTo specTo body);

108.        function Get_GroupTo API docTo body

109.          (Radio_Menu_Item : access Gtk_Radio_Menu_Item_RecordTo API docTo specTo body)

110.           return Widget_SList.GSlistTo API docTo specTo body;

111.        --  Set or Get to which the menu item belongs. Only one menu item in this

112.        --  group can be selected at any given time

114.        function Selected_ButtonTo API docTo body (In_GroupTo API docTo body : Widget_SList.GSlistTo API docTo specTo body) return Natural;

115.        --  Return the button number of the selected button in the group.

116.        --  Note: This function is not part of Gtk+ itself, but is provided as a

117.        --  convenient function

119.        -----------------

120.        -- Obsolescent --

121.        -----------------

122.        --  All subprograms below are now obsolescent in gtk+. They might be removed

123.        --  from future versions of gtk+ (and therefore GtkAda).

124.        --  To find out whether your code uses any of these, we recommend compiling

125.        --  with the -gnatwj switch

126.        --  <doc_ignore>

128.        function Group

129.          (Radio_Menu_Item : access Gtk_Radio_Menu_Item_RecordTo API docTo specTo body)

130.           return Widget_SList.GSlistTo API docTo specTo body renames Get_GroupTo API docTo specTo body;

131.        --  pragma Obsolescent;

132.        --  This function is deprecated. Get_Group should be used instead.

134.        --  </doc_ignore>

136.        -------------

137.        -- Signals --

138.        -------------

140.        --  <signals>

141.        --  The following new signals are defined for this widget:

142.        --

143.        --  - "group-changed"

144.        --    procedure Handler (Item : access Gtk_Radio_Menu_Item_Record'Class);

145.        --    Emitted when the group of Item has been changed.

146.        --

147.        --  </signals>

149.        Signal_Group_Changed : constant Glib.Signal_NameTo API docTo spec := "group-changed";

151.        ----------------

152.        -- Properties --

153.        ----------------

155.        --  <properties>

156.        --  The following properties are defined for this widget. See

157.        --  Glib.Properties for more information on properties.

158.        --

159.        --  Name:  Group_Property

160.        --  Type:  Object

161.        --  Descr: The radio menu item whose group this widget belongs to.

162.        --

163.        --  </properties>

165.        Group_Property : constant Glib.Properties.Property_ObjectTo API docTo spec;

167.     private

168.        type Gtk_Radio_Menu_Item_RecordTo API docTo spec is new

169.          Gtk.Check_Menu_Item.Gtk_Check_Menu_Item_RecordTo API docTo specTo body with null record;

171.        Group_PropertyTo API docTo spec : constant Glib.Properties.Property_ObjectTo API docTo spec :=

172.          Glib.Properties.BuildTo API docTo specTo body ("group");

174.        pragma Import (C, Get_TypeTo API docTo spec, "gtk_radio_menu_item_get_type");

175.     end Gtk.Radio_Menu_ItemTo API docTo specTo body;