/usr/share/gtk-doc/html/at-spi-cspi/at-spi-cspi-Registry-queries.html is in at-spi-doc 1.32.0-1ubuntu1.
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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Registry queries</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="AT-SPI C Bindings Reference Manual">
<link rel="up" href="spi-main.html" title="SPI Main Event Loop and Registry">
<link rel="prev" href="at-spi-cspi-Event-Listener-Support.html" title="Event Listener Support">
<link rel="next" href="spi-application.html" title="AccessibleApplication Methods">
<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="at-spi-cspi-Event-Listener-Support.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="spi-main.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">AT-SPI C Bindings Reference Manual</th>
<td><a accesskey="n" href="spi-application.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#at-spi-cspi-Registry-queries.synopsis" class="shortcut">Top</a>
|
<a href="#at-spi-cspi-Registry-queries.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry">
<a name="at-spi-cspi-Registry-queries"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="at-spi-cspi-Registry-queries.top_of_page"></a>Registry queries</span></h2>
<p>Registry queries</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="at-spi-cspi-Registry-queries.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">enum <a class="link" href="at-spi-cspi-Registry-queries.html#AccessibleKeySynthType" title="enum AccessibleKeySynthType">AccessibleKeySynthType</a>;
<span class="returnvalue">int</span> <a class="link" href="at-spi-cspi-Registry-queries.html#SPI-getDesktopCount" title="SPI_getDesktopCount ()">SPI_getDesktopCount</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
<a class="link" href="at-spi-cspi-Accessible-Objects.html#Accessible" title="struct Accessible"><span class="returnvalue">Accessible</span></a> * <a class="link" href="at-spi-cspi-Registry-queries.html#SPI-getDesktop" title="SPI_getDesktop ()">SPI_getDesktop</a> (<em class="parameter"><code><span class="type">int</span> i</code></em>);
<span class="returnvalue">int</span> <a class="link" href="at-spi-cspi-Registry-queries.html#SPI-getDesktopList" title="SPI_getDesktopList ()">SPI_getDesktopList</a> (<em class="parameter"><code><a class="link" href="at-spi-cspi-Accessible-Objects.html#Accessible" title="struct Accessible"><span class="type">Accessible</span></a> ***desktop_list</code></em>);
<span class="returnvalue">void</span> <a class="link" href="at-spi-cspi-Registry-queries.html#SPI-freeDesktopList" title="SPI_freeDesktopList ()">SPI_freeDesktopList</a> (<em class="parameter"><code><a class="link" href="at-spi-cspi-Accessible-Objects.html#Accessible" title="struct Accessible"><span class="type">Accessible</span></a> **desktop_list</code></em>);
<span class="returnvalue">SPIBoolean</span> (<a class="link" href="at-spi-cspi-Registry-queries.html#AccessibleKeystrokeListenerCB" title="AccessibleKeystrokeListenerCB ()">*AccessibleKeystrokeListenerCB</a>) (<em class="parameter"><code>const <a class="link" href="at-spi-cspi-Registry-queries.html#AccessibleKeystroke" title="AccessibleKeystroke"><span class="type">AccessibleKeystroke</span></a> *stroke</code></em>,
<em class="parameter"><code><span class="type">void</span> *user_data</code></em>);
typedef <a class="link" href="at-spi-cspi-Registry-queries.html#AccessibleKeyEventMask" title="AccessibleKeyEventMask">AccessibleKeyEventMask</a>;
typedef <a class="link" href="at-spi-cspi-Registry-queries.html#AccessibleModifierMaskType" title="AccessibleModifierMaskType">AccessibleModifierMaskType</a>;
typedef <a class="link" href="at-spi-cspi-Registry-queries.html#AccessibleKeyMaskType" title="AccessibleKeyMaskType">AccessibleKeyMaskType</a>;
typedef <a class="link" href="at-spi-cspi-Registry-queries.html#AccessibleKeyEventType" title="AccessibleKeyEventType">AccessibleKeyEventType</a>;
enum <a class="link" href="at-spi-cspi-Registry-queries.html#AccessibleKeyListenerSyncType" title="enum AccessibleKeyListenerSyncType">AccessibleKeyListenerSyncType</a>;
typedef <a class="link" href="at-spi-cspi-Registry-queries.html#AccessibleKeystroke" title="AccessibleKeystroke">AccessibleKeystroke</a>;
<span class="returnvalue">AccessibleKeySet</span> * <a class="link" href="at-spi-cspi-Registry-queries.html#SPI-createAccessibleKeySet" title="SPI_createAccessibleKeySet ()">SPI_createAccessibleKeySet</a> (<em class="parameter"><code><span class="type">int</span> len</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *keysyms</code></em>,
<em class="parameter"><code><span class="type">short</span> *keycodes</code></em>,
<em class="parameter"><code>const <span class="type">char</span> **keystrings</code></em>);
<span class="returnvalue">void</span> <a class="link" href="at-spi-cspi-Registry-queries.html#SPI-freeAccessibleKeySet" title="SPI_freeAccessibleKeySet ()">SPI_freeAccessibleKeySet</a> (<em class="parameter"><code><span class="type">AccessibleKeySet</span> *keyset</code></em>);
<span class="returnvalue">AccessibleKeystrokeListener</span> * <a class="link" href="at-spi-cspi-Registry-queries.html#SPI-createAccessibleKeystrokeListener" title="SPI_createAccessibleKeystrokeListener ()">SPI_createAccessibleKeystrokeListener</a>
(<em class="parameter"><code><a class="link" href="at-spi-cspi-Registry-queries.html#AccessibleKeystrokeListenerCB" title="AccessibleKeystrokeListenerCB ()"><span class="type">AccessibleKeystrokeListenerCB</span></a> callback</code></em>,
<em class="parameter"><code><span class="type">void</span> *user_data</code></em>);
<span class="returnvalue">SPIBoolean</span> <a class="link" href="at-spi-cspi-Registry-queries.html#SPI-registerGlobalEventListener" title="SPI_registerGlobalEventListener ()">SPI_registerGlobalEventListener</a> (<em class="parameter"><code><span class="type">AccessibleEventListener</span> *listener</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *eventType</code></em>);
<span class="returnvalue">SPIBoolean</span> <a class="link" href="at-spi-cspi-Registry-queries.html#SPI-deregisterGlobalEventListener" title="SPI_deregisterGlobalEventListener ()">SPI_deregisterGlobalEventListener</a> (<em class="parameter"><code><span class="type">AccessibleEventListener</span> *listener</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *eventType</code></em>);
<span class="returnvalue">SPIBoolean</span> <a class="link" href="at-spi-cspi-Registry-queries.html#SPI-deregisterGlobalEventListenerAll" title="SPI_deregisterGlobalEventListenerAll ()">SPI_deregisterGlobalEventListenerAll</a>
(<em class="parameter"><code><span class="type">AccessibleEventListener</span> *listener</code></em>);
<span class="returnvalue">SPIBoolean</span> <a class="link" href="at-spi-cspi-Registry-queries.html#SPI-registerAccessibleKeystrokeListener" title="SPI_registerAccessibleKeystrokeListener ()">SPI_registerAccessibleKeystrokeListener</a>
(<em class="parameter"><code><span class="type">AccessibleKeystrokeListener</span> *listener</code></em>,
<em class="parameter"><code><span class="type">AccessibleKeySet</span> *keys</code></em>,
<em class="parameter"><code><a class="link" href="at-spi-cspi-Registry-queries.html#AccessibleKeyMaskType" title="AccessibleKeyMaskType"><span class="type">AccessibleKeyMaskType</span></a> modmask</code></em>,
<em class="parameter"><code><a class="link" href="at-spi-cspi-Registry-queries.html#AccessibleKeyEventMask" title="AccessibleKeyEventMask"><span class="type">AccessibleKeyEventMask</span></a> eventmask</code></em>,
<em class="parameter"><code><a class="link" href="at-spi-cspi-Registry-queries.html#AccessibleKeyListenerSyncType" title="enum AccessibleKeyListenerSyncType"><span class="type">AccessibleKeyListenerSyncType</span></a> sync_type</code></em>);
<span class="returnvalue">SPIBoolean</span> <a class="link" href="at-spi-cspi-Registry-queries.html#SPI-deregisterAccessibleKeystrokeListener" title="SPI_deregisterAccessibleKeystrokeListener ()">SPI_deregisterAccessibleKeystrokeListener</a>
(<em class="parameter"><code><span class="type">AccessibleKeystrokeListener</span> *listener</code></em>,
<em class="parameter"><code><a class="link" href="at-spi-cspi-Registry-queries.html#AccessibleKeyMaskType" title="AccessibleKeyMaskType"><span class="type">AccessibleKeyMaskType</span></a> modmask</code></em>);
<span class="returnvalue">void</span> <a class="link" href="at-spi-cspi-Registry-queries.html#AccessibleKeystrokeListener-unref" title="AccessibleKeystrokeListener_unref ()">AccessibleKeystrokeListener_unref</a> (<em class="parameter"><code><span class="type">AccessibleKeystrokeListener</span> *listener</code></em>);
<span class="returnvalue">SPIBoolean</span> <a class="link" href="at-spi-cspi-Registry-queries.html#AccessibleKeystrokeListener-removeCallback" title="AccessibleKeystrokeListener_removeCallback ()">AccessibleKeystrokeListener_removeCallback</a>
(<em class="parameter"><code><span class="type">AccessibleKeystrokeListener</span> *listener</code></em>,
<em class="parameter"><code><a class="link" href="at-spi-cspi-Registry-queries.html#AccessibleKeystrokeListenerCB" title="AccessibleKeystrokeListenerCB ()"><span class="type">AccessibleKeystrokeListenerCB</span></a> callback</code></em>);
<span class="returnvalue">SPIBoolean</span> <a class="link" href="at-spi-cspi-Registry-queries.html#AccessibleKeystrokeListener-addCallback" title="AccessibleKeystrokeListener_addCallback ()">AccessibleKeystrokeListener_addCallback</a>
(<em class="parameter"><code><span class="type">AccessibleKeystrokeListener</span> *listener</code></em>,
<em class="parameter"><code><a class="link" href="at-spi-cspi-Registry-queries.html#AccessibleKeystrokeListenerCB" title="AccessibleKeystrokeListenerCB ()"><span class="type">AccessibleKeystrokeListenerCB</span></a> callback</code></em>,
<em class="parameter"><code><span class="type">void</span> *user_data</code></em>);
<span class="returnvalue">SPIBoolean</span> <a class="link" href="at-spi-cspi-Registry-queries.html#SPI-generateKeyboardEvent" title="SPI_generateKeyboardEvent ()">SPI_generateKeyboardEvent</a> (<em class="parameter"><code>long <span class="type">int</span> keyval</code></em>,
<em class="parameter"><code><span class="type">char</span> *keystring</code></em>,
<em class="parameter"><code><a class="link" href="at-spi-cspi-Registry-queries.html#AccessibleKeySynthType" title="enum AccessibleKeySynthType"><span class="type">AccessibleKeySynthType</span></a> synth_type</code></em>);
<span class="returnvalue">SPIBoolean</span> <a class="link" href="at-spi-cspi-Registry-queries.html#SPI-generateMouseEvent" title="SPI_generateMouseEvent ()">SPI_generateMouseEvent</a> (<em class="parameter"><code>long <span class="type">int</span> x</code></em>,
<em class="parameter"><code>long <span class="type">int</span> y</code></em>,
<em class="parameter"><code><span class="type">char</span> *name</code></em>);
<a class="link" href="at-spi-cspi-Registry-queries.html#AccessibleDeviceEvent" title="AccessibleDeviceEvent">AccessibleDeviceEvent</a>;
typedef <a class="link" href="at-spi-cspi-Registry-queries.html#AccessibleDeviceEventMask" title="AccessibleDeviceEventMask">AccessibleDeviceEventMask</a>;
enum <a class="link" href="at-spi-cspi-Registry-queries.html#AccessibleDeviceEventType" title="enum AccessibleDeviceEventType">AccessibleDeviceEventType</a>;
<span class="returnvalue">SPIBoolean</span> (<a class="link" href="at-spi-cspi-Registry-queries.html#AccessibleDeviceListenerCB" title="AccessibleDeviceListenerCB ()">*AccessibleDeviceListenerCB</a>) (<em class="parameter"><code>const <a class="link" href="at-spi-cspi-Registry-queries.html#AccessibleDeviceEvent" title="AccessibleDeviceEvent"><span class="type">AccessibleDeviceEvent</span></a> *stroke</code></em>,
<em class="parameter"><code><span class="type">void</span> *user_data</code></em>);
<span class="returnvalue">AccessibleDeviceListener</span> * <a class="link" href="at-spi-cspi-Registry-queries.html#SPI-createAccessibleDeviceListener" title="SPI_createAccessibleDeviceListener ()">SPI_createAccessibleDeviceListener</a>
(<em class="parameter"><code><a class="link" href="at-spi-cspi-Registry-queries.html#AccessibleDeviceListenerCB" title="AccessibleDeviceListenerCB ()"><span class="type">AccessibleDeviceListenerCB</span></a> callback</code></em>,
<em class="parameter"><code><span class="type">void</span> *user_data</code></em>);
<span class="returnvalue">SPIBoolean</span> <a class="link" href="at-spi-cspi-Registry-queries.html#SPI-registerDeviceEventListener" title="SPI_registerDeviceEventListener ()">SPI_registerDeviceEventListener</a> (<em class="parameter"><code><span class="type">AccessibleDeviceListener</span> *listener</code></em>,
<em class="parameter"><code><a class="link" href="at-spi-cspi-Registry-queries.html#AccessibleDeviceEventMask" title="AccessibleDeviceEventMask"><span class="type">AccessibleDeviceEventMask</span></a> eventmask</code></em>,
<em class="parameter"><code><span class="type">void</span> *filter</code></em>);
<span class="returnvalue">SPIBoolean</span> <a class="link" href="at-spi-cspi-Registry-queries.html#SPI-deregisterDeviceEventListener" title="SPI_deregisterDeviceEventListener ()">SPI_deregisterDeviceEventListener</a> (<em class="parameter"><code><span class="type">AccessibleDeviceListener</span> *listener</code></em>,
<em class="parameter"><code><span class="type">void</span> *filter</code></em>);
<span class="returnvalue">SPIBoolean</span> <a class="link" href="at-spi-cspi-Registry-queries.html#AccessibleDeviceListener-addCallback" title="AccessibleDeviceListener_addCallback ()">AccessibleDeviceListener_addCallback</a>
(<em class="parameter"><code><span class="type">AccessibleDeviceListener</span> *listener</code></em>,
<em class="parameter"><code><a class="link" href="at-spi-cspi-Registry-queries.html#AccessibleDeviceListenerCB" title="AccessibleDeviceListenerCB ()"><span class="type">AccessibleDeviceListenerCB</span></a> callback</code></em>,
<em class="parameter"><code><span class="type">void</span> *user_data</code></em>);
<span class="returnvalue">SPIBoolean</span> <a class="link" href="at-spi-cspi-Registry-queries.html#AccessibleDeviceListener-removeCallback" title="AccessibleDeviceListener_removeCallback ()">AccessibleDeviceListener_removeCallback</a>
(<em class="parameter"><code><span class="type">AccessibleDeviceListener</span> *listener</code></em>,
<em class="parameter"><code><a class="link" href="at-spi-cspi-Registry-queries.html#AccessibleDeviceListenerCB" title="AccessibleDeviceListenerCB ()"><span class="type">AccessibleDeviceListenerCB</span></a> callback</code></em>);
<span class="returnvalue">void</span> <a class="link" href="at-spi-cspi-Registry-queries.html#AccessibleDeviceListener-unref" title="AccessibleDeviceListener_unref ()">AccessibleDeviceListener_unref</a> (<em class="parameter"><code><span class="type">AccessibleDeviceListener</span> *listener</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="at-spi-cspi-Registry-queries.description"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1">
<a name="at-spi-cspi-Registry-queries.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="AccessibleKeySynthType"></a><h3>enum AccessibleKeySynthType</h3>
<pre class="programlisting">typedef enum {
SPI_KEY_PRESS,
SPI_KEY_RELEASE,
SPI_KEY_PRESSRELEASE,
SPI_KEY_SYM,
SPI_KEY_STRING
} AccessibleKeySynthType;
</pre>
<p>
Specifies the type of a generated event.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><a name="SPI-KEY-PRESS:CAPS"></a><span class="term"><code class="literal">SPI_KEY_PRESS</code></span></p></td>
<td>Generates a keypress event (requires a subsequent <a class="link" href="at-spi-cspi-Registry-queries.html#SPI-KEY-RELEASE:CAPS"><span class="type">SPI_KEY_RELEASE</span></a> event)
</td>
</tr>
<tr>
<td><p><a name="SPI-KEY-RELEASE:CAPS"></a><span class="term"><code class="literal">SPI_KEY_RELEASE</code></span></p></td>
<td>Generates a key-release event
</td>
</tr>
<tr>
<td><p><a name="SPI-KEY-PRESSRELEASE:CAPS"></a><span class="term"><code class="literal">SPI_KEY_PRESSRELEASE</code></span></p></td>
<td>Generates a key press/release event pair.
</td>
</tr>
<tr>
<td><p><a name="SPI-KEY-SYM:CAPS"></a><span class="term"><code class="literal">SPI_KEY_SYM</code></span></p></td>
<td>Injects a "keysym" event into the stream, as if a press/release pair occurred; allows
the user to specify the key via its symbolic name, as opposed to simulating a hardware press of a
specific key.
</td>
</tr>
<tr>
<td><p><a name="SPI-KEY-STRING:CAPS"></a><span class="term"><code class="literal">SPI_KEY_STRING</code></span></p></td>
<td>Injects one or more keysym events into the keyboard buffer, or directly inserts
a string value into the currently focussed text widget, if the widgets supports this.
<a class="link" href="at-spi-cspi-Registry-queries.html#SPI-KEY-STRING:CAPS"><span class="type">SPI_KEY_STRING</span></a> synthesis provides a shortcut for text substring insertion, and also allows the
insertion of text which is not currently available via the current keyboard's keymap.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="SPI-getDesktopCount"></a><h3>SPI_getDesktopCount ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span> SPI_getDesktopCount (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Get the number of virtual desktops.
NOTE: currently multiple virtual desktops are not implemented, this
function always returns '1'.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>an integer indicating the number of active virtual desktops.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="SPI-getDesktop"></a><h3>SPI_getDesktop ()</h3>
<pre class="programlisting"><a class="link" href="at-spi-cspi-Accessible-Objects.html#Accessible" title="struct Accessible"><span class="returnvalue">Accessible</span></a> * SPI_getDesktop (<em class="parameter"><code><span class="type">int</span> i</code></em>);</pre>
<p>
Get the virtual desktop indicated by index <em class="parameter"><code>i</code></em>.
NOTE: currently multiple virtual desktops are not implemented, this
function always returns '1'.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>i</code></em> :</span></p></td>
<td>an integer indicating which of the accessible desktops is to be returned.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a pointer to the 'i-th' virtual desktop's <a class="link" href="at-spi-cspi-Accessible-Objects.html#Accessible" title="struct Accessible"><span class="type">Accessible</span></a> representation.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="SPI-getDesktopList"></a><h3>SPI_getDesktopList ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span> SPI_getDesktopList (<em class="parameter"><code><a class="link" href="at-spi-cspi-Accessible-Objects.html#Accessible" title="struct Accessible"><span class="type">Accessible</span></a> ***desktop_list</code></em>);</pre>
<p>
Get the list of virtual desktops. On return, <em class="parameter"><code>list</code></em> will point
to a newly-created, NULL terminated array of virtual desktop
pointers.
It is the responsibility of the caller to free this array when
it is no longer needed.
</p>
<p>
Not Yet Implemented : this implementation always returns a single
<a class="link" href="at-spi-cspi-Accessible-Objects.html#Accessible" title="struct Accessible"><span class="type">Accessible</span></a> desktop.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>desktop_list</code></em> :</span></p></td>
<td>a pointer to an array of <a class="link" href="at-spi-cspi-Accessible-Objects.html#Accessible" title="struct Accessible"><span class="type">Accessible</span></a> references.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>an integer indicating how many virtual desktops have been
placed in the list pointed to by parameter <em class="parameter"><code>list</code></em>.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="SPI-freeDesktopList"></a><h3>SPI_freeDesktopList ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> SPI_freeDesktopList (<em class="parameter"><code><a class="link" href="at-spi-cspi-Accessible-Objects.html#Accessible" title="struct Accessible"><span class="type">Accessible</span></a> **desktop_list</code></em>);</pre>
<p>
This routine frees the memory associated with the list.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>desktop_list</code></em> :</span></p></td>
<td>a pointer to an array of <a class="link" href="at-spi-cspi-Accessible-Objects.html#Accessible" title="struct Accessible"><span class="type">Accessible</span></a> objects
as returned from <em class="parameter"><code>SPI_getDesktopList</code></em>
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="AccessibleKeystrokeListenerCB"></a><h3>AccessibleKeystrokeListenerCB ()</h3>
<pre class="programlisting"><span class="returnvalue">SPIBoolean</span> (*AccessibleKeystrokeListenerCB) (<em class="parameter"><code>const <a class="link" href="at-spi-cspi-Registry-queries.html#AccessibleKeystroke" title="AccessibleKeystroke"><span class="type">AccessibleKeystroke</span></a> *stroke</code></em>,
<em class="parameter"><code><span class="type">void</span> *user_data</code></em>);</pre>
<p>
A function prototype for a callback function called when a key event notification takes place.
</p>
<p>
This is a function which is specified when creating a KeystrokeListener.
It is called when an event being listened for occurs.
If it returns TRUE, this indicates that the event should be consumed
rather than passed through; only callbacks whose listeners are
registered with the SPI_KEYLISTENER_ALL_WINDOWS or
SPI_KEYLISTENER_CANCONSUME flags can be consumed.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>stroke</code></em> :</span></p></td>
<td>the <a class="link" href="at-spi-cspi-Registry-queries.html#AccessibleKeystroke" title="AccessibleKeystroke"><span class="type">AccessibleKeystroke</span></a> event for which notification is taking place.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>data passed to the callback each time it is notified, according to the data
which was passed in when the listener/callback was registered.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<code class="literal">TRUE</code> if the client wishes to consume the event and prevent its
dispatch to other listeners or the currently focussed application, if
the relevant callback was registered with the <a class="link" href="at-spi-cspi-Registry-queries.html#SPI-KEYLISTENER-CANCONSUME:CAPS"><span class="type">SPI_KEYLISTENER_CANCONSUME</span></a> flag.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="AccessibleKeyEventMask"></a><h3>AccessibleKeyEventMask</h3>
<pre class="programlisting">typedef unsigned long AccessibleKeyEventMask;
</pre>
<p>
AccessibleKeyEventMask is a set of types of key events. It is used
in SPI_registerAccessibleKeystroketListener to specify the events to be
listener for.
</p>
</div>
<hr>
<div class="refsect2">
<a name="AccessibleModifierMaskType"></a><h3>AccessibleModifierMaskType</h3>
<pre class="programlisting">typedef unsigned long AccessibleModifierMaskType;
</pre>
<p>
AccessibleModifierMaskType is a synonym for AccessibleKeymaskType.
The defined values for AccessibleModifierMaskType can be found in
libspi/keymasks.h.
</p>
</div>
<hr>
<div class="refsect2">
<a name="AccessibleKeyMaskType"></a><h3>AccessibleKeyMaskType</h3>
<pre class="programlisting">typedef AccessibleModifierMaskType AccessibleKeyMaskType;
</pre>
<p>
AccessibleKeyMaskType is a mask which is a set of key event modifiers
which is specified in SPI_registerAccessibleKeystrokeListener.
</p>
</div>
<hr>
<div class="refsect2">
<a name="AccessibleKeyEventType"></a><h3>AccessibleKeyEventType</h3>
<pre class="programlisting">typedef AccessibleDeviceEventType AccessibleKeyEventType;
</pre>
<p>
This is a synonym for AccessibleDeviceEventType
</p>
</div>
<hr>
<div class="refsect2">
<a name="AccessibleKeyListenerSyncType"></a><h3>enum AccessibleKeyListenerSyncType</h3>
<pre class="programlisting">typedef enum {
SPI_KEYLISTENER_NOSYNC = 0,
SPI_KEYLISTENER_SYNCHRONOUS = 1,
SPI_KEYLISTENER_CANCONSUME = 2,
SPI_KEYLISTENER_ALL_WINDOWS = 4
} AccessibleKeyListenerSyncType;
</pre>
<p>
Specified the tyupe of a key listener event.
Certain of the values above can and should be bitwise-'OR'ed
together, observing the compatibility limitations specified in the description of
each value. For instance, <a class="link" href="at-spi-cspi-Registry-queries.html#SPI-KEYLISTENER-ALL-WINDOWS:CAPS"><span class="type">SPI_KEYLISTENER_ALL_WINDOWS</span></a> | <a class="link" href="at-spi-cspi-Registry-queries.html#SPI-KEYLISTENER-CANCONSUME:CAPS"><span class="type">SPI_KEYLISTENER_CANCONSUME</span></a> is
a commonly used combination which gives the AT complete control over the delivery of matching
events. However, such filters should be used sparingly as they may have a negative impact on
system performance.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><a name="SPI-KEYLISTENER-NOSYNC:CAPS"></a><span class="term"><code class="literal">SPI_KEYLISTENER_NOSYNC</code></span></p></td>
<td>Events may be delivered asynchronously,
which means in some cases they may already have been delivered to the
application before the AT client receives the notification.
</td>
</tr>
<tr>
<td><p><a name="SPI-KEYLISTENER-SYNCHRONOUS:CAPS"></a><span class="term"><code class="literal">SPI_KEYLISTENER_SYNCHRONOUS</code></span></p></td>
<td>Events are delivered synchronously, before the
currently focussed application sees them.
</td>
</tr>
<tr>
<td><p><a name="SPI-KEYLISTENER-CANCONSUME:CAPS"></a><span class="term"><code class="literal">SPI_KEYLISTENER_CANCONSUME</code></span></p></td>
<td>Events may be consumed by the AT client. Presumes and
requires <a class="link" href="at-spi-cspi-Registry-queries.html#SPI-KEYLISTENER-SYNCHRONOUS:CAPS"><span class="type">SPI_KEYLISTENER_SYNCHRONOUS</span></a>, incompatible with <a class="link" href="at-spi-cspi-Registry-queries.html#SPI-KEYLISTENER-NOSYNC:CAPS"><span class="type">SPI_KEYLISTENER_NOSYNC</span></a>.
</td>
</tr>
<tr>
<td><p><a name="SPI-KEYLISTENER-ALL-WINDOWS:CAPS"></a><span class="term"><code class="literal">SPI_KEYLISTENER_ALL_WINDOWS</code></span></p></td>
<td>Events are received not from the application toolkit layer, but
from the device driver or windowing system subsystem; such notifications are 'global' in the
sense that they are not broken or defeated by applications that participate poorly
in the accessibility APIs, or not at all; however because of the intrusive nature of
such snooping, it can have side-effects on certain older platforms. If unconditional
event notifications, even when inaccessible or "broken" applications have focus, are not
required, it may be best to avoid this enum value/flag.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="AccessibleKeystroke"></a><h3>AccessibleKeystroke</h3>
<pre class="programlisting">typedef AccessibleDeviceEvent AccessibleKeystroke;
</pre>
<p>
This is a synonym for AccessibleDeviceEvent.
</p>
</div>
<hr>
<div class="refsect2">
<a name="SPI-createAccessibleKeySet"></a><h3>SPI_createAccessibleKeySet ()</h3>
<pre class="programlisting"><span class="returnvalue">AccessibleKeySet</span> * SPI_createAccessibleKeySet (<em class="parameter"><code><span class="type">int</span> len</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *keysyms</code></em>,
<em class="parameter"><code><span class="type">short</span> *keycodes</code></em>,
<em class="parameter"><code>const <span class="type">char</span> **keystrings</code></em>);</pre>
<p>
Create a new <span class="type">AccessibleKeySet</span> of a specified length.
A KeySet is used typically to match key event values, and a matches are made
using the following criteria: a match exists with a key event if all non-null
i-th members of the keyset match the key event.
If both keystring and keysym values are NULL, a keycode value match is
forced, thus the match for keysym=0, keycode=0, keystring=NULL is
keycode 0.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>len</code></em> :</span></p></td>
<td>the number of key values in the key set.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>keysyms</code></em> :</span></p></td>
<td>a UTF-8 string containing symbolic key values to be matched, or NULL if
matching is performed against other key values instead.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>keycodes</code></em> :</span></p></td>
<td>an array of unsigned short values which are the hardware keycodes
to be matched, or NULL if the keyset is specified solely by keysyms
and/or keystrings.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>keystrings</code></em> :</span></p></td>
<td>an array of null-terminated character strings which specify key
name values to match, or NULL if the keyset is specified solely by
keycodes and/or keysyms.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a pointer to a newly-created <span class="type">AccessibleKeySet</span>.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="SPI-freeAccessibleKeySet"></a><h3>SPI_freeAccessibleKeySet ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> SPI_freeAccessibleKeySet (<em class="parameter"><code><span class="type">AccessibleKeySet</span> *keyset</code></em>);</pre>
<p>
Release the memory used by an AccessibleKeySet.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>keyset</code></em> :</span></p></td>
<td>An AccessibleKeyset to free.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="SPI-createAccessibleKeystrokeListener"></a><h3>SPI_createAccessibleKeystrokeListener ()</h3>
<pre class="programlisting"><span class="returnvalue">AccessibleKeystrokeListener</span> * SPI_createAccessibleKeystrokeListener
(<em class="parameter"><code><a class="link" href="at-spi-cspi-Registry-queries.html#AccessibleKeystrokeListenerCB" title="AccessibleKeystrokeListenerCB ()"><span class="type">AccessibleKeystrokeListenerCB</span></a> callback</code></em>,
<em class="parameter"><code><span class="type">void</span> *user_data</code></em>);</pre>
<p>
Create a new <span class="type">AccessibleKeystrokeListener</span> with a specified callback function.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>callback</code></em> :</span></p></td>
<td>an <a class="link" href="at-spi-cspi-Registry-queries.html#AccessibleKeystrokeListenerCB" title="AccessibleKeystrokeListenerCB ()"><span class="type">AccessibleKeystrokeListenerCB</span></a> callback function, or NULL.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>a pointer to data which will be passed to the callback when invoked.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a pointer to a newly-created <span class="type">AccessibleKeystrokeListener</span>.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="SPI-registerGlobalEventListener"></a><h3>SPI_registerGlobalEventListener ()</h3>
<pre class="programlisting"><span class="returnvalue">SPIBoolean</span> SPI_registerGlobalEventListener (<em class="parameter"><code><span class="type">AccessibleEventListener</span> *listener</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *eventType</code></em>);</pre>
<p>
Legal object event types:
</p>
<p>
(property change events)
</p>
<p>
object:property-change
object:property-change:accessible-name
object:property-change:accessible-description
object:property-change:accessible-parent
object:property-change:accessible-value
object:property-change:accessible-role
object:property-change:accessible-table-caption
object:property-change:accessible-table-column-description
object:property-change:accessible-table-column-header
object:property-change:accessible-table-row-description
object:property-change:accessible-table-row-header
object:property-change:accessible-table-summary
</p>
<p>
(other object events)
</p>
<p>
object:state-changed
object:children-changed
object:visible-data-changed
object:selection-changed
object:text-selection-changed
object:text-changed
object:text-caret-moved
object:row-inserted
object:row-reordered
object:row-deleted
object:column-inserted
object:column-reordered
object:column-deleted
object:model-changed
object:active-descendant-changed
</p>
<p>
(window events)
</p>
<p>
window:minimize
window:maximize
window:restore
window:close
window:create
window:reparent
window:desktop-create
window:desktop-destroy
window:activate
window:deactivate
window:raise
window:lower
window:move
window:resize
window:shade
window:unshade
window:restyle
</p>
<p>
(other events)
</p>
<p>
focus:
mouse:abs
mouse:rel
mouse:b1p
mouse:b1r
mouse:b2p
mouse:b2r
mouse:b3p
mouse:b3r
</p>
<p>
NOTE: this string may be UTF-8, but should not contain byte value 56
(ascii ':'), except as a delimiter, since non-UTF-8 string
delimiting functions are used internally.
In general, listening to
toolkit-specific events is not recommended.
</p>
<p>
Add an in-process callback function to an existing AccessibleEventListener.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>listener</code></em> :</span></p></td>
<td>the <span class="type">AccessibleEventListener</span> to be registered against an
event type.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>eventType</code></em> :</span></p></td>
<td>a character string indicating the type of events for which
notification is requested. Format is
EventClass:major_type:minor_type:detail
where all subfields other than EventClass are optional.
EventClasses include "object", "window", "mouse",
and toolkit events (e.g. "Gtk", "AWT").
Examples: "focus:", "Gtk:GtkWidget:button-press-event".</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<span class="type">TRUE</span> if successful, otherwise <span class="type">FALSE</span>.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="SPI-deregisterGlobalEventListener"></a><h3>SPI_deregisterGlobalEventListener ()</h3>
<pre class="programlisting"><span class="returnvalue">SPIBoolean</span> SPI_deregisterGlobalEventListener (<em class="parameter"><code><span class="type">AccessibleEventListener</span> *listener</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *eventType</code></em>);</pre>
<p>
deregisters an AccessibleEventListener from the registry, for a specific
event type.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>listener</code></em> :</span></p></td>
<td>the <span class="type">AccessibleEventListener</span> registered against an event type.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>eventType</code></em> :</span></p></td>
<td>a string specifying the event type for which this
listener is to be deregistered.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<span class="type">TRUE</span> if successful, otherwise <span class="type">FALSE</span>.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="SPI-deregisterGlobalEventListenerAll"></a><h3>SPI_deregisterGlobalEventListenerAll ()</h3>
<pre class="programlisting"><span class="returnvalue">SPIBoolean</span> SPI_deregisterGlobalEventListenerAll
(<em class="parameter"><code><span class="type">AccessibleEventListener</span> *listener</code></em>);</pre>
<p>
deregisters an AccessibleEventListener from the registry, for all
event types it may be listening to. Use
AccessibleEventListener_unref to release the
listener reference.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>listener</code></em> :</span></p></td>
<td>the <span class="type">AccessibleEventListener</span> to be registered against
an event type.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<span class="type">TRUE</span> if successful, otherwise <span class="type">FALSE</span>.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="SPI-registerAccessibleKeystrokeListener"></a><h3>SPI_registerAccessibleKeystrokeListener ()</h3>
<pre class="programlisting"><span class="returnvalue">SPIBoolean</span> SPI_registerAccessibleKeystrokeListener
(<em class="parameter"><code><span class="type">AccessibleKeystrokeListener</span> *listener</code></em>,
<em class="parameter"><code><span class="type">AccessibleKeySet</span> *keys</code></em>,
<em class="parameter"><code><a class="link" href="at-spi-cspi-Registry-queries.html#AccessibleKeyMaskType" title="AccessibleKeyMaskType"><span class="type">AccessibleKeyMaskType</span></a> modmask</code></em>,
<em class="parameter"><code><a class="link" href="at-spi-cspi-Registry-queries.html#AccessibleKeyEventMask" title="AccessibleKeyEventMask"><span class="type">AccessibleKeyEventMask</span></a> eventmask</code></em>,
<em class="parameter"><code><a class="link" href="at-spi-cspi-Registry-queries.html#AccessibleKeyListenerSyncType" title="enum AccessibleKeyListenerSyncType"><span class="type">AccessibleKeyListenerSyncType</span></a> sync_type</code></em>);</pre>
<p>
Register a listener for keystroke events, either pre-emptively for
all windows (SPI_KEYLISTENER_ALL_WINDOWS),
non-preemptively (SPI_KEYLISTENER_NOSYNC), or
pre-emptively at the toolkit level (SPI_KEYLISTENER_CANCONSUME).
If ALL_WINDOWS or CANCONSUME are used, the event is consumed
upon receipt if one of <em class="parameter"><code>listener</code></em>'s callbacks returns <span class="type">TRUE</span>.
( Other sync_type values may be available in the future )
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>listener</code></em> :</span></p></td>
<td>a pointer to the <span class="type">AccessibleKeystrokeListener</span> for which
keystroke events are requested.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>keys</code></em> :</span></p></td>
<td>a pointer to the <span class="type">AccessibleKeySet</span> indicating which
keystroke events are requested, or <span class="type">SPI_KEYSET_ALL_KEYS</span>
to indicate that all keycodes and keyvals for the specified
modifier set are to be included.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>modmask</code></em> :</span></p></td>
<td>an <a class="link" href="at-spi-cspi-Registry-queries.html#AccessibleKeyMaskType" title="AccessibleKeyMaskType"><span class="type">AccessibleKeyMaskType</span></a> mask indicating which
key event modifiers must be set in combination with <em class="parameter"><code>keys</code></em>,
events will only be reported for key events for which all
modifiers in <em class="parameter"><code>modmask</code></em> are set. If you wish to listen for
events with multiple modifier combinations you must call
<code class="function">registerAccessibleKeystrokeListener()</code> once for each combination.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>eventmask</code></em> :</span></p></td>
<td>an <a class="link" href="at-spi-cspi-Registry-queries.html#AccessibleKeyMaskType" title="AccessibleKeyMaskType"><span class="type">AccessibleKeyMaskType</span></a> mask indicating which
types of key events are requested (<a class="link" href="at-spi-cspi-Registry-queries.html#SPI-KEY-PRESSED:CAPS"><span class="type">SPI_KEY_PRESSED</span></a>, etc.).</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>sync_type</code></em> :</span></p></td>
<td>a <a class="link" href="at-spi-cspi-Registry-queries.html#AccessibleKeyListenerSyncType" title="enum AccessibleKeyListenerSyncType"><span class="type">AccessibleKeyListenerSyncType</span></a> parameter indicating
the behavior of the notification/listener transaction.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<span class="type">TRUE</span> if successful, otherwise <span class="type">FALSE</span>.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="SPI-deregisterAccessibleKeystrokeListener"></a><h3>SPI_deregisterAccessibleKeystrokeListener ()</h3>
<pre class="programlisting"><span class="returnvalue">SPIBoolean</span> SPI_deregisterAccessibleKeystrokeListener
(<em class="parameter"><code><span class="type">AccessibleKeystrokeListener</span> *listener</code></em>,
<em class="parameter"><code><a class="link" href="at-spi-cspi-Registry-queries.html#AccessibleKeyMaskType" title="AccessibleKeyMaskType"><span class="type">AccessibleKeyMaskType</span></a> modmask</code></em>);</pre>
<p>
Removes a keystroke event listener from the registry's listener queue,
ceasing notification of events with modifiers matching <em class="parameter"><code>modmask</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>listener</code></em> :</span></p></td>
<td>a pointer to the <span class="type">AccessibleKeystrokeListener</span> for which
keystroke events are requested.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>modmask</code></em> :</span></p></td>
<td>the key modifier mask for which this listener is to be
'deregistered' (of type <span class="type">AccessibleeyMaskType</span>).</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<span class="type">TRUE</span> if successful, otherwise <span class="type">FALSE</span>.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="AccessibleKeystrokeListener-unref"></a><h3>AccessibleKeystrokeListener_unref ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> AccessibleKeystrokeListener_unref (<em class="parameter"><code><span class="type">AccessibleKeystrokeListener</span> *listener</code></em>);</pre>
<p>
Decrements an <span class="type">AccessibleKeystrokeListener</span>'s reference count.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>listener</code></em> :</span></p></td>
<td>a pointer to the <span class="type">AccessibleKeystrokeListener</span> being operated on.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="AccessibleKeystrokeListener-removeCallback"></a><h3>AccessibleKeystrokeListener_removeCallback ()</h3>
<pre class="programlisting"><span class="returnvalue">SPIBoolean</span> AccessibleKeystrokeListener_removeCallback
(<em class="parameter"><code><span class="type">AccessibleKeystrokeListener</span> *listener</code></em>,
<em class="parameter"><code><a class="link" href="at-spi-cspi-Registry-queries.html#AccessibleKeystrokeListenerCB" title="AccessibleKeystrokeListenerCB ()"><span class="type">AccessibleKeystrokeListenerCB</span></a> callback</code></em>);</pre>
<p>
Remove an in-process callback function from an existing <span class="type">AccessibleKeystrokeListener</span>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>listener</code></em> :</span></p></td>
<td>the <span class="type">AccessibleKeystrokeListener</span> instance to modify.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>callback</code></em> :</span></p></td>
<td>an <a class="link" href="at-spi-cspi-Registry-queries.html#AccessibleKeystrokeListenerCB" title="AccessibleKeystrokeListenerCB ()"><span class="type">AccessibleKeystrokeListenerCB</span></a> function pointer.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<span class="type">TRUE</span> if successful, otherwise <span class="type">FALSE</span>.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="AccessibleKeystrokeListener-addCallback"></a><h3>AccessibleKeystrokeListener_addCallback ()</h3>
<pre class="programlisting"><span class="returnvalue">SPIBoolean</span> AccessibleKeystrokeListener_addCallback
(<em class="parameter"><code><span class="type">AccessibleKeystrokeListener</span> *listener</code></em>,
<em class="parameter"><code><a class="link" href="at-spi-cspi-Registry-queries.html#AccessibleKeystrokeListenerCB" title="AccessibleKeystrokeListenerCB ()"><span class="type">AccessibleKeystrokeListenerCB</span></a> callback</code></em>,
<em class="parameter"><code><span class="type">void</span> *user_data</code></em>);</pre>
<p>
Add an in-process callback function to an existing <span class="type">AccessibleKeystrokeListener</span>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>listener</code></em> :</span></p></td>
<td>the <span class="type">AccessibleKeystrokeListener</span> instance to modify.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>callback</code></em> :</span></p></td>
<td>an <a class="link" href="at-spi-cspi-Registry-queries.html#AccessibleKeystrokeListenerCB" title="AccessibleKeystrokeListenerCB ()"><span class="type">AccessibleKeystrokeListenerCB</span></a> function pointer.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>a pointer to data which will be passed to the callback when invoked.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<span class="type">TRUE</span> if successful, otherwise <span class="type">FALSE</span>.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="SPI-generateKeyboardEvent"></a><h3>SPI_generateKeyboardEvent ()</h3>
<pre class="programlisting"><span class="returnvalue">SPIBoolean</span> SPI_generateKeyboardEvent (<em class="parameter"><code>long <span class="type">int</span> keyval</code></em>,
<em class="parameter"><code><span class="type">char</span> *keystring</code></em>,
<em class="parameter"><code><a class="link" href="at-spi-cspi-Registry-queries.html#AccessibleKeySynthType" title="enum AccessibleKeySynthType"><span class="type">AccessibleKeySynthType</span></a> synth_type</code></em>);</pre>
<p>
Synthesize a keyboard event (as if a hardware keyboard event occurred in the
current UI context).
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>keyval</code></em> :</span></p></td>
<td>a long integer indicating the keycode or keysym of the key event
being synthesized.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>keystring</code></em> :</span></p></td>
<td>an (optional) UTF-8 string which, if <em class="parameter"><code>keyval</code></em> is NULL,
indicates a 'composed' keyboard input string which is
being synthesized; this type of keyboard event synthesis does
not emulate hardware keypresses but injects the string
as though a composing input method (such as XIM) were used.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>synth_type</code></em> :</span></p></td>
<td>a <a class="link" href="at-spi-cspi-Registry-queries.html#AccessibleKeySynthType" title="enum AccessibleKeySynthType"><span class="type">AccessibleKeySynthType</span></a> flag indicating whether <em class="parameter"><code>keyval</code></em>
is to be interpreted as a keysym rather than a keycode
(CSPI_KEYSYM), or whether to synthesize
SPI_KEY_PRESS, SPI_KEY_RELEASE, or both (SPI_KEY_PRESSRELEASE).</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<span class="type">TRUE</span> if successful, otherwise <span class="type">FALSE</span>.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="SPI-generateMouseEvent"></a><h3>SPI_generateMouseEvent ()</h3>
<pre class="programlisting"><span class="returnvalue">SPIBoolean</span> SPI_generateMouseEvent (<em class="parameter"><code>long <span class="type">int</span> x</code></em>,
<em class="parameter"><code>long <span class="type">int</span> y</code></em>,
<em class="parameter"><code><span class="type">char</span> *name</code></em>);</pre>
<p>
Synthesize a mouse event at a specific screen coordinate.
Most AT clients should use the <span class="type">AccessibleAction</span> interface when
tempted to generate mouse events, rather than this method.
Event names: b1p = button 1 press; b2r = button 2 release;
b3c = button 3 click; b2d = button 2 double-click;
abs = absolute motion; rel = relative motion.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>x</code></em> :</span></p></td>
<td>a <span class="type">long</span> indicating the screen x coordinate of the mouse event.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>y</code></em> :</span></p></td>
<td>a <span class="type">long</span> indicating the screen y coordinate of the mouse event.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
<td>a string indicating which mouse event to be synthesized
(e.g. "b1p", "b1c", "b2r", "rel", "abs").</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<span class="type">TRUE</span> if successful, otherwise <span class="type">FALSE</span>.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="AccessibleDeviceEvent"></a><h3>AccessibleDeviceEvent</h3>
<pre class="programlisting">typedef struct {
long keyID;
short keycode;
char * keystring;
long timestamp;
AccessibleDeviceEventType type;
unsigned short modifiers;
SPIBoolean is_text;
} AccessibleDeviceEvent;
</pre>
<p>
A structure encapsulating information relevant to a device event notification.
</p>
<p>
AccessibleDeviceEvent is a struct which encapsulates a device event.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><span class="type">char</span> *<em class="structfield"><code><a name="AccessibleDeviceEvent.keystring"></a>keystring</code></em>;</span></p></td>
<td>A symbolic name for the key or switch, or, if is_text is true, a string approximating the
inserted text characters which would result from this event, if a text entry field has keyboard focus.</td>
</tr>
<tr>
<td><p><span class="term"><a class="link" href="at-spi-cspi-Registry-queries.html#AccessibleDeviceEventType" title="enum AccessibleDeviceEventType"><span class="type">AccessibleDeviceEventType</span></a> <em class="structfield"><code><a name="AccessibleDeviceEvent.type"></a>type</code></em>;</span></p></td>
<td>The <a class="link" href="at-spi-cspi-Registry-queries.html#AccessibleDeviceEventType" title="enum AccessibleDeviceEventType"><span class="type">AccessibleDeviceEventType</span></a> identifying the specific type of event.</td>
</tr>
<tr>
<td><p><span class="term">unsigned <span class="type">short</span> <em class="structfield"><code><a name="AccessibleDeviceEvent.modifiers"></a>modifiers</code></em>;</span></p></td>
<td></td>
</tr>
<tr>
<td><p><span class="term"><span class="type">SPIBoolean</span> <em class="structfield"><code><a name="AccessibleDeviceEvent.is-text"></a>is_text</code></em>;</span></p></td>
<td>A boolean value indicating whether the event represents 'printable' text (i.e. whether it
changes the current insertion buffer of a focussed text entry component or not). Whitespace
is considered "printable" in this context, since it typically inserts characters into the buffer.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="AccessibleDeviceEventMask"></a><h3>AccessibleDeviceEventMask</h3>
<pre class="programlisting">typedef unsigned long AccessibleDeviceEventMask;
</pre>
<p>
AccessibleDeviceEventMask is a set of types of key events. It is used
in SPI_registerDeviceEventListener to specify the events to be listener for.
</p>
</div>
<hr>
<div class="refsect2">
<a name="AccessibleDeviceEventType"></a><h3>enum AccessibleDeviceEventType</h3>
<pre class="programlisting">typedef enum {
SPI_KEY_PRESSED = 1<<0,
SPI_KEY_RELEASED = 1<<1,
SPI_BUTTON_PRESSED = 1<<2,
SPI_BUTTON_RELEASED = 1<<3
} AccessibleDeviceEventType;
</pre>
<p>
The type of an AccessibleDeviceEvent.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><a name="SPI-KEY-PRESSED:CAPS"></a><span class="term"><code class="literal">SPI_KEY_PRESSED</code></span></p></td>
<td>A device key has been pressed.
</td>
</tr>
<tr>
<td><p><a name="SPI-KEY-RELEASED:CAPS"></a><span class="term"><code class="literal">SPI_KEY_RELEASED</code></span></p></td>
<td>A device key has been released.
</td>
</tr>
<tr>
<td><p><a name="SPI-BUTTON-PRESSED:CAPS"></a><span class="term"><code class="literal">SPI_BUTTON_PRESSED</code></span></p></td>
<td>A device button or switch (other than a keyboard key)
has been pressed.
</td>
</tr>
<tr>
<td><p><a name="SPI-BUTTON-RELEASED:CAPS"></a><span class="term"><code class="literal">SPI_BUTTON_RELEASED</code></span></p></td>
<td>A device button or switch has been released.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="AccessibleDeviceListenerCB"></a><h3>AccessibleDeviceListenerCB ()</h3>
<pre class="programlisting"><span class="returnvalue">SPIBoolean</span> (*AccessibleDeviceListenerCB) (<em class="parameter"><code>const <a class="link" href="at-spi-cspi-Registry-queries.html#AccessibleDeviceEvent" title="AccessibleDeviceEvent"><span class="type">AccessibleDeviceEvent</span></a> *stroke</code></em>,
<em class="parameter"><code><span class="type">void</span> *user_data</code></em>);</pre>
<p>
A callback function prototype via which clients receive device event notifications.
</p>
<p>
This is a function which is specified when creating a DeviceListener.
It is called when an event being listened for occurs.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>stroke</code></em> :</span></p></td>
<td>The <a class="link" href="at-spi-cspi-Registry-queries.html#AccessibleDeviceEvent" title="AccessibleDeviceEvent"><span class="type">AccessibleDeviceEvent</span></a> for which notification is being received.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>Data which is passed to the client each time this callback is notified.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<code class="literal">TRUE</code> if the client wishes to consume/preempt the event, preventing it from being
relayed to the currently focussed application, <code class="literal">FALSE</code> if the event delivery should proceed as normal.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="SPI-createAccessibleDeviceListener"></a><h3>SPI_createAccessibleDeviceListener ()</h3>
<pre class="programlisting"><span class="returnvalue">AccessibleDeviceListener</span> * SPI_createAccessibleDeviceListener
(<em class="parameter"><code><a class="link" href="at-spi-cspi-Registry-queries.html#AccessibleDeviceListenerCB" title="AccessibleDeviceListenerCB ()"><span class="type">AccessibleDeviceListenerCB</span></a> callback</code></em>,
<em class="parameter"><code><span class="type">void</span> *user_data</code></em>);</pre>
<p>
Create a new <span class="type">AccessibleDeviceListener</span> with a specified callback function.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>callback</code></em> :</span></p></td>
<td>an <a class="link" href="at-spi-cspi-Registry-queries.html#AccessibleDeviceListenerCB" title="AccessibleDeviceListenerCB ()"><span class="type">AccessibleDeviceListenerCB</span></a> callback function, or NULL.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>a pointer to data which will be passed to the callback when invoked.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a pointer to a newly-created <span class="type">AccessibleDeviceListener</span>.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="SPI-registerDeviceEventListener"></a><h3>SPI_registerDeviceEventListener ()</h3>
<pre class="programlisting"><span class="returnvalue">SPIBoolean</span> SPI_registerDeviceEventListener (<em class="parameter"><code><span class="type">AccessibleDeviceListener</span> *listener</code></em>,
<em class="parameter"><code><a class="link" href="at-spi-cspi-Registry-queries.html#AccessibleDeviceEventMask" title="AccessibleDeviceEventMask"><span class="type">AccessibleDeviceEventMask</span></a> eventmask</code></em>,
<em class="parameter"><code><span class="type">void</span> *filter</code></em>);</pre>
<p>
Register a listener for device events, for instance button events.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>listener</code></em> :</span></p></td>
<td>a pointer to the <span class="type">AccessibleDeviceListener</span> which requests
the events.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>eventmask</code></em> :</span></p></td>
<td>an <a class="link" href="at-spi-cspi-Registry-queries.html#AccessibleDeviceEventMask" title="AccessibleDeviceEventMask"><span class="type">AccessibleDeviceEventMask</span></a> mask indicating which
types of key events are requested (<a class="link" href="at-spi-cspi-Registry-queries.html#SPI-KEY-PRESSED:CAPS"><span class="type">SPI_KEY_PRESSED</span></a>, etc.).</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>filter</code></em> :</span></p></td>
<td>Unused parameter.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<span class="type">TRUE</span> if successful, otherwise <span class="type">FALSE</span>.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="SPI-deregisterDeviceEventListener"></a><h3>SPI_deregisterDeviceEventListener ()</h3>
<pre class="programlisting"><span class="returnvalue">SPIBoolean</span> SPI_deregisterDeviceEventListener (<em class="parameter"><code><span class="type">AccessibleDeviceListener</span> *listener</code></em>,
<em class="parameter"><code><span class="type">void</span> *filter</code></em>);</pre>
<p>
Removes a device event listener from the registry's listener queue,
ceasing notification of events of the specified type.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>listener</code></em> :</span></p></td>
<td>a pointer to the <span class="type">AccessibleDeviceListener</span> for which
device events are requested.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>filter</code></em> :</span></p></td>
<td>Unused parameter.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<span class="type">TRUE</span> if successful, otherwise <span class="type">FALSE</span>.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="AccessibleDeviceListener-addCallback"></a><h3>AccessibleDeviceListener_addCallback ()</h3>
<pre class="programlisting"><span class="returnvalue">SPIBoolean</span> AccessibleDeviceListener_addCallback
(<em class="parameter"><code><span class="type">AccessibleDeviceListener</span> *listener</code></em>,
<em class="parameter"><code><a class="link" href="at-spi-cspi-Registry-queries.html#AccessibleDeviceListenerCB" title="AccessibleDeviceListenerCB ()"><span class="type">AccessibleDeviceListenerCB</span></a> callback</code></em>,
<em class="parameter"><code><span class="type">void</span> *user_data</code></em>);</pre>
<p>
Add an in-process callback function to an existing <span class="type">AccessibleDeviceListener</span>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>listener</code></em> :</span></p></td>
<td>the <span class="type">AccessibleDeviceListener</span> instance to modify.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>callback</code></em> :</span></p></td>
<td>an <a class="link" href="at-spi-cspi-Registry-queries.html#AccessibleDeviceListenerCB" title="AccessibleDeviceListenerCB ()"><span class="type">AccessibleDeviceListenerCB</span></a> function pointer.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>a pointer to data which will be passed to the callback when invoked.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<span class="type">TRUE</span> if successful, otherwise <span class="type">FALSE</span>.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="AccessibleDeviceListener-removeCallback"></a><h3>AccessibleDeviceListener_removeCallback ()</h3>
<pre class="programlisting"><span class="returnvalue">SPIBoolean</span> AccessibleDeviceListener_removeCallback
(<em class="parameter"><code><span class="type">AccessibleDeviceListener</span> *listener</code></em>,
<em class="parameter"><code><a class="link" href="at-spi-cspi-Registry-queries.html#AccessibleDeviceListenerCB" title="AccessibleDeviceListenerCB ()"><span class="type">AccessibleDeviceListenerCB</span></a> callback</code></em>);</pre>
<p>
Remove an in-process callback function from an existing <span class="type">AccessibleDeviceListener</span>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>listener</code></em> :</span></p></td>
<td>the <span class="type">AccessibleDeviceListener</span> instance to modify.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>callback</code></em> :</span></p></td>
<td>an <a class="link" href="at-spi-cspi-Registry-queries.html#AccessibleDeviceListenerCB" title="AccessibleDeviceListenerCB ()"><span class="type">AccessibleDeviceListenerCB</span></a> function pointer.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<span class="type">TRUE</span> if successful, otherwise <span class="type">FALSE</span>.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="AccessibleDeviceListener-unref"></a><h3>AccessibleDeviceListener_unref ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> AccessibleDeviceListener_unref (<em class="parameter"><code><span class="type">AccessibleDeviceListener</span> *listener</code></em>);</pre>
<p>
Decrements an <span class="type">AccessibleDeviceListener</span>'s reference count.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>listener</code></em> :</span></p></td>
<td>a pointer to the <span class="type">AccessibleDeviceListener</span> being operated on.</td>
</tr></tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.18</div>
</body>
</html>
|