/usr/share/gtk-doc/html/gedit/GeditMessageBus.html is in gedit-dev 3.4.1-0ubuntu1.
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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GeditMessageBus</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="gedit Reference Manual">
<link rel="up" href="ch01.html" title="gedit">
<link rel="prev" href="gedit-gedit-file-chooser-dialog.html" title="GeditFileChooserDialog">
<link rel="next" href="gedit-GeditMessageType.html" title="GeditMessageType">
<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="gedit-gedit-file-chooser-dialog.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch01.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">gedit Reference Manual</th>
<td><a accesskey="n" href="gedit-GeditMessageType.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#GeditMessageBus.synopsis" class="shortcut">Top</a>
|
<a href="#GeditMessageBus.description" class="shortcut">Description</a>
|
<a href="#GeditMessageBus.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#GeditMessageBus.signals" class="shortcut">Signals</a>
</td></tr>
</table>
<div class="refentry">
<a name="GeditMessageBus"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GeditMessageBus.top_of_page"></a>GeditMessageBus</span></h2>
<p>GeditMessageBus — internal message communication bus</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="GeditMessageBus.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include <gedit/gedit-message-bus.h>
struct <a class="link" href="GeditMessageBus.html#GeditMessageBus-struct" title="struct GeditMessageBus">GeditMessageBus</a>;
<span class="returnvalue">void</span> (<a class="link" href="GeditMessageBus.html#GeditMessageCallback" title="GeditMessageCallback ()">*GeditMessageCallback</a>) (<em class="parameter"><code><a class="link" href="GeditMessageBus.html" title="GeditMessageBus"><span class="type">GeditMessageBus</span></a> *bus</code></em>,
<em class="parameter"><code><a class="link" href="GeditMessage.html" title="GeditMessage"><span class="type">GeditMessage</span></a> *message</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);
<a class="link" href="GeditMessageBus.html" title="GeditMessageBus"><span class="returnvalue">GeditMessageBus</span></a> * <a class="link" href="GeditMessageBus.html#gedit-message-bus-get-default" title="gedit_message_bus_get_default ()">gedit_message_bus_get_default</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
<a class="link" href="GeditMessageBus.html" title="GeditMessageBus"><span class="returnvalue">GeditMessageBus</span></a> * <a class="link" href="GeditMessageBus.html#gedit-message-bus-new" title="gedit_message_bus_new ()">gedit_message_bus_new</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
<a href="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#GType"><span class="returnvalue">GType</span></a> <a class="link" href="GeditMessageBus.html#gedit-message-bus-lookup" title="gedit_message_bus_lookup ()">gedit_message_bus_lookup</a> (<em class="parameter"><code><a class="link" href="GeditMessageBus.html" title="GeditMessageBus"><span class="type">GeditMessageBus</span></a> *bus</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *object_path</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *method</code></em>);
<span class="returnvalue">void</span> <a class="link" href="GeditMessageBus.html#gedit-message-bus-register" title="gedit_message_bus_register ()">gedit_message_bus_register</a> (<em class="parameter"><code><a class="link" href="GeditMessageBus.html" title="GeditMessageBus"><span class="type">GeditMessageBus</span></a> *bus</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#GType"><span class="type">GType</span></a> message_type</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *object_path</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *method</code></em>);
<span class="returnvalue">void</span> <a class="link" href="GeditMessageBus.html#gedit-message-bus-unregister" title="gedit_message_bus_unregister ()">gedit_message_bus_unregister</a> (<em class="parameter"><code><a class="link" href="GeditMessageBus.html" title="GeditMessageBus"><span class="type">GeditMessageBus</span></a> *bus</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *object_path</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *method</code></em>);
<span class="returnvalue">void</span> <a class="link" href="GeditMessageBus.html#gedit-message-bus-unregister-all" title="gedit_message_bus_unregister_all ()">gedit_message_bus_unregister_all</a> (<em class="parameter"><code><a class="link" href="GeditMessageBus.html" title="GeditMessageBus"><span class="type">GeditMessageBus</span></a> *bus</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *object_path</code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="GeditMessageBus.html#gedit-message-bus-is-registered" title="gedit_message_bus_is_registered ()">gedit_message_bus_is_registered</a> (<em class="parameter"><code><a class="link" href="GeditMessageBus.html" title="GeditMessageBus"><span class="type">GeditMessageBus</span></a> *bus</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *object_path</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *method</code></em>);
<span class="returnvalue">void</span> <a class="link" href="GeditMessageBus.html#gedit-message-bus-foreach" title="gedit_message_bus_foreach ()">gedit_message_bus_foreach</a> (<em class="parameter"><code><a class="link" href="GeditMessageBus.html" title="GeditMessageBus"><span class="type">GeditMessageBus</span></a> *bus</code></em>,
<em class="parameter"><code><span class="type">GeditMessageBusForeach</span> func</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a> <a class="link" href="GeditMessageBus.html#gedit-message-bus-connect" title="gedit_message_bus_connect ()">gedit_message_bus_connect</a> (<em class="parameter"><code><a class="link" href="GeditMessageBus.html" title="GeditMessageBus"><span class="type">GeditMessageBus</span></a> *bus</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *object_path</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *method</code></em>,
<em class="parameter"><code><a class="link" href="GeditMessageBus.html#GeditMessageCallback" title="GeditMessageCallback ()"><span class="type">GeditMessageCallback</span></a> callback</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Datasets.html#GDestroyNotify"><span class="type">GDestroyNotify</span></a> destroy_data</code></em>);
<span class="returnvalue">void</span> <a class="link" href="GeditMessageBus.html#gedit-message-bus-disconnect" title="gedit_message_bus_disconnect ()">gedit_message_bus_disconnect</a> (<em class="parameter"><code><a class="link" href="GeditMessageBus.html" title="GeditMessageBus"><span class="type">GeditMessageBus</span></a> *bus</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> id</code></em>);
<span class="returnvalue">void</span> <a class="link" href="GeditMessageBus.html#gedit-message-bus-disconnect-by-func" title="gedit_message_bus_disconnect_by_func ()">gedit_message_bus_disconnect_by_func</a>
(<em class="parameter"><code><a class="link" href="GeditMessageBus.html" title="GeditMessageBus"><span class="type">GeditMessageBus</span></a> *bus</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *object_path</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *method</code></em>,
<em class="parameter"><code><a class="link" href="GeditMessageBus.html#GeditMessageCallback" title="GeditMessageCallback ()"><span class="type">GeditMessageCallback</span></a> callback</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);
<span class="returnvalue">void</span> <a class="link" href="GeditMessageBus.html#gedit-message-bus-block" title="gedit_message_bus_block ()">gedit_message_bus_block</a> (<em class="parameter"><code><a class="link" href="GeditMessageBus.html" title="GeditMessageBus"><span class="type">GeditMessageBus</span></a> *bus</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> id</code></em>);
<span class="returnvalue">void</span> <a class="link" href="GeditMessageBus.html#gedit-message-bus-block-by-func" title="gedit_message_bus_block_by_func ()">gedit_message_bus_block_by_func</a> (<em class="parameter"><code><a class="link" href="GeditMessageBus.html" title="GeditMessageBus"><span class="type">GeditMessageBus</span></a> *bus</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *object_path</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *method</code></em>,
<em class="parameter"><code><a class="link" href="GeditMessageBus.html#GeditMessageCallback" title="GeditMessageCallback ()"><span class="type">GeditMessageCallback</span></a> callback</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);
<span class="returnvalue">void</span> <a class="link" href="GeditMessageBus.html#gedit-message-bus-unblock" title="gedit_message_bus_unblock ()">gedit_message_bus_unblock</a> (<em class="parameter"><code><a class="link" href="GeditMessageBus.html" title="GeditMessageBus"><span class="type">GeditMessageBus</span></a> *bus</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> id</code></em>);
<span class="returnvalue">void</span> <a class="link" href="GeditMessageBus.html#gedit-message-bus-unblock-by-func" title="gedit_message_bus_unblock_by_func ()">gedit_message_bus_unblock_by_func</a> (<em class="parameter"><code><a class="link" href="GeditMessageBus.html" title="GeditMessageBus"><span class="type">GeditMessageBus</span></a> *bus</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *object_path</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *method</code></em>,
<em class="parameter"><code><a class="link" href="GeditMessageBus.html#GeditMessageCallback" title="GeditMessageCallback ()"><span class="type">GeditMessageCallback</span></a> callback</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);
<span class="returnvalue">void</span> <a class="link" href="GeditMessageBus.html#gedit-message-bus-send-message" title="gedit_message_bus_send_message ()">gedit_message_bus_send_message</a> (<em class="parameter"><code><a class="link" href="GeditMessageBus.html" title="GeditMessageBus"><span class="type">GeditMessageBus</span></a> *bus</code></em>,
<em class="parameter"><code><a class="link" href="GeditMessage.html" title="GeditMessage"><span class="type">GeditMessage</span></a> *message</code></em>);
<span class="returnvalue">void</span> <a class="link" href="GeditMessageBus.html#gedit-message-bus-send-message-sync" title="gedit_message_bus_send_message_sync ()">gedit_message_bus_send_message_sync</a> (<em class="parameter"><code><a class="link" href="GeditMessageBus.html" title="GeditMessageBus"><span class="type">GeditMessageBus</span></a> *bus</code></em>,
<em class="parameter"><code><a class="link" href="GeditMessage.html" title="GeditMessage"><span class="type">GeditMessage</span></a> *message</code></em>);
<span class="returnvalue">void</span> <a class="link" href="GeditMessageBus.html#gedit-message-bus-send" title="gedit_message_bus_send ()">gedit_message_bus_send</a> (<em class="parameter"><code><a class="link" href="GeditMessageBus.html" title="GeditMessageBus"><span class="type">GeditMessageBus</span></a> *bus</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *object_path</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *method</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *first_property</code></em>,
<em class="parameter"><code>...</code></em>);
<a class="link" href="GeditMessage.html" title="GeditMessage"><span class="returnvalue">GeditMessage</span></a> * <a class="link" href="GeditMessageBus.html#gedit-message-bus-send-sync" title="gedit_message_bus_send_sync ()">gedit_message_bus_send_sync</a> (<em class="parameter"><code><a class="link" href="GeditMessageBus.html" title="GeditMessageBus"><span class="type">GeditMessageBus</span></a> *bus</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *object_path</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *method</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *first_property</code></em>,
<em class="parameter"><code>...</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="GeditMessageBus.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
<a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a>
+----GeditMessageBus
</pre>
</div>
<div class="refsect1">
<a name="GeditMessageBus.signals"></a><h2>Signals</h2>
<pre class="synopsis">
"<a class="link" href="GeditMessageBus.html#GeditMessageBus-dispatch" title='The "dispatch" signal'>dispatch</a>" : <a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a>
"<a class="link" href="GeditMessageBus.html#GeditMessageBus-registered" title='The "registered" signal'>registered</a>" : <a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a>
"<a class="link" href="GeditMessageBus.html#GeditMessageBus-unregistered" title='The "unregistered" signal'>unregistered</a>" : <a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a>
</pre>
</div>
<div class="refsect1">
<a name="GeditMessageBus.description"></a><h2>Description</h2>
<p>
gedit has a communication bus very similar to DBus. Its primary use is to
allow easy communication between plugins, but it can also be used to expose
gedit functionality to external applications by providing DBus bindings for
the internal gedit message bus.
</p>
<p>
There are two different communication busses available. The default bus
(see <a class="link" href="GeditMessageBus.html#gedit-message-bus-get-default" title="gedit_message_bus_get_default ()"><code class="function">gedit_message_bus_get_default()</code></a>) is an application wide communication
bus. In addition, each <a class="link" href="gedit-gedit-window.html#GeditWindow"><span class="type">GeditWindow</span></a> has a separate, private bus
(see <a class="link" href="gedit-gedit-window.html#gedit-window-get-message-bus" title="gedit_window_get_message_bus ()"><code class="function">gedit_window_get_message_bus()</code></a>). This makes it easier for plugins to
communicate to other plugins in the same window.
</p>
<p>
The concept of the message bus is very simple. You can register a message
type on the bus, specified as a Method at a specific Object Path with a
certain set of Method Arguments. You can then connect callback functions
for this message type on the bus. Whenever a message with the Object Path
and Method for which callbacks are connected is sent over the bus, the
callbacks are called. There is no distinction between Methods and Signals
(signals are simply messages where sender and receiver have switched places).
</p>
<p>
</p>
<div class="example">
<a name="idp5705840"></a><p class="title"><b>Example 1. Registering a message type</b></p>
<div class="example-contents"><pre class="programlisting">
GeditMessageBus *bus = gedit_message_bus_get_default ();
// Register 'method' at '/plugins/example' with one required
// string argument 'arg1'
GeditMessageType *message_type = gedit_message_bus_register ("/plugins/example", "method",
0,
"arg1", G_TYPE_STRING,
NULL);
</pre></div>
</div>
<p><br class="example-break">
</p>
<div class="example">
<a name="idp5707088"></a><p class="title"><b>Example 2. Connecting a callback</b></p>
<div class="example-contents"><pre class="programlisting">
static void
example_method_cb (GeditMessageBus *bus,
GeditMessage *message,
gpointer user_data)
{
gchar *arg1 = NULL;
gedit_message_get (message, "arg1", &arg1, NULL);
g_message ("Evoked /plugins/example.method with: %s", arg1);
g_free (arg1);
}
GeditMessageBus *bus = gedit_message_bus_get_default ();
guint id = gedit_message_bus_connect (bus,
"/plugins/example", "method",
example_method_cb,
NULL,
NULL);
</pre></div>
</div>
<p><br class="example-break">
</p>
<div class="example">
<a name="idp5708496"></a><p class="title"><b>Example 3. Sending a message</b></p>
<div class="example-contents"><pre class="programlisting">
GeditMessageBus *bus = gedit_message_bus_get_default ();
gedit_message_bus_send (bus,
"/plugins/example", "method",
"arg1", "Hello World",
NULL);
</pre></div>
</div>
<p><br class="example-break">
</p>
</div>
<div class="refsect1">
<a name="GeditMessageBus.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="GeditMessageBus-struct"></a><h3>struct GeditMessageBus</h3>
<pre class="programlisting">struct GeditMessageBus;</pre>
</div>
<hr>
<div class="refsect2">
<a name="GeditMessageCallback"></a><h3>GeditMessageCallback ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> (*GeditMessageCallback) (<em class="parameter"><code><a class="link" href="GeditMessageBus.html" title="GeditMessageBus"><span class="type">GeditMessageBus</span></a> *bus</code></em>,
<em class="parameter"><code><a class="link" href="GeditMessage.html" title="GeditMessage"><span class="type">GeditMessage</span></a> *message</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);</pre>
<p>
Callback signature used for connecting callback functions to be called
when a message is received (see <a class="link" href="GeditMessageBus.html#gedit-message-bus-connect" title="gedit_message_bus_connect ()"><code class="function">gedit_message_bus_connect()</code></a>).
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>bus</code></em> :</span></p></td>
<td>the <a class="link" href="GeditMessageBus.html" title="GeditMessageBus"><span class="type">GeditMessageBus</span></a> on which the message was sent</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>message</code></em> :</span></p></td>
<td>the <a class="link" href="GeditMessage.html" title="GeditMessage"><span class="type">GeditMessage</span></a> which was sent</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>the supplied user data when connecting the callback</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gedit-message-bus-get-default"></a><h3>gedit_message_bus_get_default ()</h3>
<pre class="programlisting"><a class="link" href="GeditMessageBus.html" title="GeditMessageBus"><span class="returnvalue">GeditMessageBus</span></a> * gedit_message_bus_get_default (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Get the default application <a class="link" href="GeditMessageBus.html" title="GeditMessageBus"><span class="type">GeditMessageBus</span></a>.
</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>the default <a class="link" href="GeditMessageBus.html" title="GeditMessageBus"><span class="type">GeditMessageBus</span></a>. <span class="annotation">[<a href="http://foldoc.org/transfer%20none"><span class="acronym">transfer none</span></a>]</span>
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gedit-message-bus-new"></a><h3>gedit_message_bus_new ()</h3>
<pre class="programlisting"><a class="link" href="GeditMessageBus.html" title="GeditMessageBus"><span class="returnvalue">GeditMessageBus</span></a> * gedit_message_bus_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Create a new message bus. Use <a class="link" href="GeditMessageBus.html#gedit-message-bus-get-default" title="gedit_message_bus_get_default ()"><code class="function">gedit_message_bus_get_default()</code></a> to get the
default, application wide, message bus. Creating a new bus is useful for
associating a specific bus with for instance a <a class="link" href="gedit-gedit-window.html#GeditWindow"><span class="type">GeditWindow</span></a>.
</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>a new <a class="link" href="GeditMessageBus.html" title="GeditMessageBus"><span class="type">GeditMessageBus</span></a>
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gedit-message-bus-lookup"></a><h3>gedit_message_bus_lookup ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#GType"><span class="returnvalue">GType</span></a> gedit_message_bus_lookup (<em class="parameter"><code><a class="link" href="GeditMessageBus.html" title="GeditMessageBus"><span class="type">GeditMessageBus</span></a> *bus</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *object_path</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *method</code></em>);</pre>
<p>
Get the registered <span class="type">GeditMessageType</span> for <em class="parameter"><code>method</code></em> at <em class="parameter"><code>object_path</code></em>. The
returned <span class="type">GeditMessageType</span> is owned by the bus and should not be unreffed.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>bus</code></em> :</span></p></td>
<td>a <a class="link" href="GeditMessageBus.html" title="GeditMessageBus"><span class="type">GeditMessageBus</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>object_path</code></em> :</span></p></td>
<td>the object path</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>method</code></em> :</span></p></td>
<td>the method</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the registered <span class="type">GeditMessageType</span> or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if no message type
is registered for <em class="parameter"><code>method</code></em> at <em class="parameter"><code>object_path</code></em>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gedit-message-bus-register"></a><h3>gedit_message_bus_register ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gedit_message_bus_register (<em class="parameter"><code><a class="link" href="GeditMessageBus.html" title="GeditMessageBus"><span class="type">GeditMessageBus</span></a> *bus</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#GType"><span class="type">GType</span></a> message_type</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *object_path</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *method</code></em>);</pre>
<p>
Register a message on the bus. A message must be registered on the bus before
it can be send. This function registers the type for <em class="parameter"><code>method</code></em> at
<em class="parameter"><code>object_path</code></em>.
</p>
<p>
This function emits a <a class="link" href="GeditMessageBus.html#GeditMessageBus-registered" title='The "registered" signal'><span class="type">"registered"</span></a> signal.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>bus</code></em> :</span></p></td>
<td>a <a class="link" href="GeditMessageBus.html" title="GeditMessageBus"><span class="type">GeditMessageBus</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>message_type</code></em> :</span></p></td>
<td>the message type</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>object_path</code></em> :</span></p></td>
<td>the object path</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>method</code></em> :</span></p></td>
<td>the method to register</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gedit-message-bus-unregister"></a><h3>gedit_message_bus_unregister ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gedit_message_bus_unregister (<em class="parameter"><code><a class="link" href="GeditMessageBus.html" title="GeditMessageBus"><span class="type">GeditMessageBus</span></a> *bus</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *object_path</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *method</code></em>);</pre>
<p>
Unregisters a previously registered message type. This is especially useful
for plugins which should unregister message types when they are deactivated.
</p>
<p>
This function emits the <a class="link" href="GeditMessageBus.html#GeditMessageBus-unregistered" title='The "unregistered" signal'><span class="type">"unregistered"</span></a> signal.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>bus</code></em> :</span></p></td>
<td>a <a class="link" href="GeditMessageBus.html" title="GeditMessageBus"><span class="type">GeditMessageBus</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>object_path</code></em> :</span></p></td>
<td>the object path</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>method</code></em> :</span></p></td>
<td>the method</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gedit-message-bus-unregister-all"></a><h3>gedit_message_bus_unregister_all ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gedit_message_bus_unregister_all (<em class="parameter"><code><a class="link" href="GeditMessageBus.html" title="GeditMessageBus"><span class="type">GeditMessageBus</span></a> *bus</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *object_path</code></em>);</pre>
<p>
Unregisters all message types for <em class="parameter"><code>object_path</code></em>. This is especially useful for
plugins which should unregister message types when they are deactivated.
</p>
<p>
This function emits the <a class="link" href="GeditMessageBus.html#GeditMessageBus-unregistered" title='The "unregistered" signal'><span class="type">"unregistered"</span></a> signal for all
unregistered message types.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>bus</code></em> :</span></p></td>
<td>a <a class="link" href="GeditMessageBus.html" title="GeditMessageBus"><span class="type">GeditMessageBus</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>object_path</code></em> :</span></p></td>
<td>the object path</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gedit-message-bus-is-registered"></a><h3>gedit_message_bus_is_registered ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gedit_message_bus_is_registered (<em class="parameter"><code><a class="link" href="GeditMessageBus.html" title="GeditMessageBus"><span class="type">GeditMessageBus</span></a> *bus</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *object_path</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *method</code></em>);</pre>
<p>
Check whether a message type <em class="parameter"><code>method</code></em> at <em class="parameter"><code>object_path</code></em> is registered on the
bus.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>bus</code></em> :</span></p></td>
<td>a <a class="link" href="GeditMessageBus.html" title="GeditMessageBus"><span class="type">GeditMessageBus</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>object_path</code></em> :</span></p></td>
<td>the object path</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>method</code></em> :</span></p></td>
<td>the method</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the <em class="parameter"><code>method</code></em> at <em class="parameter"><code>object_path</code></em> is a registered message
type on the bus</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gedit-message-bus-foreach"></a><h3>gedit_message_bus_foreach ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gedit_message_bus_foreach (<em class="parameter"><code><a class="link" href="GeditMessageBus.html" title="GeditMessageBus"><span class="type">GeditMessageBus</span></a> *bus</code></em>,
<em class="parameter"><code><span class="type">GeditMessageBusForeach</span> func</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);</pre>
<p>
Calls <em class="parameter"><code>func</code></em> for each message type registered on the bus
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>bus</code></em> :</span></p></td>
<td>the <span class="type">GeditMessagebus</span>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>func</code></em> :</span></p></td>
<td>the callback function. <span class="annotation">[<a href="http://foldoc.org/scope%20call"><span class="acronym">scope call</span></a>]</span>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>the user data to supply to the callback function</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gedit-message-bus-connect"></a><h3>gedit_message_bus_connect ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a> gedit_message_bus_connect (<em class="parameter"><code><a class="link" href="GeditMessageBus.html" title="GeditMessageBus"><span class="type">GeditMessageBus</span></a> *bus</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *object_path</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *method</code></em>,
<em class="parameter"><code><a class="link" href="GeditMessageBus.html#GeditMessageCallback" title="GeditMessageCallback ()"><span class="type">GeditMessageCallback</span></a> callback</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Datasets.html#GDestroyNotify"><span class="type">GDestroyNotify</span></a> destroy_data</code></em>);</pre>
<p>
Connect a callback handler to be evoked when message <em class="parameter"><code>method</code></em> at <em class="parameter"><code>object_path</code></em>
is sent over the bus.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>bus</code></em> :</span></p></td>
<td>a <a class="link" href="GeditMessageBus.html" title="GeditMessageBus"><span class="type">GeditMessageBus</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>object_path</code></em> :</span></p></td>
<td>the object path</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>method</code></em> :</span></p></td>
<td>the method</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>callback</code></em> :</span></p></td>
<td>function to be called when message <em class="parameter"><code>method</code></em> at <em class="parameter"><code>object_path</code></em> is sent</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>user_data to use for the callback. <span class="annotation">[<a href="http://foldoc.org/allow-none"><span class="acronym">allow-none</span></a>]</span>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>destroy_data</code></em> :</span></p></td>
<td>function to evoke with <em class="parameter"><code>user_data</code></em> as argument when <em class="parameter"><code>user_data</code></em>
needs to be freed. <span class="annotation">[<a href="http://foldoc.org/allow-none"><span class="acronym">allow-none</span></a>]</span>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the callback identifier</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gedit-message-bus-disconnect"></a><h3>gedit_message_bus_disconnect ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gedit_message_bus_disconnect (<em class="parameter"><code><a class="link" href="GeditMessageBus.html" title="GeditMessageBus"><span class="type">GeditMessageBus</span></a> *bus</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> id</code></em>);</pre>
<p>
Disconnects a previously connected message callback.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>bus</code></em> :</span></p></td>
<td>a <a class="link" href="GeditMessageBus.html" title="GeditMessageBus"><span class="type">GeditMessageBus</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>id</code></em> :</span></p></td>
<td>the callback id as returned by <a class="link" href="GeditMessageBus.html#gedit-message-bus-connect" title="gedit_message_bus_connect ()"><code class="function">gedit_message_bus_connect()</code></a>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gedit-message-bus-disconnect-by-func"></a><h3>gedit_message_bus_disconnect_by_func ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gedit_message_bus_disconnect_by_func
(<em class="parameter"><code><a class="link" href="GeditMessageBus.html" title="GeditMessageBus"><span class="type">GeditMessageBus</span></a> *bus</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *object_path</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *method</code></em>,
<em class="parameter"><code><a class="link" href="GeditMessageBus.html#GeditMessageCallback" title="GeditMessageCallback ()"><span class="type">GeditMessageCallback</span></a> callback</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);</pre>
<p>
Disconnects a previously connected message callback by matching the
provided callback function and user_data. See also
<a class="link" href="GeditMessageBus.html#gedit-message-bus-disconnect" title="gedit_message_bus_disconnect ()"><code class="function">gedit_message_bus_disconnect()</code></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>bus</code></em> :</span></p></td>
<td>a <a class="link" href="GeditMessageBus.html" title="GeditMessageBus"><span class="type">GeditMessageBus</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>object_path</code></em> :</span></p></td>
<td>the object path</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>method</code></em> :</span></p></td>
<td>the method</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>callback</code></em> :</span></p></td>
<td>the connected callback. <span class="annotation">[<a href="http://foldoc.org/scope%20call"><span class="acronym">scope call</span></a>]</span>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>the user_data with which the callback was connected</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gedit-message-bus-block"></a><h3>gedit_message_bus_block ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gedit_message_bus_block (<em class="parameter"><code><a class="link" href="GeditMessageBus.html" title="GeditMessageBus"><span class="type">GeditMessageBus</span></a> *bus</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> id</code></em>);</pre>
<p>
Blocks evoking the callback specified by <em class="parameter"><code>id</code></em>. Unblock the callback by
using <a class="link" href="GeditMessageBus.html#gedit-message-bus-unblock" title="gedit_message_bus_unblock ()"><code class="function">gedit_message_bus_unblock()</code></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>bus</code></em> :</span></p></td>
<td>a <a class="link" href="GeditMessageBus.html" title="GeditMessageBus"><span class="type">GeditMessageBus</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>id</code></em> :</span></p></td>
<td>the callback id</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gedit-message-bus-block-by-func"></a><h3>gedit_message_bus_block_by_func ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gedit_message_bus_block_by_func (<em class="parameter"><code><a class="link" href="GeditMessageBus.html" title="GeditMessageBus"><span class="type">GeditMessageBus</span></a> *bus</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *object_path</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *method</code></em>,
<em class="parameter"><code><a class="link" href="GeditMessageBus.html#GeditMessageCallback" title="GeditMessageCallback ()"><span class="type">GeditMessageCallback</span></a> callback</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);</pre>
<p>
Blocks evoking the callback that matches provided <em class="parameter"><code>callback</code></em> and <em class="parameter"><code>user_data</code></em>.
Unblock the callback using <code class="function">gedit_message_unblock_by_func()</code>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>bus</code></em> :</span></p></td>
<td>a <a class="link" href="GeditMessageBus.html" title="GeditMessageBus"><span class="type">GeditMessageBus</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>object_path</code></em> :</span></p></td>
<td>the object path</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>method</code></em> :</span></p></td>
<td>the method</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>callback</code></em> :</span></p></td>
<td>the callback to block. <span class="annotation">[<a href="http://foldoc.org/scope%20call"><span class="acronym">scope call</span></a>]</span>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>the user_data with which the callback was connected</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gedit-message-bus-unblock"></a><h3>gedit_message_bus_unblock ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gedit_message_bus_unblock (<em class="parameter"><code><a class="link" href="GeditMessageBus.html" title="GeditMessageBus"><span class="type">GeditMessageBus</span></a> *bus</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> id</code></em>);</pre>
<p>
Unblocks the callback specified by <em class="parameter"><code>id</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>bus</code></em> :</span></p></td>
<td>a <a class="link" href="GeditMessageBus.html" title="GeditMessageBus"><span class="type">GeditMessageBus</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>id</code></em> :</span></p></td>
<td>the callback id</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gedit-message-bus-unblock-by-func"></a><h3>gedit_message_bus_unblock_by_func ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gedit_message_bus_unblock_by_func (<em class="parameter"><code><a class="link" href="GeditMessageBus.html" title="GeditMessageBus"><span class="type">GeditMessageBus</span></a> *bus</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *object_path</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *method</code></em>,
<em class="parameter"><code><a class="link" href="GeditMessageBus.html#GeditMessageCallback" title="GeditMessageCallback ()"><span class="type">GeditMessageCallback</span></a> callback</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);</pre>
<p>
Unblocks the callback that matches provided <em class="parameter"><code>callback</code></em> and <em class="parameter"><code>user_data</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>bus</code></em> :</span></p></td>
<td>a <a class="link" href="GeditMessageBus.html" title="GeditMessageBus"><span class="type">GeditMessageBus</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>object_path</code></em> :</span></p></td>
<td>the object path</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>method</code></em> :</span></p></td>
<td>the method</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>callback</code></em> :</span></p></td>
<td>the callback to block. <span class="annotation">[<a href="http://foldoc.org/scope%20call"><span class="acronym">scope call</span></a>]</span>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>the user_data with which the callback was connected</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gedit-message-bus-send-message"></a><h3>gedit_message_bus_send_message ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gedit_message_bus_send_message (<em class="parameter"><code><a class="link" href="GeditMessageBus.html" title="GeditMessageBus"><span class="type">GeditMessageBus</span></a> *bus</code></em>,
<em class="parameter"><code><a class="link" href="GeditMessage.html" title="GeditMessage"><span class="type">GeditMessage</span></a> *message</code></em>);</pre>
<p>
This sends the provided <em class="parameter"><code>message</code></em> asynchronously over the bus. To send
a message synchronously, use <a class="link" href="GeditMessageBus.html#gedit-message-bus-send-message-sync" title="gedit_message_bus_send_message_sync ()"><code class="function">gedit_message_bus_send_message_sync()</code></a>. The
convenience function <a class="link" href="GeditMessageBus.html#gedit-message-bus-send" title="gedit_message_bus_send ()"><code class="function">gedit_message_bus_send()</code></a> can be used to easily send
a message without constructing the message object explicitly first.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>bus</code></em> :</span></p></td>
<td>a <a class="link" href="GeditMessageBus.html" title="GeditMessageBus"><span class="type">GeditMessageBus</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>message</code></em> :</span></p></td>
<td>the message to send</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gedit-message-bus-send-message-sync"></a><h3>gedit_message_bus_send_message_sync ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gedit_message_bus_send_message_sync (<em class="parameter"><code><a class="link" href="GeditMessageBus.html" title="GeditMessageBus"><span class="type">GeditMessageBus</span></a> *bus</code></em>,
<em class="parameter"><code><a class="link" href="GeditMessage.html" title="GeditMessage"><span class="type">GeditMessage</span></a> *message</code></em>);</pre>
<p>
This sends the provided <em class="parameter"><code>message</code></em> synchronously over the bus. To send
a message asynchronously, use <a class="link" href="GeditMessageBus.html#gedit-message-bus-send-message" title="gedit_message_bus_send_message ()"><code class="function">gedit_message_bus_send_message()</code></a>. The
convenience function <a class="link" href="GeditMessageBus.html#gedit-message-bus-send-sync" title="gedit_message_bus_send_sync ()"><code class="function">gedit_message_bus_send_sync()</code></a> can be used to easily send
a message without constructing the message object explicitly first.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>bus</code></em> :</span></p></td>
<td>a <a class="link" href="GeditMessageBus.html" title="GeditMessageBus"><span class="type">GeditMessageBus</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>message</code></em> :</span></p></td>
<td>the message to send</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gedit-message-bus-send"></a><h3>gedit_message_bus_send ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gedit_message_bus_send (<em class="parameter"><code><a class="link" href="GeditMessageBus.html" title="GeditMessageBus"><span class="type">GeditMessageBus</span></a> *bus</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *object_path</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *method</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *first_property</code></em>,
<em class="parameter"><code>...</code></em>);</pre>
<p>
This provides a convenient way to quickly send a message <em class="parameter"><code>method</code></em> at
<em class="parameter"><code>object_path</code></em> asynchronously over the bus. The variable argument list
specifies key (string) value pairs used to construct the message arguments.
To send a message synchronously use <a class="link" href="GeditMessageBus.html#gedit-message-bus-send-sync" title="gedit_message_bus_send_sync ()"><code class="function">gedit_message_bus_send_sync()</code></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>bus</code></em> :</span></p></td>
<td>a <a class="link" href="GeditMessageBus.html" title="GeditMessageBus"><span class="type">GeditMessageBus</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>object_path</code></em> :</span></p></td>
<td>the object path</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>method</code></em> :</span></p></td>
<td>the method</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td>
<td>NULL terminated list of key/value pairs</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gedit-message-bus-send-sync"></a><h3>gedit_message_bus_send_sync ()</h3>
<pre class="programlisting"><a class="link" href="GeditMessage.html" title="GeditMessage"><span class="returnvalue">GeditMessage</span></a> * gedit_message_bus_send_sync (<em class="parameter"><code><a class="link" href="GeditMessageBus.html" title="GeditMessageBus"><span class="type">GeditMessageBus</span></a> *bus</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *object_path</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *method</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *first_property</code></em>,
<em class="parameter"><code>...</code></em>);</pre>
<p>
This provides a convenient way to quickly send a message <em class="parameter"><code>method</code></em> at
<em class="parameter"><code>object_path</code></em> synchronously over the bus. The variable argument list
specifies key (string) value pairs used to construct the message
arguments. To send a message asynchronously use <a class="link" href="GeditMessageBus.html#gedit-message-bus-send" title="gedit_message_bus_send ()"><code class="function">gedit_message_bus_send()</code></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>bus</code></em> :</span></p></td>
<td>a <a class="link" href="GeditMessageBus.html" title="GeditMessageBus"><span class="type">GeditMessageBus</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>object_path</code></em> :</span></p></td>
<td>the object path</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>method</code></em> :</span></p></td>
<td>the method</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td>
<td>
<a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> terminated list of key/value pairs. <span class="annotation">[<a href="http://foldoc.org/allow-none"><span class="acronym">allow-none</span></a>]</span>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the constructed <a class="link" href="GeditMessage.html" title="GeditMessage"><span class="type">GeditMessage</span></a>.
The caller owns a reference to the <a class="link" href="GeditMessage.html" title="GeditMessage"><span class="type">GeditMessage</span></a> and should
call <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a> when it is no longer needed. <span class="annotation">[<a href="http://foldoc.org/allow-none"><span class="acronym">allow-none</span></a>][<a href="http://foldoc.org/transfer%20full"><span class="acronym">transfer full</span></a>]</span>
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1">
<a name="GeditMessageBus.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="GeditMessageBus-dispatch"></a><h3>The <code class="literal">"dispatch"</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="GeditMessageBus.html" title="GeditMessageBus"><span class="type">GeditMessageBus</span></a> *bus,
<a class="link" href="GeditMessage.html" title="GeditMessage"><span class="type">GeditMessage</span></a> *message,
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data) : <a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a></pre>
<p>
The "dispatch" signal is emitted when a message is to be dispatched.
The message is dispatched in the default handler of this signal.
Primary use of this signal is to customize the dispatch of a message
(for instance to automatically dispatch all messages over DBus).
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>bus</code></em> :</span></p></td>
<td>a <a class="link" href="GeditMessageBus.html" title="GeditMessageBus"><span class="type">GeditMessageBus</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>message</code></em> :</span></p></td>
<td>the <a class="link" href="GeditMessage.html" title="GeditMessage"><span class="type">GeditMessage</span></a> to dispatch</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="GeditMessageBus-registered"></a><h3>The <code class="literal">"registered"</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="GeditMessageBus.html" title="GeditMessageBus"><span class="type">GeditMessageBus</span></a> *bus,
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *message_type,
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *arg2,
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data) : <a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a></pre>
<p>
The "registered" signal is emitted when a message has been registered
on the bus.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>bus</code></em> :</span></p></td>
<td>a <a class="link" href="GeditMessageBus.html" title="GeditMessageBus"><span class="type">GeditMessageBus</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>message_type</code></em> :</span></p></td>
<td>the registered <span class="type">GeditMessageType</span>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="GeditMessageBus-unregistered"></a><h3>The <code class="literal">"unregistered"</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="GeditMessageBus.html" title="GeditMessageBus"><span class="type">GeditMessageBus</span></a> *bus,
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *message_type,
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *arg2,
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data) : <a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a></pre>
<p>
The "unregistered" signal is emitted when a message has been
unregistered from the bus.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>bus</code></em> :</span></p></td>
<td>a <a class="link" href="GeditMessageBus.html" title="GeditMessageBus"><span class="type">GeditMessageBus</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>message_type</code></em> :</span></p></td>
<td>the unregistered <span class="type">GeditMessageType</span>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.18</div>
</body>
</html>
|