## Documentation

Table of Contents
Class Inheritance Tree
Widget Screenshots
Package groups

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

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

3.     --                                                                   --

4.     --                Copyright (C) 2001-2010, AdaCore                   --

5.     --                                                                   --

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

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

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

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

10.     --                                                                   --

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

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

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

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

15.     --                                                                   --

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

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

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

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

20.     --                                                                   --

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

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

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

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

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

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

27.     -----------------------------------------------------------------------

29.     --  <description>

30.     --  These functions provide an applications programmer with default

31.     --  images and buttons for toolbars, menu pixmaps, etc.

32.     --

33.     --  See the function Gtk.Widget.Render_Icon for a convenience function that

34.     --  converts a stock icon to an actual pixmap/pixbuf.

35.     --  </description>

36.     --  <c_version>2.16.6</c_version>

38.     with Gdk.TypesTo API docTo spec;

39.     with Gtkada.TypesTo API docTo specTo body;

41.     package Gtk.StockTo API docTo specTo body is

43.        type Gtk_Stock_Item is record

44.           Stock_Id           : Gtkada.Types.Chars_PtrTo API docTo spec;

45.           Label              : Gtkada.Types.Chars_PtrTo API docTo spec;

46.           Modifier           : Gdk.Types.Gdk_Modifier_TypeTo API docTo spec;

47.           Keyval             : Gdk.Types.Gdk_Key_TypeTo API docTo spec;

48.           Translation_Domain : Gtkada.Types.Chars_PtrTo API docTo spec;

49.        end record;

50.        pragma Convention (C, Gtk_Stock_ItemTo API docTo spec);

52.        type Gtk_Stock_Item_Access is access all Gtk_Stock_ItemTo API docTo spec;

53.        pragma Convention (C, Gtk_Stock_Item_AccessTo API docTo spec);

55.        type Gtk_Stock_Item_Array is array (Natural range <>) of Gtk_Stock_ItemTo API docTo spec;

57.        procedure Gtk_NewTo API docTo body

58.          (ItemTo API docTo body               : out Gtk_Stock_ItemTo API docTo spec;

59.           Stock_Id           : String;

60.           Label              : UTF8_StringTo API docTo spec;

61.           Modifier           : Gdk.Types.Gdk_Modifier_TypeTo API docTo spec;

62.           Keyval             : Gdk.Types.Gdk_Key_TypeTo API docTo spec;

63.           Translation_Domain : String);

64.        --  Create a new stock item.

66.        procedure AddTo API docTo body (ItemTo API docTo body : Gtk_Stock_ItemTo API docTo spec);

67.        --  Register Item.

68.        --  If an item already exists with the same stock ID as one of the items,

69.        --  the old item gets replaced. The stock item is copied, so GtkAda does

70.        --  not hold any pointer into item and item can be freed. Use

71.        --  Add_Static if item is persistent and GtkAda need not copy the array.

73.        procedure AddTo API docTo body (Items : Gtk_Stock_Item_ArrayTo API docTo spec);

74.        --  Register each of the stock items in Items.

76.        procedure Add_StaticTo API docTo body (ItemTo API docTo body : Gtk_Stock_ItemTo API docTo spec);

77.        --  Same as Add, but do not copy Item, so Item must persist until

78.        --  application exit.

80.        procedure Add_StaticTo API docTo body (Items : Gtk_Stock_Item_ArrayTo API docTo spec);

81.        --  Same as Add, but do not copy Items, so Items must persist until

82.        --  application exit.

84.        procedure LookupTo API docTo body

85.          (Stock_Id : String;

86.           ItemTo API docTo body     : out Gtk_Stock_ItemTo API docTo spec;

87.           Success  : out Boolean);

88.        --  Fill Item with the registered values for Stock_Id.

89.        --  Success if set to True of Stock_Id was known.

91.        procedure FreeTo API docTo body (ItemTo API docTo body : in out Gtk_Stock_ItemTo API docTo spec);

92.        --  Free memory allocated in Item.

94.        --  Stock IDs (not all are stock items; some are images only)

96.        Stock_Dialog_Authentication : aliased constant String :=

97.          "gtk-dialog-authentication";

98.        Stock_Dialog_Info      : aliased constant String := "gtk-dialog-info";

99.        Stock_Dialog_Warning   : aliased constant String := "gtk-dialog-warning";

100.        Stock_Dialog_Error     : aliased constant String := "gtk-dialog-error";

101.        Stock_Dialog_Question  : aliased constant String := "gtk-dialog-question";

103.        Stock_Dnd              : aliased constant String := "gtk-dnd";

104.        Stock_Dnd_Multiple     : aliased constant String := "gtk-dnd-multiple";

106.        Stock_About            : aliased constant String := "gtk-about";

107.        Stock_Add              : aliased constant String := "gtk-add";

108.        Stock_Apply            : aliased constant String := "gtk-apply";

109.        Stock_Bold             : aliased constant String := "gtk-bold";

110.        Stock_Cancel           : aliased constant String := "gtk-cancel";

111.        Stock_Caps_Lock_Warning : aliased constant String :=

112.          "gtk-caps-lock-warning";

113.        Stock_Cdrom            : aliased constant String := "gtk-cdrom";

114.        Stock_Clear            : aliased constant String := "gtk-clear";

115.        Stock_Close            : aliased constant String := "gtk-close";

116.        Stock_Color_Picker     : aliased constant String := "gtk-color-picker";

117.        Stock_Convert          : aliased constant String := "gtk-convert";

118.        Stock_Connect          : aliased constant String := "gtk-connect";

119.        Stock_Copy             : aliased constant String := "gtk-copy";

120.        Stock_Cut              : aliased constant String := "gtk-cut";

121.        Stock_Delete           : aliased constant String := "gtk-delete";

122.        Stock_Directory        : aliased constant String := "gtk-directory";

123.        Stock_Discard          : aliased constant String := "gtk-discard";

124.        Stock_Disconnect       : aliased constant String := "gtk-disconnect";

125.        Stock_Edit             : aliased constant String := "gtk-edit";

126.        Stock_Execute          : aliased constant String := "gtk-execute";

127.        Stock_File             : aliased constant String := "gtk-file";

128.        Stock_Find             : aliased constant String := "gtk-find";

129.        Stock_Find_And_Replace : aliased constant String := "gtk-find-and-replace";

130.        Stock_Floppy           : aliased constant String := "gtk-floppy";

131.        Stock_Fullscreen       : aliased constant String := "gtk-fullscreen";

132.        Stock_Goto_Bottom      : aliased constant String := "gtk-goto-bottom";

133.        Stock_Goto_First       : aliased constant String := "gtk-goto-first";

134.        Stock_Goto_Last        : aliased constant String := "gtk-goto-last";

135.        Stock_Goto_Top         : aliased constant String := "gtk-goto-top";

136.        Stock_Go_Back          : aliased constant String := "gtk-go-back";

137.        Stock_Go_Down          : aliased constant String := "gtk-go-down";

138.        Stock_Go_Forward       : aliased constant String := "gtk-go-forward";

139.        Stock_Go_Up            : aliased constant String := "gtk-go-up";

140.        Stock_Harddisk         : aliased constant String := "gtk-harddisk";

141.        Stock_Help             : aliased constant String := "gtk-help";

142.        Stock_Home             : aliased constant String := "gtk-home";

143.        Stock_Index            : aliased constant String := "gtk-index";

144.        Stock_Indent           : aliased constant String := "gtk-indent";

145.        Stock_Info             : aliased constant String := "gtk-info";

146.        Stock_Unindent         : aliased constant String := "gtk-unindent";

147.        Stock_Italic           : aliased constant String := "gtk-italic";

148.        Stock_Jump_To          : aliased constant String := "gtk-jump-to";

149.        Stock_Justify_Center   : aliased constant String := "gtk-justify-center";

150.        Stock_Justify_Fill     : aliased constant String := "gtk-justify-fill";

151.        Stock_Justify_Left     : aliased constant String := "gtk-justify-left";

152.        Stock_Justify_Right    : aliased constant String := "gtk-justify-right";

153.        Stock_Leave_Fullscreen : aliased constant String := "gtk-leave-fullscreen";

154.        Stock_Missing_Image    : aliased constant String := "gtk-missing-image";

155.        Stock_Media_Forward    : aliased constant String := "gtk-media-forward";

156.        Stock_Media_Next       : aliased constant String := "gtk-media-next";

157.        Stock_Media_Pause      : aliased constant String := "gtk-media-pause";

158.        Stock_Media_Play       : aliased constant String := "gtk-media-play";

159.        Stock_Media_Previous   : aliased constant String := "gtk-media-previous";

160.        Stock_Media_Record     : aliased constant String := "gtk-media-record";

161.        Stock_Media_Rewind     : aliased constant String := "gtk-media-rewind";

162.        Stock_Media_Stop       : aliased constant String := "gtk-media-stop";

163.        Stock_Network          : aliased constant String := "gtk-network";

164.        Stock_New              : aliased constant String := "gtk-new";

165.        Stock_No               : aliased constant String := "gtk-no";

166.        Stock_Ok               : aliased constant String := "gtk-ok";

167.        Stock_Open             : aliased constant String := "gtk-open";

168.        Stock_Orientation_Portrait          : aliased constant String :=

169.          "gtk-orientation-portrait";

170.        Stock_Orientation_Landscape         : aliased constant String :=

171.          "gtk-orientation-landscape";

172.        Stock_Orientation_Reverse_Landscape : aliased constant String :=

173.          "gtk-orientation-reverse-landscape";

174.        Stock_Orientation_Reverse_Portrait  : aliased constant String :=

175.          "gtk-orientation-reverse-portrait";

176.        Stock_Page_Setup       : aliased constant String := "gtk-page-setup";

177.        Stock_Paste            : aliased constant String := "gtk-paste";

178.        Stock_Preferences      : aliased constant String := "gtk-preferences";

179.        Stock_Print            : aliased constant String := "gtk-print";

180.        Stock_Print_Error      : aliased constant String := "gtk-print-error";

181.        Stock_Print_Paused     : aliased constant String := "gtk-print-paused";

182.        Stock_Print_Preview    : aliased constant String := "gtk-print-preview";

183.        Stock_Print_Report     : aliased constant String := "gtk-print-report";

184.        Stock_Print_Warning    : aliased constant String := "gtk-print-warning";

185.        Stock_Properties       : aliased constant String := "gtk-properties";

186.        Stock_Quit             : aliased constant String := "gtk-quit";

187.        Stock_Redo             : aliased constant String := "gtk-redo";

188.        Stock_Refresh          : aliased constant String := "gtk-refresh";

189.        Stock_Remove           : aliased constant String := "gtk-remove";

190.        Stock_Revert_To_Saved  : aliased constant String := "gtk-revert-to-saved";

191.        Stock_Save             : aliased constant String := "gtk-save";

192.        Stock_Save_As          : aliased constant String := "gtk-save-as";

193.        Stock_Select_All       : aliased constant String := "gtk-select-all";

194.        Stock_Select_Color     : aliased constant String := "gtk-select-color";

195.        Stock_Select_Font      : aliased constant String := "gtk-select-font";

196.        Stock_Sort_Ascending   : aliased constant String := "gtk-sort-ascending";

197.        Stock_Sort_Descending  : aliased constant String := "gtk-sort-descending";

198.        Stock_Spell_Check      : aliased constant String := "gtk-spell-check";

199.        Stock_Stop             : aliased constant String := "gtk-stop";

200.        Stock_Strikethrough    : aliased constant String := "gtk-strikethrough";

201.        Stock_Undelete         : aliased constant String := "gtk-undelete";

202.        Stock_Underline        : aliased constant String := "gtk-underline";

203.        Stock_Undo             : aliased constant String := "gtk-undo";

204.        Stock_Yes              : aliased constant String := "gtk-yes";

205.        Stock_Zoom_100         : aliased constant String := "gtk-zoom-100";

206.        Stock_Zoom_Fit         : aliased constant String := "gtk-zoom-fit";

207.        Stock_Zoom_In          : aliased constant String := "gtk-zoom-in";

208.        Stock_Zoom_Out         : aliased constant String := "gtk-zoom-out";

210.        --  No binding: gtk_stock_list_ids

211.        --  No binding: gtk_stock_item_free

212.        --  No binding: gtk_stock_item_copy

213.        --  No binding: gtk_stock_set_translate_func

214.     end Gtk.StockTo API docTo specTo body;