/usr/share/ada/adainclude/gtkada/gtk-handlers.ads is in libgtkada2.24.1-dev 2.24.1-14.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 | -----------------------------------------------------------------------
-- GtkAda - Ada95 binding for Gtk+/Gnome --
-- --
-- Copyright (C) 1998-2000 E. Briot, J. Brobecker and A. Charlet --
-- Copyright (C) 2000-2009, AdaCore --
-- --
-- This library is free software; you can redistribute it and/or --
-- modify it under the terms of the GNU General Public --
-- License as published by the Free Software Foundation; either --
-- version 2 of the License, or (at your option) any later version. --
-- --
-- This library is distributed in the hope that it will be useful, --
-- but WITHOUT ANY WARRANTY; without even the implied warranty of --
-- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU --
-- General Public License for more details. --
-- --
-- You should have received a copy of the GNU General Public --
-- License along with this library; if not, write to the --
-- Free Software Foundation, Inc., 59 Temple Place - Suite 330, --
-- Boston, MA 02111-1307, USA. --
-- --
-----------------------------------------------------------------------
-- <description>
--
-- The aim of this package is to provide some services to connect a
-- handler to a signal emitted by a Gtk Object. To understand the
-- services provided by this package, some definitions are necessary:
--
-- Signal: A signal is a kind of message that an object wants to
-- broadcast. All GObjects can emit signals. These messages are
-- associated to certain events happening during the life of an
-- object. For instance, when a user clicks on a button, the
-- "clicked" signal is emitted by the button.
--
-- Handler (or callback): A handler is a function or procedure that
-- the user "connects" to a signal for a particular object.
-- Connecting a handler to a signal means associating this handler to
-- the signal. When the signal is emitted, all connected handlers
-- are called back. Usually, the role of those callbacks is to do
-- some processing triggered by a user action. For instance, when
-- "clicked" signal is emitted by the "OK" button of a dialog, the
-- connected handler can be used to close the dialog or recompute
-- some value.
--
-- In GtkAda, the handlers are defined in a form as general as
-- possible. The first argument is always an access to the object it
-- has been connected to. The second object is a table of values
-- (See Glib.Values for more details about this table). It is the
-- responsibility of this handler to extract the values from it, and
-- to convert them to the correct Ada type.
--
-- Because such handlers are not very convenient to use, this package
-- also provides some services to connect a marshaller instead. It
-- will then do the extraction work before calling the more
-- programmer-friendly handler, as defined in Gtk.Marshallers (see
-- Gtk.Marshallers for more details).
--
-- The subdivision of this package is identical to Gtk.Marshallers; it
-- is made of four generic sub-packages, each representing one of the
-- four possible kinds of handlers: they can return a value or not, and
-- they can have some user specific data associated to them or not.
-- Selecting the right package depends on the profile of the handler.
-- For example, the handler for the "delete_event" signal of a
-- Gtk_Window has a return value, and has an extra parameter (a Gint).
-- All handlers also have a user_data field by default, but its usage
-- is optional. To connect a handler to this signal, if the user_data
-- field is not used, the Return_Callback generic should be
-- instantiated. On the other hand, if the user_data field is
-- necessary, then the User_Return_Callback generic should be used.
--
-- Note also that the real handler in Gtk+ should expect at least as
-- many arguments as in the marshaller you are using. If your
-- marshaller has one argument, the C handler must have at least one
-- argument too.
--
-- The common generic parameter to all sub-packages is the widget type,
-- which is the basic widget manipulated. This can be
-- Glib.Object.GObject_Record type if you want to reduce the number of
-- instantiations, but the conversion to the original type will have to be
-- done inside the handler.
--
-- All sub-packages are organized in the same way.
--
-- First, the type "Handler" is defined. It represents the general
-- form of the callbacks supported by the sub-package.
--
-- The corresponding sub-package of Gtk.Marshallers is instantiated.
--
-- A series of "Connect" procedures and functions is given. All cases
-- are covered: the functions return the Handler_Id of the newly
-- created association, while the procedures just connect the
-- handler, dropping the Handler_Id; some services allow the user to
-- connect a Handler while some others allow the usage of
-- Marshallers, which are more convenient. Note that more than one
-- handler may be connected to a signal; the handlers will then be
-- invoked in the order of connection.
--
-- Some "Connect_Object" services are also provided. Those services
-- never have a user_data. They accept an additional parameter called
-- Slot_Object. When the callback in invoked, the Gtk Object emitting
-- the signal is substituted by this Slot_Object.
-- These callbacks are always automatically disconnected as soon as one
-- of the two widgets involved is destroyed.
--
-- There are several methods to connect a handler. For each method,
-- although the option of connecting a Handler is provided, the
-- recommended way is to use Marshallers. Each connect service is
-- documented below, in the first sub-package.
--
-- A series of "To_Marshaller" functions are provided. They return
-- some marshallers for the most commonly used types in order to ease
-- the usage of this package. Most of the time, it will not be
-- necessary to use some other marshallers.
-- For instance, if a signal is documented as receiving a single argument,
-- the widget (for instance the "clicked" signal for a Gtk_Button), you
-- will connect to it with:
-- with Gtkada.Handlers;
-- procedure On_Clicked (Button : access Gtk_Widget_Record'Class);
-- ...
-- Widget_Callback.Connect (Button, "clicked", On_Clicked'Access);
--
-- The simple form above also applies for most handlers that take one
-- additional argument, for instance the "button_press_event" in
-- gtk-widget.ads. Just declare your subprogram with the appropriate profile
-- and connect it, as in:
-- with Gtkada.Handlers;
-- procedure On_Button (Widget : access Gtk_Widget_Record'Class;
-- Event : Gdk_Event);
-- ...
-- Widget_Callback.Connect (Widget, "button_press_event",
-- On_Button'Access);
--
-- More complex forms of handlers exists however in GtkAda, for which no
-- predefined marshaller exists. In this case, you have to use the general
-- form of callbacks. For instance, the "select_row" signal of Gtk.Clist.
-- with Gtkada.Handlers;
-- with Gtk.Arguments;
-- procedure On_Select (Clist : access Gtk_Widget_Record'Class;
-- Args : Glib.Values.GValues)
-- is
-- Row : constant Gint := To_Gint (Args, 1);
-- Column : constant Gint := To_Gint (Args, 2);
-- Event : constant Gdk_Event := To_Event (Args, 3);
-- begin
-- ...
-- end On_Select;
-- ...
-- Widget_Callback.Connect (Clist, "select_row", On_Select'Access);
--
-- As for the "To_Marshaller" functions, a series of "Emit_By_Name"
-- procedures are also provided for the same most common types, to
-- allow the user to easily emit signals. These procedures are mainly
-- intended for people building new GObjects.
--
-- At the end of this package, some general services related to the
-- management of signals and handlers are also provided. Each one of
-- them is documented individually below.
--
-- IMPORTANT NOTE: These packages must be instantiated at library-level
--
-- </description>
-- <c_version>2.8.17</c_version>
-- <group>Signal handling</group>
with Glib.Values;
with Gdk.Event;
with Glib.Object;
with Gtk.Marshallers;
pragma Elaborate_All (Gtk.Marshallers);
with Gtk.Notebook;
with Gtk.Tree_Model;
with Gtk.Widget;
with Unchecked_Conversion;
package Gtk.Handlers is
-- <doc_ignore>
pragma Elaborate_Body;
type GClosure is new Glib.C_Proxy;
Null_Handler_Id : constant Gulong := 0;
type Handler_Id is record
Id : Gulong := Null_Handler_Id;
Closure : GClosure;
end record;
-- This uniquely identifies a connection widget<->signal.
-- Closure is an internal data, that you should not use.
---------------------------------------------------------
-- These handlers should return a value
-- They do not have a User_Data
---------------------------------------------------------
generic
type Widget_Type is new Glib.Object.GObject_Record with private;
type Return_Type is (<>);
package Return_Callback is
type Handler is access function
(Widget : access Widget_Type'Class;
Params : Glib.Values.GValues) return Return_Type;
type Simple_Handler is access function
(Widget : access Widget_Type'Class) return Return_Type;
package Marshallers is new Gtk.Marshallers.Return_Marshallers
(Widget_Type, Return_Type);
-- Connecting a handler to an object
-- In all the Connect services below, the following arguments
-- will be used:
-- o Widget, Name: This represents the association (Gtk Object,
-- Glib.Signal_Name) to which the handler is to be connected.
-- o After: If this boolean is set to True, then the handler
-- will be connected after all the default handlers. By
-- default, it is set to False.
procedure Connect
(Widget : access Widget_Type'Class;
Name : Glib.Signal_Name;
Marsh : Marshallers.Marshaller;
After : Boolean := False);
-- Connects a Marshaller. The Handler_Id is dropped.
procedure Object_Connect
(Widget : access Glib.Object.GObject_Record'Class;
Name : Glib.Signal_Name;
Marsh : Marshallers.Marshaller;
Slot_Object : access Widget_Type'Class;
After : Boolean := False);
-- Connect a Marshaller. The Handler_Id is dropped.
-- This is automatically disconnected as soon as either Widget or
-- Slot_Object is destroyed.
-- Slot_Object *must* be of type Gtk_Object or one of its children.
procedure Connect
(Widget : access Widget_Type'Class;
Name : Glib.Signal_Name;
Cb : Simple_Handler;
After : Boolean := False);
procedure Object_Connect
(Widget : access Glib.Object.GObject_Record'Class;
Name : Glib.Signal_Name;
Cb : Simple_Handler;
Slot_Object : access Widget_Type'Class;
After : Boolean := False);
-- Same as above, except with a simple handle with no parameter. This
-- is the same as using a To_Marshaller call to the above two
-- procedures, except it is shorter to write.
procedure Connect
(Widget : access Widget_Type'Class;
Name : Glib.Signal_Name;
Cb : Handler;
After : Boolean := False);
procedure Object_Connect
(Widget : access Glib.Object.GObject_Record'Class;
Name : Glib.Signal_Name;
Cb : Handler;
Slot_Object : access Widget_Type'Class;
After : Boolean := False);
-- Connect a Handler. The Handler_Id is dropped.
-- This is automatically disconnected as soon as either Widget or
-- Slot_Object is destroyed.
-- Slot_Object *must* be of type Gtk_Object or one of its children.
pragma Inline (Connect);
pragma Inline (Object_Connect);
function Connect
(Widget : access Widget_Type'Class;
Name : Glib.Signal_Name;
Marsh : Marshallers.Marshaller;
After : Boolean := False) return Handler_Id;
-- Connects a Marshaller. Returns the Handler_Id.
function Object_Connect
(Widget : access Glib.Object.GObject_Record'Class;
Name : Glib.Signal_Name;
Marsh : Marshallers.Marshaller;
Slot_Object : access Widget_Type'Class;
After : Boolean := False) return Handler_Id;
-- Connect a Marshaller. Return the Handler_Id.
-- This is automatically disconnected as soon as either Widget or
-- Slot_Object is destroyed.
-- Slot_Object *must* be of type Gtk_Object or one of its children.
function Connect
(Widget : access Widget_Type'Class;
Name : Glib.Signal_Name;
Cb : Handler;
After : Boolean := False) return Handler_Id;
-- Connects a Handler. Returns the Handler_Id.
function Object_Connect
(Widget : access Glib.Object.GObject_Record'Class;
Name : Glib.Signal_Name;
Cb : Handler;
Slot_Object : access Widget_Type'Class;
After : Boolean := False) return Handler_Id;
-- Connect a Handler. Returns the Handler_Id.
-- This is automatically disconnected as soon as either Widget or
-- Slot_Object is destroyed.
-- Slot_Object *must* be of type Gtk_Object or one of its children.
-- Some convenient functions to create marshallers
package Gint_Marshaller is new Marshallers.Generic_Marshaller
(Gint, Glib.Values.Get_Int);
package Guint_Marshaller is new Marshallers.Generic_Marshaller
(Guint, Glib.Values.Get_Uint);
package Event_Marshaller is new Marshallers.Generic_Marshaller
(Gdk.Event.Gdk_Event, Gdk.Event.Get_Event);
package Widget_Marshaller is new Marshallers.Generic_Widget_Marshaller
(Gtk.Widget.Gtk_Widget_Record, Gtk.Widget.Gtk_Widget);
package Notebook_Page_Marshaller is new Marshallers.Generic_Marshaller
(Gtk.Notebook.Gtk_Notebook_Page, Gtk.Notebook.Get_Notebook_Page);
function To_Marshaller
(Cb : Gint_Marshaller.Handler)
return Marshallers.Marshaller renames Gint_Marshaller.To_Marshaller;
function To_Marshaller
(Cb : Guint_Marshaller.Handler)
return Marshallers.Marshaller renames Guint_Marshaller.To_Marshaller;
function To_Marshaller
(Cb : Event_Marshaller.Handler)
return Marshallers.Marshaller renames Event_Marshaller.To_Marshaller;
function To_Marshaller
(Cb : Widget_Marshaller.Handler)
return Marshallers.Marshaller renames Widget_Marshaller.To_Marshaller;
function To_Marshaller
(Cb : Marshallers.Void_Marshaller.Handler)
return Marshallers.Marshaller
renames Marshallers.Void_Marshaller.To_Marshaller;
function To_Marshaller
(Cb : Notebook_Page_Marshaller.Handler)
return Marshallers.Marshaller
renames Notebook_Page_Marshaller.To_Marshaller;
-- Emitting a signal
function Emit_By_Name
(Object : access Widget_Type'Class;
Name : Glib.Signal_Name;
Param : Gint)
return Return_Type renames Gint_Marshaller.Emit_By_Name;
function Emit_By_Name
(Object : access Widget_Type'Class;
Name : Glib.Signal_Name;
Param : Guint)
return Return_Type renames Guint_Marshaller.Emit_By_Name;
function Emit_By_Name
(Object : access Widget_Type'Class;
Name : Glib.Signal_Name;
Param : Gdk.Event.Gdk_Event) return Return_Type;
function Emit_By_Name
(Object : access Widget_Type'Class;
Name : Glib.Signal_Name;
Param : access Gtk.Widget.Gtk_Widget_Record'Class)
return Return_Type renames Widget_Marshaller.Emit_By_Name;
function Emit_By_Name
(Object : access Widget_Type'Class;
Name : Glib.Signal_Name)
return Return_Type renames Marshallers.Void_Marshaller.Emit_By_Name;
function Emit_By_Name
(Object : access Widget_Type'Class;
Name : Glib.Signal_Name;
Param : Gtk.Notebook.Gtk_Notebook_Page)
return Return_Type renames Notebook_Page_Marshaller.Emit_By_Name;
private
-- <doc_ignore>
type Acc is access all Widget_Type'Class;
-- This type has to be declared at library level, otherwise
-- Program_Error might be raised when trying to cast from the
-- parameter of Marshaller to another type.
type Data_Type_Record is record
Func : Handler;
-- User's callback
Proxy : Marshallers.Handler_Proxy := null;
-- Handler_Proxy to use
Object : Acc := null;
-- Slot Object for Object_Connect
end record;
type Data_Type_Access is access all Data_Type_Record;
pragma Convention (C, Data_Type_Access);
-- Data passed to the C handler
function Convert is new Unchecked_Conversion
(Data_Type_Access, System.Address);
function Convert is new Unchecked_Conversion
(System.Address, Data_Type_Access);
procedure Free_Data (Data : Data_Type_Access);
pragma Convention (C, Free_Data);
-- Free the memory associated with the callback's data
procedure First_Marshaller
(Closure : GClosure;
Return_Value : Glib.Values.GValue;
N_Params : Guint;
Params : System.Address;
Invocation_Hint : System.Address;
User_Data : System.Address);
pragma Convention (C, First_Marshaller);
-- First level marshaller. This is the function that is actually
-- called by gtk+. It then calls the Ada functions as required.
-- </doc_ignore>
end Return_Callback;
---------------------------------------------------------
-- These handlers should return a value
-- They require a User_Data
-- See also the package User_Callback_With_Setup
---------------------------------------------------------
generic
type Widget_Type is new Glib.Object.GObject_Record with private;
type Return_Type is (<>);
type User_Type (<>) is private;
package User_Return_Callback is
type Handler is access function
(Widget : access Widget_Type'Class;
Params : Glib.Values.GValues;
User_Data : User_Type) return Return_Type;
type Simple_Handler is access function
(Widget : access Widget_Type'Class;
User_Data : User_Type) return Return_Type;
package Marshallers is new Gtk.Marshallers.User_Return_Marshallers
(Widget_Type, Return_Type, User_Type);
-- Connecting a handler to an object
procedure Connect
(Widget : access Widget_Type'Class;
Name : Glib.Signal_Name;
Marsh : Marshallers.Marshaller;
User_Data : User_Type;
After : Boolean := False);
procedure Object_Connect
(Widget : access Glib.Object.GObject_Record'Class;
Name : Glib.Signal_Name;
Marsh : Marshallers.Marshaller;
Slot_Object : access Widget_Type'Class;
User_Data : User_Type;
After : Boolean := False);
procedure Connect
(Widget : access Widget_Type'Class;
Name : Glib.Signal_Name;
Cb : Simple_Handler;
User_Data : User_Type;
After : Boolean := False);
procedure Object_Connect
(Widget : access Glib.Object.GObject_Record'Class;
Name : Glib.Signal_Name;
Cb : Simple_Handler;
Slot_Object : access Widget_Type'Class;
User_Data : User_Type;
After : Boolean := False);
procedure Connect
(Widget : access Widget_Type'Class;
Name : Glib.Signal_Name;
Cb : Handler;
User_Data : User_Type;
After : Boolean := False);
procedure Object_Connect
(Widget : access Glib.Object.GObject_Record'Class;
Name : Glib.Signal_Name;
Cb : Handler;
Slot_Object : access Widget_Type'Class;
User_Data : User_Type;
After : Boolean := False);
pragma Inline (Connect);
function Connect
(Widget : access Widget_Type'Class;
Name : Glib.Signal_Name;
Marsh : Marshallers.Marshaller;
User_Data : User_Type;
After : Boolean := False) return Handler_Id;
function Object_Connect
(Widget : access Glib.Object.GObject_Record'Class;
Name : Glib.Signal_Name;
Marsh : Marshallers.Marshaller;
Slot_Object : access Widget_Type'Class;
User_Data : User_Type;
After : Boolean := False) return Handler_Id;
function Connect
(Widget : access Widget_Type'Class;
Name : Glib.Signal_Name;
Cb : Handler;
User_Data : User_Type;
After : Boolean := False) return Handler_Id;
function Object_Connect
(Widget : access Glib.Object.GObject_Record'Class;
Name : Glib.Signal_Name;
Cb : Handler;
Slot_Object : access Widget_Type'Class;
User_Data : User_Type;
After : Boolean := False) return Handler_Id;
-- Some convenient functions to create marshallers
package Gint_Marshaller is new Marshallers.Generic_Marshaller
(Gint, Glib.Values.Get_Int);
package Guint_Marshaller is new Marshallers.Generic_Marshaller
(Guint, Glib.Values.Get_Uint);
package Event_Marshaller is new Marshallers.Generic_Marshaller
(Gdk.Event.Gdk_Event, Gdk.Event.Get_Event);
package Widget_Marshaller is new Marshallers.Generic_Widget_Marshaller
(Gtk.Widget.Gtk_Widget_Record, Gtk.Widget.Gtk_Widget);
package Notebook_Page_Marshaller is new Marshallers.Generic_Marshaller
(Gtk.Notebook.Gtk_Notebook_Page, Gtk.Notebook.Get_Notebook_Page);
function To_Marshaller
(Cb : Gint_Marshaller.Handler)
return Marshallers.Marshaller renames Gint_Marshaller.To_Marshaller;
function To_Marshaller
(Cb : Guint_Marshaller.Handler)
return Marshallers.Marshaller renames Guint_Marshaller.To_Marshaller;
function To_Marshaller
(Cb : Event_Marshaller.Handler)
return Marshallers.Marshaller renames Event_Marshaller.To_Marshaller;
function To_Marshaller
(Cb : Widget_Marshaller.Handler)
return Marshallers.Marshaller renames Widget_Marshaller.To_Marshaller;
function To_Marshaller
(Cb : Marshallers.Void_Marshaller.Handler)
return Marshallers.Marshaller
renames Marshallers.Void_Marshaller.To_Marshaller;
function To_Marshaller
(Cb : Notebook_Page_Marshaller.Handler)
return Marshallers.Marshaller
renames Notebook_Page_Marshaller.To_Marshaller;
-- Emitting a signal
function Emit_By_Name
(Object : access Widget_Type'Class;
Name : Glib.Signal_Name;
Param : Gint)
return Return_Type renames Gint_Marshaller.Emit_By_Name;
function Emit_By_Name
(Object : access Widget_Type'Class;
Name : Glib.Signal_Name;
Param : Guint)
return Return_Type renames Guint_Marshaller.Emit_By_Name;
function Emit_By_Name
(Object : access Widget_Type'Class;
Name : Glib.Signal_Name;
Param : Gdk.Event.Gdk_Event) return Return_Type;
function Emit_By_Name
(Object : access Widget_Type'Class;
Name : Glib.Signal_Name;
Param : access Gtk.Widget.Gtk_Widget_Record'Class)
return Return_Type renames Widget_Marshaller.Emit_By_Name;
function Emit_By_Name
(Object : access Widget_Type'Class;
Name : Glib.Signal_Name)
return Return_Type renames Marshallers.Void_Marshaller.Emit_By_Name;
function Emit_By_Name
(Object : access Widget_Type'Class;
Name : Glib.Signal_Name;
Param : Gtk.Notebook.Gtk_Notebook_Page)
return Return_Type renames Notebook_Page_Marshaller.Emit_By_Name;
private
-- <doc_ignore>
type Acc is access all Widget_Type'Class;
-- This type has to be declared at library level, otherwise
-- Program_Error might be raised when trying to cast from the
-- parameter of Marshaller to another type.
type User_Access is access User_Type;
type Data_Type_Record is record
Func : Handler;
-- User's callback
Proxy : Marshallers.Handler_Proxy := null;
-- Handler_Proxy to use
User : User_Access := null;
Object : Acc := null;
-- Slot Object for Object_Connect
end record;
type Data_Type_Access is access all Data_Type_Record;
pragma Convention (C, Data_Type_Access);
-- Data passed to the C handler
function Convert is new Unchecked_Conversion
(Data_Type_Access, System.Address);
function Convert is new Unchecked_Conversion
(System.Address, Data_Type_Access);
procedure Free_Data (Data : Data_Type_Access);
pragma Convention (C, Free_Data);
-- Free the memory associated with the callback's data
procedure First_Marshaller
(Closure : GClosure;
Return_Value : Glib.Values.GValue;
N_Params : Guint;
Params : System.Address;
Invocation_Hint : System.Address;
User_Data : System.Address);
pragma Convention (C, First_Marshaller);
-- First level marshaller. This is the function that is actually
-- called by gtk+. It then calls the Ada functions as required.
-- </doc_ignore>
end User_Return_Callback;
-------------------------------------
-- User_Return_Callback_With_Setup --
-------------------------------------
-- This package is basically the same as User_Return_Callback, except that
-- an extra function (Setup) is called after a handler has been
-- connected. Typical usage is to automatically call Add_Watch (see below)
-- in case the User_Type is (or contains) widgets.
generic
type Widget_Type is new Glib.Object.GObject_Record with private;
type Return_Type is (<>);
type User_Type (<>) is private;
with procedure Setup (User_Data : User_Type; Id : Handler_Id);
package User_Return_Callback_With_Setup is
package Internal_Cb is new User_Return_Callback
(Widget_Type, Return_Type, User_Type);
subtype Handler is Internal_Cb.Handler;
subtype Simple_Handler is Internal_Cb.Simple_Handler;
package Marshallers renames Internal_Cb.Marshallers;
-- Connecting a handler to an object
procedure Connect
(Widget : access Widget_Type'Class;
Name : Glib.Signal_Name;
Marsh : Marshallers.Marshaller;
User_Data : User_Type;
After : Boolean := False);
procedure Object_Connect
(Widget : access Glib.Object.GObject_Record'Class;
Name : Glib.Signal_Name;
Marsh : Marshallers.Marshaller;
Slot_Object : access Widget_Type'Class;
User_Data : User_Type;
After : Boolean := False);
procedure Connect
(Widget : access Widget_Type'Class;
Name : Glib.Signal_Name;
Cb : Handler;
User_Data : User_Type;
After : Boolean := False);
procedure Object_Connect
(Widget : access Glib.Object.GObject_Record'Class;
Name : Glib.Signal_Name;
Cb : Handler;
Slot_Object : access Widget_Type'Class;
User_Data : User_Type;
After : Boolean := False);
procedure Connect
(Widget : access Widget_Type'Class;
Name : Glib.Signal_Name;
Cb : Simple_Handler;
User_Data : User_Type;
After : Boolean := False);
procedure Object_Connect
(Widget : access Glib.Object.GObject_Record'Class;
Name : Glib.Signal_Name;
Cb : Simple_Handler;
Slot_Object : access Widget_Type'Class;
User_Data : User_Type;
After : Boolean := False);
pragma Inline (Connect);
function Connect
(Widget : access Widget_Type'Class;
Name : Glib.Signal_Name;
Marsh : Marshallers.Marshaller;
User_Data : User_Type;
After : Boolean := False) return Handler_Id;
function Object_Connect
(Widget : access Glib.Object.GObject_Record'Class;
Name : Glib.Signal_Name;
Marsh : Marshallers.Marshaller;
Slot_Object : access Widget_Type'Class;
User_Data : User_Type;
After : Boolean := False) return Handler_Id;
function Connect
(Widget : access Widget_Type'Class;
Name : Glib.Signal_Name;
Cb : Handler;
User_Data : User_Type;
After : Boolean := False) return Handler_Id;
function Object_Connect
(Widget : access Glib.Object.GObject_Record'Class;
Name : Glib.Signal_Name;
Cb : Handler;
Slot_Object : access Widget_Type'Class;
User_Data : User_Type;
After : Boolean := False) return Handler_Id;
-- Some convenient functions to create marshallers
package Gint_Marshaller renames Internal_Cb.Gint_Marshaller;
package Guint_Marshaller renames Internal_Cb.Guint_Marshaller;
package Event_Marshaller renames Internal_Cb.Event_Marshaller;
package Widget_Marshaller renames Internal_Cb.Widget_Marshaller;
package Notebook_Page_Marshaller
renames Internal_Cb.Notebook_Page_Marshaller;
function To_Marshaller
(Cb : Gint_Marshaller.Handler)
return Internal_Cb.Marshallers.Marshaller
renames Internal_Cb.To_Marshaller;
function To_Marshaller
(Cb : Guint_Marshaller.Handler)
return Internal_Cb.Marshallers.Marshaller
renames Internal_Cb.To_Marshaller;
function To_Marshaller
(Cb : Event_Marshaller.Handler)
return Internal_Cb.Marshallers.Marshaller
renames Internal_Cb.To_Marshaller;
function To_Marshaller
(Cb : Widget_Marshaller.Handler)
return Internal_Cb.Marshallers.Marshaller
renames Internal_Cb.To_Marshaller;
function To_Marshaller
(Cb : Internal_Cb.Marshallers.Void_Marshaller.Handler)
return Internal_Cb.Marshallers.Marshaller
renames Internal_Cb.To_Marshaller;
function To_Marshaller
(Cb : Notebook_Page_Marshaller.Handler)
return Internal_Cb.Marshallers.Marshaller
renames Internal_Cb.To_Marshaller;
-- Emitting a signal
function Emit_By_Name
(Object : access Widget_Type'Class;
Name : Glib.Signal_Name;
Param : Gint) return Return_Type renames Internal_Cb.Emit_By_Name;
function Emit_By_Name
(Object : access Widget_Type'Class;
Name : Glib.Signal_Name;
Param : Guint) return Return_Type renames Internal_Cb.Emit_By_Name;
function Emit_By_Name
(Object : access Widget_Type'Class;
Name : Glib.Signal_Name;
Param : Gdk.Event.Gdk_Event) return Return_Type
renames Internal_Cb.Emit_By_Name;
function Emit_By_Name
(Object : access Widget_Type'Class;
Name : Glib.Signal_Name;
Param : access Gtk.Widget.Gtk_Widget_Record'Class)
return Return_Type renames Internal_Cb.Emit_By_Name;
function Emit_By_Name
(Object : access Widget_Type'Class;
Name : Glib.Signal_Name)
return Return_Type renames Internal_Cb.Emit_By_Name;
function Emit_By_Name
(Object : access Widget_Type'Class;
Name : Glib.Signal_Name;
Param : Gtk.Notebook.Gtk_Notebook_Page)
return Return_Type renames Internal_Cb.Emit_By_Name;
end User_Return_Callback_With_Setup;
---------------------------------------------------------
-- These handlers do not return a value
-- They do not have a User_Data
---------------------------------------------------------
generic
type Widget_Type is new Glib.Object.GObject_Record with private;
package Callback is
type Handler is access procedure
(Widget : access Widget_Type'Class;
Params : Glib.Values.GValues);
type Simple_Handler is access procedure
(Widget : access Widget_Type'Class);
package Marshallers is new
Gtk.Marshallers.Void_Marshallers (Widget_Type);
-- Connecting a handler to an object
procedure Connect
(Widget : access Widget_Type'Class;
Name : Glib.Signal_Name;
Marsh : Marshallers.Marshaller;
After : Boolean := False);
procedure Object_Connect
(Widget : access Glib.Object.GObject_Record'Class;
Name : Glib.Signal_Name;
Marsh : Marshallers.Marshaller;
Slot_Object : access Widget_Type'Class;
After : Boolean := False);
procedure Connect
(Widget : access Widget_Type'Class;
Name : Glib.Signal_Name;
Cb : Handler;
After : Boolean := False);
procedure Object_Connect
(Widget : access Glib.Object.GObject_Record'Class;
Name : Glib.Signal_Name;
Cb : Handler;
Slot_Object : access Widget_Type'Class;
After : Boolean := False);
procedure Connect
(Widget : access Widget_Type'Class;
Name : Glib.Signal_Name;
Cb : Simple_Handler;
After : Boolean := False);
procedure Object_Connect
(Widget : access Glib.Object.GObject_Record'Class;
Name : Glib.Signal_Name;
Cb : Simple_Handler;
Slot_Object : access Widget_Type'Class;
After : Boolean := False);
pragma Inline (Connect);
pragma Inline (Object_Connect);
function Connect
(Widget : access Widget_Type'Class;
Name : Glib.Signal_Name;
Marsh : Marshallers.Marshaller;
After : Boolean := False) return Handler_Id;
function Object_Connect
(Widget : access Glib.Object.GObject_Record'Class;
Name : Glib.Signal_Name;
Marsh : Marshallers.Marshaller;
Slot_Object : access Widget_Type'Class;
After : Boolean := False) return Handler_Id;
function Connect
(Widget : access Widget_Type'Class;
Name : Glib.Signal_Name;
Cb : Handler;
After : Boolean := False) return Handler_Id;
function Object_Connect
(Widget : access Glib.Object.GObject_Record'Class;
Name : Glib.Signal_Name;
Cb : Handler;
Slot_Object : access Widget_Type'Class;
After : Boolean := False) return Handler_Id;
-- Some convenient functions to create marshallers
package Gint_Marshaller is new Marshallers.Generic_Marshaller
(Gint, Glib.Values.Get_Int);
package Guint_Marshaller is new Marshallers.Generic_Marshaller
(Guint, Glib.Values.Get_Uint);
package Event_Marshaller is new Marshallers.Generic_Marshaller
(Gdk.Event.Gdk_Event, Gdk.Event.Get_Event);
package Widget_Marshaller is new Marshallers.Generic_Widget_Marshaller
(Gtk.Widget.Gtk_Widget_Record, Gtk.Widget.Gtk_Widget);
package Notebook_Page_Marshaller is new Marshallers.Generic_Marshaller
(Gtk.Notebook.Gtk_Notebook_Page, Gtk.Notebook.Get_Notebook_Page);
package Tree_Path_Marshaller is new Marshallers.Generic_Marshaller
(Gtk.Tree_Model.Gtk_Tree_Path, Gtk.Tree_Model.Get_Tree_Path);
package Tree_Iter_Tree_Path_Marshaller is
new Marshallers.Generic_Marshaller_2
(Gtk.Tree_Model.Gtk_Tree_Iter, Gtk.Tree_Model.Get_Tree_Iter,
Gtk.Tree_Model.Gtk_Tree_Path, Gtk.Tree_Model.Get_Tree_Path);
package Tree_Path_Tree_Iter_Marshaller is
new Marshallers.Generic_Marshaller_2
(Gtk.Tree_Model.Gtk_Tree_Path, Gtk.Tree_Model.Get_Tree_Path,
Gtk.Tree_Model.Gtk_Tree_Iter, Gtk.Tree_Model.Get_Tree_Iter);
function To_Marshaller
(Cb : Gint_Marshaller.Handler)
return Marshallers.Marshaller renames Gint_Marshaller.To_Marshaller;
function To_Marshaller
(Cb : Guint_Marshaller.Handler)
return Marshallers.Marshaller renames Guint_Marshaller.To_Marshaller;
function To_Marshaller
(Cb : Event_Marshaller.Handler)
return Marshallers.Marshaller renames Event_Marshaller.To_Marshaller;
function To_Marshaller
(Cb : Widget_Marshaller.Handler)
return Marshallers.Marshaller renames Widget_Marshaller.To_Marshaller;
function To_Marshaller
(Cb : Marshallers.Void_Marshaller.Handler)
return Marshallers.Marshaller
renames Marshallers.Void_Marshaller.To_Marshaller;
function To_Marshaller
(Cb : Notebook_Page_Marshaller.Handler)
return Marshallers.Marshaller
renames Notebook_Page_Marshaller.To_Marshaller;
function To_Marshaller
(Cb : Tree_Path_Marshaller.Handler)
return Marshallers.Marshaller
renames Tree_Path_Marshaller.To_Marshaller;
function To_Marshaller
(Cb : Tree_Iter_Tree_Path_Marshaller.Handler)
return Marshallers.Marshaller
renames Tree_Iter_Tree_Path_Marshaller.To_Marshaller;
function To_Marshaller
(Cb : Tree_Path_Tree_Iter_Marshaller.Handler)
return Marshallers.Marshaller
renames Tree_Path_Tree_Iter_Marshaller.To_Marshaller;
-- Emitting a signal
procedure Emit_By_Name
(Object : access Widget_Type'Class;
Name : Glib.Signal_Name;
Param : Gint) renames Gint_Marshaller.Emit_By_Name;
procedure Emit_By_Name
(Object : access Widget_Type'Class;
Name : Glib.Signal_Name;
Param : Guint) renames Guint_Marshaller.Emit_By_Name;
procedure Emit_By_Name
(Object : access Widget_Type'Class;
Name : Glib.Signal_Name;
Param : Gdk.Event.Gdk_Event);
procedure Emit_By_Name
(Object : access Widget_Type'Class;
Name : Glib.Signal_Name;
Param : access Gtk.Widget.Gtk_Widget_Record'Class)
renames Widget_Marshaller.Emit_By_Name;
procedure Emit_By_Name
(Object : access Widget_Type'Class;
Name : Glib.Signal_Name)
renames Marshallers.Void_Marshaller.Emit_By_Name;
procedure Emit_By_Name
(Object : access Widget_Type'Class;
Name : Glib.Signal_Name;
Param : Gtk.Notebook.Gtk_Notebook_Page)
renames Notebook_Page_Marshaller.Emit_By_Name;
procedure Emit_By_Name is
new Tree_Path_Marshaller.Emit_By_Name_Generic
(Gtk.Tree_Model.To_Address);
procedure Emit_By_Name is
new Tree_Iter_Tree_Path_Marshaller.Emit_By_Name_Generic
(Gtk.Tree_Model.To_Address,
Gtk.Tree_Model.To_Address);
procedure Emit_By_Name is
new Tree_Path_Tree_Iter_Marshaller.Emit_By_Name_Generic
(Gtk.Tree_Model.To_Address,
Gtk.Tree_Model.To_Address);
private
-- <doc_ignore>
type Acc is access all Widget_Type'Class;
-- This type has to be declared at library level, otherwise
-- Program_Error might be raised when trying to cast from the
-- parameter of Marshaller to another type.
type Data_Type_Record is record
Func : Handler; -- User's callback
Proxy : Marshallers.Handler_Proxy := null; -- Handler_Proxy to use
Object : Acc := null; -- Slot Object for Object_Connect
end record;
type Data_Type_Access is access all Data_Type_Record;
pragma Convention (C, Data_Type_Access);
-- Data passed to the C handler
function Convert is new Unchecked_Conversion
(Data_Type_Access, System.Address);
function Convert is new Unchecked_Conversion
(System.Address, Data_Type_Access);
procedure Free_Data (Data : Data_Type_Access);
pragma Convention (C, Free_Data);
-- Free the memory associated with the callback's data
procedure First_Marshaller
(Closure : GClosure;
Return_Value : Glib.Values.GValue;
N_Params : Guint;
Params : System.Address;
Invocation_Hint : System.Address;
User_Data : System.Address);
pragma Convention (C, First_Marshaller);
-- First level marshaller. This is the function that is actually
-- called by gtk+. It then calls the Ada functions as required.
-- </doc_ignore>
end Callback;
---------------------------------------------------------
-- These handlers do not return a value
-- They require a User_Data
-- See also the package User_Callback_With_Setup
---------------------------------------------------------
generic
type Widget_Type is new Glib.Object.GObject_Record with private;
type User_Type (<>) is private;
package User_Callback is
type Handler is access procedure
(Widget : access Widget_Type'Class;
Params : Glib.Values.GValues;
User_Data : User_Type);
type Simple_Handler is access procedure
(Widget : access Widget_Type'Class;
User_Data : User_Type);
package Marshallers is new
Gtk.Marshallers.User_Void_Marshallers (Widget_Type, User_Type);
-- Connecting a handler to an object
procedure Connect
(Widget : access Widget_Type'Class;
Name : Glib.Signal_Name;
Marsh : Marshallers.Marshaller;
User_Data : User_Type;
After : Boolean := False);
procedure Object_Connect
(Widget : access Glib.Object.GObject_Record'Class;
Name : Glib.Signal_Name;
Marsh : Marshallers.Marshaller;
Slot_Object : access Widget_Type'Class;
User_Data : User_Type;
After : Boolean := False);
procedure Connect
(Widget : access Widget_Type'Class;
Name : Glib.Signal_Name;
Cb : Handler;
User_Data : User_Type;
After : Boolean := False);
procedure Object_Connect
(Widget : access Glib.Object.GObject_Record'Class;
Name : Glib.Signal_Name;
Cb : Handler;
Slot_Object : access Widget_Type'Class;
User_Data : User_Type;
After : Boolean := False);
procedure Connect
(Widget : access Widget_Type'Class;
Name : Glib.Signal_Name;
Cb : Simple_Handler;
User_Data : User_Type;
After : Boolean := False);
procedure Object_Connect
(Widget : access Glib.Object.GObject_Record'Class;
Name : Glib.Signal_Name;
Cb : Simple_Handler;
Slot_Object : access Widget_Type'Class;
User_Data : User_Type;
After : Boolean := False);
pragma Inline (Connect);
function Connect
(Widget : access Widget_Type'Class;
Name : Glib.Signal_Name;
Marsh : Marshallers.Marshaller;
User_Data : User_Type;
After : Boolean := False) return Handler_Id;
function Object_Connect
(Widget : access Glib.Object.GObject_Record'Class;
Name : Glib.Signal_Name;
Marsh : Marshallers.Marshaller;
Slot_Object : access Widget_Type'Class;
User_Data : User_Type;
After : Boolean := False) return Handler_Id;
function Connect
(Widget : access Widget_Type'Class;
Name : Glib.Signal_Name;
Cb : Handler;
User_Data : User_Type;
After : Boolean := False) return Handler_Id;
function Object_Connect
(Widget : access Glib.Object.GObject_Record'Class;
Name : Glib.Signal_Name;
Cb : Handler;
Slot_Object : access Widget_Type'Class;
User_Data : User_Type;
After : Boolean := False) return Handler_Id;
-- Some convenient functions to create marshallers
package Gint_Marshaller is new Marshallers.Generic_Marshaller
(Gint, Glib.Values.Get_Int);
package Guint_Marshaller is new Marshallers.Generic_Marshaller
(Guint, Glib.Values.Get_Uint);
package Event_Marshaller is new Marshallers.Generic_Marshaller
(Gdk.Event.Gdk_Event, Gdk.Event.Get_Event);
package Widget_Marshaller is new Marshallers.Generic_Widget_Marshaller
(Gtk.Widget.Gtk_Widget_Record, Gtk.Widget.Gtk_Widget);
package Notebook_Page_Marshaller is new Marshallers.Generic_Marshaller
(Gtk.Notebook.Gtk_Notebook_Page, Gtk.Notebook.Get_Notebook_Page);
package Tree_Path_Marshaller is new Marshallers.Generic_Marshaller
(Gtk.Tree_Model.Gtk_Tree_Path, Gtk.Tree_Model.Get_Tree_Path);
package Tree_Iter_Tree_Path_Marshaller is
new Marshallers.Generic_Marshaller_2
(Gtk.Tree_Model.Gtk_Tree_Iter, Gtk.Tree_Model.Get_Tree_Iter,
Gtk.Tree_Model.Gtk_Tree_Path, Gtk.Tree_Model.Get_Tree_Path);
package Tree_Path_Tree_Iter_Marshaller is
new Marshallers.Generic_Marshaller_2
(Gtk.Tree_Model.Gtk_Tree_Path, Gtk.Tree_Model.Get_Tree_Path,
Gtk.Tree_Model.Gtk_Tree_Iter, Gtk.Tree_Model.Get_Tree_Iter);
function To_Marshaller
(Cb : Gint_Marshaller.Handler)
return Marshallers.Marshaller renames Gint_Marshaller.To_Marshaller;
function To_Marshaller
(Cb : Guint_Marshaller.Handler)
return Marshallers.Marshaller renames Guint_Marshaller.To_Marshaller;
function To_Marshaller
(Cb : Event_Marshaller.Handler)
return Marshallers.Marshaller renames Event_Marshaller.To_Marshaller;
function To_Marshaller
(Cb : Widget_Marshaller.Handler)
return Marshallers.Marshaller renames Widget_Marshaller.To_Marshaller;
function To_Marshaller
(Cb : Marshallers.Void_Marshaller.Handler)
return Marshallers.Marshaller
renames Marshallers.Void_Marshaller.To_Marshaller;
function To_Marshaller
(Cb : Notebook_Page_Marshaller.Handler)
return Marshallers.Marshaller
renames Notebook_Page_Marshaller.To_Marshaller;
function To_Marshaller
(Cb : Tree_Path_Marshaller.Handler)
return Marshallers.Marshaller
renames Tree_Path_Marshaller.To_Marshaller;
function To_Marshaller
(Cb : Tree_Iter_Tree_Path_Marshaller.Handler)
return Marshallers.Marshaller
renames Tree_Iter_Tree_Path_Marshaller.To_Marshaller;
function To_Marshaller
(Cb : Tree_Path_Tree_Iter_Marshaller.Handler)
return Marshallers.Marshaller
renames Tree_Path_Tree_Iter_Marshaller.To_Marshaller;
-- Emitting a signal
procedure Emit_By_Name
(Object : access Widget_Type'Class;
Name : Glib.Signal_Name;
Param : Gint) renames Gint_Marshaller.Emit_By_Name;
procedure Emit_By_Name
(Object : access Widget_Type'Class;
Name : Glib.Signal_Name;
Param : Guint) renames Guint_Marshaller.Emit_By_Name;
procedure Emit_By_Name
(Object : access Widget_Type'Class;
Name : Glib.Signal_Name;
Param : Gdk.Event.Gdk_Event);
procedure Emit_By_Name
(Object : access Widget_Type'Class;
Name : Glib.Signal_Name;
Param : access Gtk.Widget.Gtk_Widget_Record'Class)
renames Widget_Marshaller.Emit_By_Name;
procedure Emit_By_Name
(Object : access Widget_Type'Class;
Name : Glib.Signal_Name)
renames Marshallers.Void_Marshaller.Emit_By_Name;
procedure Emit_By_Name
(Object : access Widget_Type'Class;
Name : Glib.Signal_Name;
Param : Gtk.Notebook.Gtk_Notebook_Page)
renames Notebook_Page_Marshaller.Emit_By_Name;
procedure Emit_By_Name is
new Tree_Path_Marshaller.Emit_By_Name_Generic
(Gtk.Tree_Model.To_Address);
procedure Emit_By_Name is
new Tree_Iter_Tree_Path_Marshaller.Emit_By_Name_Generic
(Gtk.Tree_Model.To_Address,
Gtk.Tree_Model.To_Address);
procedure Emit_By_Name is
new Tree_Path_Tree_Iter_Marshaller.Emit_By_Name_Generic
(Gtk.Tree_Model.To_Address,
Gtk.Tree_Model.To_Address);
private
-- <doc_ignore>
type Acc is access all Widget_Type'Class;
-- This type has to be declared at library level, otherwise
-- Program_Error might be raised when trying to cast from the
-- parameter of Marshaller to another type.
type User_Access is access User_Type;
type Data_Type_Record is record
Func : Handler;
-- User's callback
Proxy : Marshallers.Handler_Proxy := null;
-- Handler_Proxy to use
User : User_Access := null;
Object : Acc := null;
-- Slot_Object for Object_Connect
end record;
type Data_Type_Access is access all Data_Type_Record;
pragma Convention (C, Data_Type_Access);
-- Data passed to the C handler
function Convert is new Unchecked_Conversion
(Data_Type_Access, System.Address);
function Convert is new Unchecked_Conversion
(System.Address, Data_Type_Access);
procedure Free_Data (Data : Data_Type_Access);
pragma Convention (C, Free_Data);
-- Free the memory associated with the callback's data
procedure First_Marshaller
(Closure : GClosure;
Return_Value : Glib.Values.GValue;
N_Params : Guint;
Params : System.Address;
Invocation_Hint : System.Address;
User_Data : System.Address);
pragma Convention (C, First_Marshaller);
-- First level marshaller. This is the function that is actually
-- called by gtk+. It then calls the Ada functions as required.
-- </doc_ignore>
end User_Callback;
------------------------------
-- User_Callback_With_Setup --
------------------------------
-- This package is basically the same as User_Callback, except that an
-- extra function (Setup) is called after a handler has been
-- connected. Typical usage is to automatically call Add_Watch (see below)
-- in case the User_Type is (or contains) widgets.
generic
type Widget_Type is new Glib.Object.GObject_Record with private;
type User_Type (<>) is private;
with procedure Setup (User_Data : User_Type; Id : Handler_Id);
package User_Callback_With_Setup is
package Internal_Cb is new User_Callback (Widget_Type, User_Type);
package Marshallers renames Internal_Cb.Marshallers;
subtype Handler is Internal_Cb.Handler;
subtype Simple_Handler is Internal_Cb.Simple_Handler;
-- Connecting a handler to an object
procedure Connect
(Widget : access Widget_Type'Class;
Name : Glib.Signal_Name;
Marsh : Marshallers.Marshaller;
User_Data : User_Type;
After : Boolean := False);
procedure Object_Connect
(Widget : access Glib.Object.GObject_Record'Class;
Name : Glib.Signal_Name;
Marsh : Marshallers.Marshaller;
Slot_Object : access Widget_Type'Class;
User_Data : User_Type;
After : Boolean := False);
procedure Connect
(Widget : access Widget_Type'Class;
Name : Glib.Signal_Name;
Cb : Handler;
User_Data : User_Type;
After : Boolean := False);
procedure Object_Connect
(Widget : access Glib.Object.GObject_Record'Class;
Name : Glib.Signal_Name;
Cb : Handler;
Slot_Object : access Widget_Type'Class;
User_Data : User_Type;
After : Boolean := False);
procedure Connect
(Widget : access Widget_Type'Class;
Name : Glib.Signal_Name;
Cb : Simple_Handler;
User_Data : User_Type;
After : Boolean := False);
procedure Object_Connect
(Widget : access Glib.Object.GObject_Record'Class;
Name : Glib.Signal_Name;
Cb : Simple_Handler;
Slot_Object : access Widget_Type'Class;
User_Data : User_Type;
After : Boolean := False);
pragma Inline (Connect);
function Connect
(Widget : access Widget_Type'Class;
Name : Glib.Signal_Name;
Marsh : Marshallers.Marshaller;
User_Data : User_Type;
After : Boolean := False) return Handler_Id;
function Object_Connect
(Widget : access Glib.Object.GObject_Record'Class;
Name : Glib.Signal_Name;
Marsh : Marshallers.Marshaller;
Slot_Object : access Widget_Type'Class;
User_Data : User_Type;
After : Boolean := False) return Handler_Id;
function Connect
(Widget : access Widget_Type'Class;
Name : Glib.Signal_Name;
Cb : Handler;
User_Data : User_Type;
After : Boolean := False) return Handler_Id;
function Object_Connect
(Widget : access Glib.Object.GObject_Record'Class;
Name : Glib.Signal_Name;
Cb : Handler;
Slot_Object : access Widget_Type'Class;
User_Data : User_Type;
After : Boolean := False) return Handler_Id;
-- Some convenient functions to create marshallers
package Gint_Marshaller renames Internal_Cb.Gint_Marshaller;
package Guint_Marshaller renames Internal_Cb.Guint_Marshaller;
package Event_Marshaller renames Internal_Cb.Event_Marshaller;
package Widget_Marshaller renames Internal_Cb.Widget_Marshaller;
package Notebook_Page_Marshaller
renames Internal_Cb.Notebook_Page_Marshaller;
function To_Marshaller
(Cb : Gint_Marshaller.Handler)
return Internal_Cb.Marshallers.Marshaller
renames Internal_Cb.To_Marshaller;
function To_Marshaller
(Cb : Guint_Marshaller.Handler)
return Internal_Cb.Marshallers.Marshaller
renames Internal_Cb.To_Marshaller;
function To_Marshaller
(Cb : Event_Marshaller.Handler)
return Internal_Cb.Marshallers.Marshaller
renames Internal_Cb.To_Marshaller;
function To_Marshaller
(Cb : Widget_Marshaller.Handler)
return Internal_Cb.Marshallers.Marshaller
renames Internal_Cb.To_Marshaller;
function To_Marshaller
(Cb : Internal_Cb.Marshallers.Void_Marshaller.Handler)
return Internal_Cb.Marshallers.Marshaller
renames Internal_Cb.To_Marshaller;
function To_Marshaller
(Cb : Notebook_Page_Marshaller.Handler)
return Internal_Cb.Marshallers.Marshaller
renames Internal_Cb.To_Marshaller;
-- Emitting a signal
procedure Emit_By_Name
(Object : access Widget_Type'Class;
Name : Glib.Signal_Name;
Param : Gint) renames Internal_Cb.Emit_By_Name;
procedure Emit_By_Name
(Object : access Widget_Type'Class;
Name : Glib.Signal_Name;
Param : Guint) renames Internal_Cb.Emit_By_Name;
procedure Emit_By_Name
(Object : access Widget_Type'Class;
Name : Glib.Signal_Name;
Param : Gdk.Event.Gdk_Event) renames Internal_Cb.Emit_By_Name;
procedure Emit_By_Name
(Object : access Widget_Type'Class;
Name : Glib.Signal_Name;
Param : access Gtk.Widget.Gtk_Widget_Record'Class)
renames Internal_Cb.Emit_By_Name;
procedure Emit_By_Name
(Object : access Widget_Type'Class;
Name : Glib.Signal_Name) renames Internal_Cb.Emit_By_Name;
procedure Emit_By_Name
(Object : access Widget_Type'Class;
Name : Glib.Signal_Name;
Param : Gtk.Notebook.Gtk_Notebook_Page)
renames Internal_Cb.Emit_By_Name;
end User_Callback_With_Setup;
------------------------------------------------------------------
-- General functions
------------------------------------------------------------------
procedure Add_Watch
(Id : Handler_Id; Object : access Glib.Object.GObject_Record'Class);
-- Make sure that when Object is destroyed, the handler Id is also
-- destroyed. This function should mostly be used in cases where you use a
-- User_Data that is Object. If you don't destroy the callback at the same
-- time, then the next time the callback is called it will try to access
-- some invalid memory (Object being destroyed), and you will likely get a
-- Storage_Error.
procedure Disconnect
(Object : access Glib.Object.GObject_Record'Class;
Id : in out Handler_Id);
-- Disconnect the handler identified by the given Handler_Id.
procedure Emit_Stop_By_Name
(Object : access Glib.Object.GObject_Record'Class;
Name : Glib.Signal_Name);
-- During a signal emission, invoking this procedure will halt the
-- emission.
procedure Handler_Block
(Obj : access Glib.Object.GObject_Record'Class;
Id : Handler_Id);
-- Blocks temporily the signal. For each call to this procedure,
-- a call to Handler_Unblock must be performed in order to really
-- unblock the signal.
procedure Handlers_Destroy
(Obj : access Glib.Object.GObject_Record'Class);
-- Destroys all the handlers associated to the given object.
procedure Handler_Unblock
(Obj : access Glib.Object.GObject_Record'Class;
Id : Handler_Id);
-- See Handler_Block.
-- </doc_ignore>
end Gtk.Handlers;
-- <example>
-- -- This example connects the "delete_event" signal to a widget.
-- -- The handlers for this signal get an extra argument which is
-- -- the Gdk_Event that generated the signal.
--
-- with Gtk.Handlers; use Gtk.Handlers;
-- with Gtk.Marshallers; use Gtk.Marshallers;
--
-- function My_Cb (Widget : access Gtk_Widget_Record'Class;
-- Event : Gdk.Event.Gdk_Event)
-- return Gint;
-- -- your own function
--
-- package Return_Widget_Cb is new Gtk.Handlers.Return_Callback
-- (Gtk.Widget.Gtk_Widget_Record, Gint);
--
-- Return_Widget_Cb.Connect (W, "delete_event",
-- Return_Widget_Cb.To_Marshaller (My_Cb'Access));
--
-- </example>
|