~ubuntu-branches/ubuntu/maverick/gedit/maverick

1.1.54 by Baptiste Mille-Mathias
Import upstream version 2.25.3
1
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2
<html>
3
<head>
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
<title>GeditMessageBus</title>
1.1.72 by Didier Roche
Import upstream version 2.29.5
6
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
1.1.69 by Sebastien Bacher
Import upstream version 2.29.2
7
<link rel="home" href="index.html" title="gedit Reference Manual">
1.1.54 by Baptiste Mille-Mathias
Import upstream version 2.25.3
8
<link rel="up" href="ch01.html" title="gedit">
1.1.77 by Sebastien Bacher
Import upstream version 2.30.0
9
<link rel="prev" href="GeditFileChooserDialog.html" title="GeditFileChooserDialog">
1.1.54 by Baptiste Mille-Mathias
Import upstream version 2.25.3
10
<link rel="next" href="gedit-GeditMessageType.html" title="GeditMessageType">
1.1.77 by Sebastien Bacher
Import upstream version 2.30.0
11
<meta name="generator" content="GTK-Doc V1.13 (XML mode)">
1.1.54 by Baptiste Mille-Mathias
Import upstream version 2.25.3
12
<link rel="stylesheet" href="style.css" type="text/css">
13
<link rel="chapter" href="ch01.html" title="gedit">
14
</head>
15
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
16
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
17
<tr valign="middle">
1.1.77 by Sebastien Bacher
Import upstream version 2.30.0
18
<td><a accesskey="p" href="GeditFileChooserDialog.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
1.1.54 by Baptiste Mille-Mathias
Import upstream version 2.25.3
19
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
20
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
21
<th width="100%" align="center">gedit Reference Manual</th>
22
<td><a accesskey="n" href="gedit-GeditMessageType.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
23
</tr>
1.1.61 by Sebastien Bacher
Import upstream version 2.26.1
24
<tr><td colspan="5" class="shortcuts">
25
<a href="#GeditMessageBus.synopsis" class="shortcut">Top</a>
1.1.76 by Sebastien Bacher
Import upstream version 2.29.9
26
                   | 
27
                  <a href="#GeditMessageBus.description" class="shortcut">Description</a>
28
                   | 
29
                  <a href="#GeditMessageBus.object-hierarchy" class="shortcut">Object Hierarchy</a>
30
                   | 
31
                  <a href="#GeditMessageBus.signals" class="shortcut">Signals</a>
1.1.61 by Sebastien Bacher
Import upstream version 2.26.1
32
</td></tr>
1.1.54 by Baptiste Mille-Mathias
Import upstream version 2.25.3
33
</table>
1.1.69 by Sebastien Bacher
Import upstream version 2.29.2
34
<div class="refentry" title="GeditMessageBus">
1.1.54 by Baptiste Mille-Mathias
Import upstream version 2.25.3
35
<a name="GeditMessageBus"></a><div class="titlepage"></div>
36
<div class="refnamediv"><table width="100%"><tr>
37
<td valign="top">
38
<h2><span class="refentrytitle"><a name="GeditMessageBus.top_of_page"></a>GeditMessageBus</span></h2>
39
<p>GeditMessageBus — internal message communication bus</p>
40
</td>
41
<td valign="top" align="right"></td>
42
</tr></table></div>
1.1.69 by Sebastien Bacher
Import upstream version 2.29.2
43
<div class="refsynopsisdiv" title="Synopsis">
1.1.54 by Baptiste Mille-Mathias
Import upstream version 2.25.3
44
<a name="GeditMessageBus.synopsis"></a><h2>Synopsis</h2>
45
<pre class="synopsis">
46
#include &lt;gedit/gedit-message-bus.h&gt;
47
48
                    <a class="link" href="GeditMessageBus.html#GeditMessageBus-struct" title="GeditMessageBus">GeditMessageBus</a>;
1.1.77 by Sebastien Bacher
Import upstream version 2.30.0
49
<span class="returnvalue">void</span>                (<a class="link" href="GeditMessageBus.html#GeditMessageCallback" title="GeditMessageCallback ()">*GeditMessageCallback</a>)             (<a class="link" href="GeditMessageBus.html" title="GeditMessageBus"><span class="returnvalue">GeditMessageBus</span></a> *bus,
50
                                                         <a class="link" href="GeditMessage.html" title="GeditMessage"><span class="returnvalue">GeditMessage</span></a> *message,
51
                                                         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="returnvalue">gpointer</span></a> userdata);
52
<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>       (void);
53
<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>               (void);
54
<a class="link" href="gedit-GeditMessageType.html#GeditMessageType" title="GeditMessageType"><span class="returnvalue">GeditMessageType</span></a> *  <a class="link" href="GeditMessageBus.html#gedit-message-bus-lookup" title="gedit_message_bus_lookup ()">gedit_message_bus_lookup</a>            (<a class="link" href="GeditMessageBus.html" title="GeditMessageBus"><span class="returnvalue">GeditMessageBus</span></a> *bus,
55
                                                         const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *object_path,
56
                                                         const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *method);
57
<a class="link" href="gedit-GeditMessageType.html#GeditMessageType" title="GeditMessageType"><span class="returnvalue">GeditMessageType</span></a> *  <a class="link" href="GeditMessageBus.html#gedit-message-bus-register" title="gedit_message_bus_register ()">gedit_message_bus_register</a>          (<a class="link" href="GeditMessageBus.html" title="GeditMessageBus"><span class="returnvalue">GeditMessageBus</span></a> *bus,
58
                                                         const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *object_path,
59
                                                         const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *method,
60
                                                         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a> num_optional,
61
                                                         ...);
62
<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>        (<a class="link" href="GeditMessageBus.html" title="GeditMessageBus"><span class="returnvalue">GeditMessageBus</span></a> *bus,
63
                                                         <a class="link" href="gedit-GeditMessageType.html#GeditMessageType" title="GeditMessageType"><span class="returnvalue">GeditMessageType</span></a> *message_type);
64
<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>    (<a class="link" href="GeditMessageBus.html" title="GeditMessageBus"><span class="returnvalue">GeditMessageBus</span></a> *bus,
65
                                                         const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *object_path);
66
<a href="http://library.gnome.org/devel/glib/unstable/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>     (<a class="link" href="GeditMessageBus.html" title="GeditMessageBus"><span class="returnvalue">GeditMessageBus</span></a> *bus,
67
                                                         const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *object_path,
68
                                                         const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *method);
69
<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>           (<a class="link" href="GeditMessageBus.html" title="GeditMessageBus"><span class="returnvalue">GeditMessageBus</span></a> *bus,
70
                                                         <span class="returnvalue">GeditMessageBusForeach</span> func,
71
                                                         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="returnvalue">gpointer</span></a> userdata);
72
<a href="http://library.gnome.org/devel/glib/unstable/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>           (<a class="link" href="GeditMessageBus.html" title="GeditMessageBus"><span class="returnvalue">GeditMessageBus</span></a> *bus,
73
                                                         const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *object_path,
74
                                                         const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *method,
75
                                                         <a class="link" href="GeditMessageBus.html#GeditMessageCallback" title="GeditMessageCallback ()"><span class="returnvalue">GeditMessageCallback</span></a> callback,
76
                                                         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="returnvalue">gpointer</span></a> userdata,
77
                                                         <a href="http://library.gnome.org/devel/glib/unstable/glib-Datasets.html#GDestroyNotify"><span class="returnvalue">GDestroyNotify</span></a> destroy_data);
78
<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>        (<a class="link" href="GeditMessageBus.html" title="GeditMessageBus"><span class="returnvalue">GeditMessageBus</span></a> *bus,
79
                                                         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a> id);
1.1.76 by Sebastien Bacher
Import upstream version 2.29.9
80
<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>
1.1.77 by Sebastien Bacher
Import upstream version 2.30.0
81
                                                        (<a class="link" href="GeditMessageBus.html" title="GeditMessageBus"><span class="returnvalue">GeditMessageBus</span></a> *bus,
82
                                                         const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *object_path,
83
                                                         const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *method,
84
                                                         <a class="link" href="GeditMessageBus.html#GeditMessageCallback" title="GeditMessageCallback ()"><span class="returnvalue">GeditMessageCallback</span></a> callback,
85
                                                         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="returnvalue">gpointer</span></a> userdata);
86
<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>             (<a class="link" href="GeditMessageBus.html" title="GeditMessageBus"><span class="returnvalue">GeditMessageBus</span></a> *bus,
87
                                                         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a> id);
88
<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>     (<a class="link" href="GeditMessageBus.html" title="GeditMessageBus"><span class="returnvalue">GeditMessageBus</span></a> *bus,
89
                                                         const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *object_path,
90
                                                         const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *method,
91
                                                         <a class="link" href="GeditMessageBus.html#GeditMessageCallback" title="GeditMessageCallback ()"><span class="returnvalue">GeditMessageCallback</span></a> callback,
92
                                                         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="returnvalue">gpointer</span></a> userdata);
93
<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>           (<a class="link" href="GeditMessageBus.html" title="GeditMessageBus"><span class="returnvalue">GeditMessageBus</span></a> *bus,
94
                                                         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a> id);
95
<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>   (<a class="link" href="GeditMessageBus.html" title="GeditMessageBus"><span class="returnvalue">GeditMessageBus</span></a> *bus,
96
                                                         const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *object_path,
97
                                                         const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *method,
98
                                                         <a class="link" href="GeditMessageBus.html#GeditMessageCallback" title="GeditMessageCallback ()"><span class="returnvalue">GeditMessageCallback</span></a> callback,
99
                                                         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="returnvalue">gpointer</span></a> userdata);
100
<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>      (<a class="link" href="GeditMessageBus.html" title="GeditMessageBus"><span class="returnvalue">GeditMessageBus</span></a> *bus,
101
                                                         <a class="link" href="GeditMessage.html" title="GeditMessage"><span class="returnvalue">GeditMessage</span></a> *message);
102
<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> (<a class="link" href="GeditMessageBus.html" title="GeditMessageBus"><span class="returnvalue">GeditMessageBus</span></a> *bus,
103
                                                         <a class="link" href="GeditMessage.html" title="GeditMessage"><span class="returnvalue">GeditMessage</span></a> *message);
104
<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>              (<a class="link" href="GeditMessageBus.html" title="GeditMessageBus"><span class="returnvalue">GeditMessageBus</span></a> *bus,
105
                                                         const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *object_path,
106
                                                         const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *method,
107
                                                         ...);
108
<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>         (<a class="link" href="GeditMessageBus.html" title="GeditMessageBus"><span class="returnvalue">GeditMessageBus</span></a> *bus,
109
                                                         const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *object_path,
110
                                                         const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *method,
111
                                                         ...);
1.1.54 by Baptiste Mille-Mathias
Import upstream version 2.25.3
112
</pre>
113
</div>
1.1.69 by Sebastien Bacher
Import upstream version 2.29.2
114
<div class="refsect1" title="Object Hierarchy">
1.1.54 by Baptiste Mille-Mathias
Import upstream version 2.25.3
115
<a name="GeditMessageBus.object-hierarchy"></a><h2>Object Hierarchy</h2>
116
<pre class="synopsis">
1.1.76 by Sebastien Bacher
Import upstream version 2.29.9
117
  <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
1.1.54 by Baptiste Mille-Mathias
Import upstream version 2.25.3
118
   +----GeditMessageBus
119
</pre>
120
</div>
1.1.69 by Sebastien Bacher
Import upstream version 2.29.2
121
<div class="refsect1" title="Signals">
1.1.54 by Baptiste Mille-Mathias
Import upstream version 2.25.3
122
<a name="GeditMessageBus.signals"></a><h2>Signals</h2>
123
<pre class="synopsis">
124
  "<a class="link" href="GeditMessageBus.html#GeditMessageBus-dispatch" title='The "dispatch" signal'>dispatch</a>"                                       : Run Last
125
  "<a class="link" href="GeditMessageBus.html#GeditMessageBus-registered" title='The "registered" signal'>registered</a>"                                     : Run Last
126
  "<a class="link" href="GeditMessageBus.html#GeditMessageBus-unregistered" title='The "unregistered" signal'>unregistered</a>"                                   : Run Last
127
</pre>
128
</div>
1.1.69 by Sebastien Bacher
Import upstream version 2.29.2
129
<div class="refsect1" title="Description">
1.1.54 by Baptiste Mille-Mathias
Import upstream version 2.25.3
130
<a name="GeditMessageBus.description"></a><h2>Description</h2>
131
<p>
132
gedit has a communication bus very similar to DBus. Its primary use is to
133
allow easy communication between plugins, but it can also be used to expose
134
gedit functionality to external applications by providing DBus bindings for
135
the internal gedit message bus.
136
</p>
137
<p>
138
There are two different communication busses available. The default bus
139
(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
1.1.77 by Sebastien Bacher
Import upstream version 2.30.0
140
bus. In addition, each <a class="link" href="GeditWindow.html" title="GeditWindow"><span class="type">GeditWindow</span></a> has a separate, private bus
141
(see <a class="link" href="GeditWindow.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
1.1.54 by Baptiste Mille-Mathias
Import upstream version 2.25.3
142
communicate to other plugins in the same window.
143
</p>
144
<p>
145
The concept of the message bus is very simple. You can register a message
146
type on the bus, specified as a Method at a specific Object Path with a
147
certain set of Method Arguments. You can then connect callback functions
148
for this message type on the bus. Whenever a message with the Object Path
149
and Method for which callbacks are connected is sent over the bus, the
150
callbacks are called. There is no distinction between Methods and Signals
151
(signals are simply messages where sender and receiver have switched places).
152
</p>
153
<p>
154
</p>
155
<div class="example">
1.1.77 by Sebastien Bacher
Import upstream version 2.30.0
156
<a name="id545851"></a><p class="title"><b>Example 1. Registering a message type</b></p>
157
<div class="example-contents"><pre class="programlisting">
158
GeditMessageBus *bus = gedit_message_bus_get_default ();
159
160
// Register 'method' at '/plugins/example' with one required
161
// string argument 'arg1'
162
GeditMessageType *message_type = gedit_message_bus_register ("/plugins/example", "method", 
163
                                                             0, 
164
                                                             "arg1", G_TYPE_STRING,
165
                                                             NULL);
166
</pre></div>
1.1.59 by Sebastien Bacher
Import upstream version 2.25.8
167
</div>
168
<p><br class="example-break">
169
</p>
170
<div class="example">
1.1.77 by Sebastien Bacher
Import upstream version 2.30.0
171
<a name="id545869"></a><p class="title"><b>Example 2. Connecting a callback</b></p>
172
<div class="example-contents"><pre class="programlisting">
173
static void
1.1.59 by Sebastien Bacher
Import upstream version 2.25.8
174
example_method_cb (GeditMessageBus *bus,
175
                   GeditMessage    *message,
176
                   gpointer         userdata)
177
{
1.1.77 by Sebastien Bacher
Import upstream version 2.30.0
178
	gchar *arg1 = NULL;
1.1.59 by Sebastien Bacher
Import upstream version 2.25.8
179
1.1.77 by Sebastien Bacher
Import upstream version 2.30.0
180
	gedit_message_get (message, "arg1", &amp;arg1, NULL);
181
	g_message ("Evoked /plugins/example.method with: %s", arg1);
182
	g_free (arg1);
1.1.59 by Sebastien Bacher
Import upstream version 2.25.8
183
}
184
185
GeditMessageBus *bus = gedit_message_bus_get_default ();
186
1.1.77 by Sebastien Bacher
Import upstream version 2.30.0
187
guint id = gedit_message_bus_connect (bus, 
188
                                      "/plugins/example", "method",
1.1.59 by Sebastien Bacher
Import upstream version 2.25.8
189
                                      example_method_cb,
1.1.77 by Sebastien Bacher
Import upstream version 2.30.0
190
                                      NULL,
191
                                      NULL);
192
                                       
193
</pre></div>
1.1.59 by Sebastien Bacher
Import upstream version 2.25.8
194
</div>
195
<p><br class="example-break">
196
</p>
197
<div class="example">
1.1.77 by Sebastien Bacher
Import upstream version 2.30.0
198
<a name="id545887"></a><p class="title"><b>Example 3. Sending a message</b></p>
199
<div class="example-contents"><pre class="programlisting">
200
GeditMessageBus *bus = gedit_message_bus_get_default ();
201
202
gedit_message_bus_send (bus, 
203
                        "/plugins/example", "method", 
204
                        "arg1", "Hello World", 
205
                        NULL);
206
</pre></div>
1.1.54 by Baptiste Mille-Mathias
Import upstream version 2.25.3
207
</div>
208
<p><br class="example-break"></p>
209
</div>
1.1.69 by Sebastien Bacher
Import upstream version 2.29.2
210
<div class="refsect1" title="Details">
1.1.54 by Baptiste Mille-Mathias
Import upstream version 2.25.3
211
<a name="GeditMessageBus.details"></a><h2>Details</h2>
1.1.69 by Sebastien Bacher
Import upstream version 2.29.2
212
<div class="refsect2" title="GeditMessageBus">
1.1.54 by Baptiste Mille-Mathias
Import upstream version 2.25.3
213
<a name="GeditMessageBus-struct"></a><h3>GeditMessageBus</h3>
214
<pre class="programlisting">typedef struct _GeditMessageBus GeditMessageBus;</pre>
1.1.77 by Sebastien Bacher
Import upstream version 2.30.0
215
<p>
216
</p>
1.1.54 by Baptiste Mille-Mathias
Import upstream version 2.25.3
217
</div>
218
<hr>
1.1.69 by Sebastien Bacher
Import upstream version 2.29.2
219
<div class="refsect2" title="GeditMessageCallback ()">
1.1.54 by Baptiste Mille-Mathias
Import upstream version 2.25.3
220
<a name="GeditMessageCallback"></a><h3>GeditMessageCallback ()</h3>
1.1.77 by Sebastien Bacher
Import upstream version 2.30.0
221
<pre class="programlisting"><span class="returnvalue">void</span>                (*GeditMessageCallback)             (<a class="link" href="GeditMessageBus.html" title="GeditMessageBus"><span class="returnvalue">GeditMessageBus</span></a> *bus,
222
                                                         <a class="link" href="GeditMessage.html" title="GeditMessage"><span class="returnvalue">GeditMessage</span></a> *message,
223
                                                         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="returnvalue">gpointer</span></a> userdata);</pre>
1.1.54 by Baptiste Mille-Mathias
Import upstream version 2.25.3
224
<p>
225
Callback signature used for connecting callback functions to be called
226
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>
227
<div class="variablelist"><table border="0">
228
<col align="left" valign="top">
229
<tbody>
230
<tr>
231
<td><p><span class="term"><em class="parameter"><code>bus</code></em> :</span></p></td>
1.1.77 by Sebastien Bacher
Import upstream version 2.30.0
232
<td> the <a class="link" href="GeditMessageBus.html" title="GeditMessageBus"><span class="type">GeditMessageBus</span></a> on which the message was sent
1.1.54 by Baptiste Mille-Mathias
Import upstream version 2.25.3
233
</td>
234
</tr>
235
<tr>
236
<td><p><span class="term"><em class="parameter"><code>message</code></em> :</span></p></td>
1.1.77 by Sebastien Bacher
Import upstream version 2.30.0
237
<td> the <a class="link" href="GeditMessage.html" title="GeditMessage"><span class="type">GeditMessage</span></a> which was sent
1.1.54 by Baptiste Mille-Mathias
Import upstream version 2.25.3
238
</td>
239
</tr>
240
<tr>
241
<td><p><span class="term"><em class="parameter"><code>userdata</code></em> :</span></p></td>
1.1.77 by Sebastien Bacher
Import upstream version 2.30.0
242
<td> the supplied user data when connecting the callback
1.1.54 by Baptiste Mille-Mathias
Import upstream version 2.25.3
243
</td>
244
</tr>
245
</tbody>
246
</table></div>
247
</div>
248
<hr>
1.1.69 by Sebastien Bacher
Import upstream version 2.29.2
249
<div class="refsect2" title="gedit_message_bus_get_default ()">
1.1.54 by Baptiste Mille-Mathias
Import upstream version 2.25.3
250
<a name="gedit-message-bus-get-default"></a><h3>gedit_message_bus_get_default ()</h3>
1.1.77 by Sebastien Bacher
Import upstream version 2.30.0
251
<pre class="programlisting"><a class="link" href="GeditMessageBus.html" title="GeditMessageBus"><span class="returnvalue">GeditMessageBus</span></a> *   gedit_message_bus_get_default       (void);</pre>
1.1.61 by Sebastien Bacher
Import upstream version 2.26.1
252
<p>
1.1.63 by Robert Ancell
Import upstream version 2.27.2
253
Get the default application <a class="link" href="GeditMessageBus.html" title="GeditMessageBus"><span class="type">GeditMessageBus</span></a>.</p>
1.1.54 by Baptiste Mille-Mathias
Import upstream version 2.25.3
254
<div class="variablelist"><table border="0">
255
<col align="left" valign="top">
256
<tbody><tr>
257
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
258
<td> the default <a class="link" href="GeditMessageBus.html" title="GeditMessageBus"><span class="type">GeditMessageBus</span></a>
259
260
</td>
261
</tr></tbody>
262
</table></div>
263
</div>
264
<hr>
1.1.69 by Sebastien Bacher
Import upstream version 2.29.2
265
<div class="refsect2" title="gedit_message_bus_new ()">
1.1.54 by Baptiste Mille-Mathias
Import upstream version 2.25.3
266
<a name="gedit-message-bus-new"></a><h3>gedit_message_bus_new ()</h3>
1.1.77 by Sebastien Bacher
Import upstream version 2.30.0
267
<pre class="programlisting"><a class="link" href="GeditMessageBus.html" title="GeditMessageBus"><span class="returnvalue">GeditMessageBus</span></a> *   gedit_message_bus_new               (void);</pre>
1.1.54 by Baptiste Mille-Mathias
Import upstream version 2.25.3
268
<p>
269
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
270
default, application wide, message bus. Creating a new bus is useful for
1.1.77 by Sebastien Bacher
Import upstream version 2.30.0
271
associating a specific bus with for instance a <a class="link" href="GeditWindow.html" title="GeditWindow"><span class="type">GeditWindow</span></a>.</p>
1.1.54 by Baptiste Mille-Mathias
Import upstream version 2.25.3
272
<div class="variablelist"><table border="0">
273
<col align="left" valign="top">
274
<tbody><tr>
275
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
276
<td> a new <a class="link" href="GeditMessageBus.html" title="GeditMessageBus"><span class="type">GeditMessageBus</span></a>
277
278
</td>
279
</tr></tbody>
280
</table></div>
281
</div>
282
<hr>
1.1.69 by Sebastien Bacher
Import upstream version 2.29.2
283
<div class="refsect2" title="gedit_message_bus_lookup ()">
1.1.54 by Baptiste Mille-Mathias
Import upstream version 2.25.3
284
<a name="gedit-message-bus-lookup"></a><h3>gedit_message_bus_lookup ()</h3>
1.1.77 by Sebastien Bacher
Import upstream version 2.30.0
285
<pre class="programlisting"><a class="link" href="gedit-GeditMessageType.html#GeditMessageType" title="GeditMessageType"><span class="returnvalue">GeditMessageType</span></a> *  gedit_message_bus_lookup            (<a class="link" href="GeditMessageBus.html" title="GeditMessageBus"><span class="returnvalue">GeditMessageBus</span></a> *bus,
286
                                                         const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *object_path,
287
                                                         const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *method);</pre>
1.1.54 by Baptiste Mille-Mathias
Import upstream version 2.25.3
288
<p>
289
Get the registered <a class="link" href="gedit-GeditMessageType.html#GeditMessageType" title="GeditMessageType"><span class="type">GeditMessageType</span></a> for <em class="parameter"><code>method</code></em> at <em class="parameter"><code>object_path</code></em>. The 
290
returned <a class="link" href="gedit-GeditMessageType.html#GeditMessageType" title="GeditMessageType"><span class="type">GeditMessageType</span></a> is owned by the bus and should not be unreffed.</p>
291
<div class="variablelist"><table border="0">
292
<col align="left" valign="top">
293
<tbody>
294
<tr>
295
<td><p><span class="term"><em class="parameter"><code>bus</code></em> :</span></p></td>
1.1.77 by Sebastien Bacher
Import upstream version 2.30.0
296
<td> a <a class="link" href="GeditMessageBus.html" title="GeditMessageBus"><span class="type">GeditMessageBus</span></a>
1.1.54 by Baptiste Mille-Mathias
Import upstream version 2.25.3
297
</td>
298
</tr>
299
<tr>
300
<td><p><span class="term"><em class="parameter"><code>object_path</code></em> :</span></p></td>
1.1.77 by Sebastien Bacher
Import upstream version 2.30.0
301
<td> the object path
1.1.54 by Baptiste Mille-Mathias
Import upstream version 2.25.3
302
</td>
303
</tr>
304
<tr>
305
<td><p><span class="term"><em class="parameter"><code>method</code></em> :</span></p></td>
1.1.77 by Sebastien Bacher
Import upstream version 2.30.0
306
<td> the method
1.1.54 by Baptiste Mille-Mathias
Import upstream version 2.25.3
307
</td>
308
</tr>
309
<tr>
310
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1.1.77 by Sebastien Bacher
Import upstream version 2.30.0
311
<td> the registered <a class="link" href="gedit-GeditMessageType.html#GeditMessageType" title="GeditMessageType"><span class="type">GeditMessageType</span></a> or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if no message type
1.1.54 by Baptiste Mille-Mathias
Import upstream version 2.25.3
312
              is registered for <em class="parameter"><code>method</code></em> at <em class="parameter"><code>object_path</code></em>
313
314
</td>
315
</tr>
316
</tbody>
317
</table></div>
318
</div>
319
<hr>
1.1.69 by Sebastien Bacher
Import upstream version 2.29.2
320
<div class="refsect2" title="gedit_message_bus_register ()">
1.1.54 by Baptiste Mille-Mathias
Import upstream version 2.25.3
321
<a name="gedit-message-bus-register"></a><h3>gedit_message_bus_register ()</h3>
1.1.77 by Sebastien Bacher
Import upstream version 2.30.0
322
<pre class="programlisting"><a class="link" href="gedit-GeditMessageType.html#GeditMessageType" title="GeditMessageType"><span class="returnvalue">GeditMessageType</span></a> *  gedit_message_bus_register          (<a class="link" href="GeditMessageBus.html" title="GeditMessageBus"><span class="returnvalue">GeditMessageBus</span></a> *bus,
323
                                                         const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *object_path,
324
                                                         const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *method,
325
                                                         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a> num_optional,
326
                                                         ...);</pre>
1.1.54 by Baptiste Mille-Mathias
Import upstream version 2.25.3
327
<p>
328
Register a message on the bus. A message must be registered on the bus before
329
it can be send. This function registers the type arguments for <em class="parameter"><code>method</code></em> at 
330
<em class="parameter"><code>object_path</code></em>. The arguments are specified with the variable arguments which 
1.1.77 by Sebastien Bacher
Import upstream version 2.30.0
331
should contain pairs of const gchar *key and GType terminated by <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. The 
1.1.54 by Baptiste Mille-Mathias
Import upstream version 2.25.3
332
last <em class="parameter"><code>num_optional</code></em> arguments are registered as optional (and are thus not
333
required when sending a message).
334
</p>
335
<p>
336
This function emits a <a class="link" href="GeditMessageBus.html#GeditMessageBus-registered" title='The "registered" signal'><span class="type">"registered"</span></a> signal.</p>
337
<div class="variablelist"><table border="0">
338
<col align="left" valign="top">
339
<tbody>
340
<tr>
341
<td><p><span class="term"><em class="parameter"><code>bus</code></em> :</span></p></td>
1.1.77 by Sebastien Bacher
Import upstream version 2.30.0
342
<td> a <a class="link" href="GeditMessageBus.html" title="GeditMessageBus"><span class="type">GeditMessageBus</span></a>
1.1.54 by Baptiste Mille-Mathias
Import upstream version 2.25.3
343
</td>
344
</tr>
345
<tr>
346
<td><p><span class="term"><em class="parameter"><code>object_path</code></em> :</span></p></td>
1.1.77 by Sebastien Bacher
Import upstream version 2.30.0
347
<td> the object path
1.1.54 by Baptiste Mille-Mathias
Import upstream version 2.25.3
348
</td>
349
</tr>
350
<tr>
351
<td><p><span class="term"><em class="parameter"><code>method</code></em> :</span></p></td>
1.1.77 by Sebastien Bacher
Import upstream version 2.30.0
352
<td> the method to register
1.1.54 by Baptiste Mille-Mathias
Import upstream version 2.25.3
353
</td>
354
</tr>
355
<tr>
356
<td><p><span class="term"><em class="parameter"><code>num_optional</code></em> :</span></p></td>
1.1.77 by Sebastien Bacher
Import upstream version 2.30.0
357
<td> the number of optional arguments
1.1.54 by Baptiste Mille-Mathias
Import upstream version 2.25.3
358
</td>
359
</tr>
360
<tr>
361
<td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td>
1.1.77 by Sebastien Bacher
Import upstream version 2.30.0
362
<td> NULL terminated list of key/gtype method argument pairs
1.1.54 by Baptiste Mille-Mathias
Import upstream version 2.25.3
363
</td>
364
</tr>
365
<tr>
366
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1.1.63 by Robert Ancell
Import upstream version 2.27.2
367
<td> the registered <a class="link" href="gedit-GeditMessageType.html#GeditMessageType" title="GeditMessageType"><span class="type">GeditMessageType</span></a>. The returned reference is
1.1.54 by Baptiste Mille-Mathias
Import upstream version 2.25.3
368
              owned by the bus. If you want to keep it alive after
369
              unregistering, use <a class="link" href="gedit-GeditMessageType.html#gedit-message-type-ref" title="gedit_message_type_ref ()"><code class="function">gedit_message_type_ref()</code></a>.
370
371
</td>
372
</tr>
373
</tbody>
374
</table></div>
375
</div>
376
<hr>
1.1.69 by Sebastien Bacher
Import upstream version 2.29.2
377
<div class="refsect2" title="gedit_message_bus_unregister ()">
1.1.54 by Baptiste Mille-Mathias
Import upstream version 2.25.3
378
<a name="gedit-message-bus-unregister"></a><h3>gedit_message_bus_unregister ()</h3>
1.1.77 by Sebastien Bacher
Import upstream version 2.30.0
379
<pre class="programlisting"><span class="returnvalue">void</span>                gedit_message_bus_unregister        (<a class="link" href="GeditMessageBus.html" title="GeditMessageBus"><span class="returnvalue">GeditMessageBus</span></a> *bus,
380
                                                         <a class="link" href="gedit-GeditMessageType.html#GeditMessageType" title="GeditMessageType"><span class="returnvalue">GeditMessageType</span></a> *message_type);</pre>
1.1.54 by Baptiste Mille-Mathias
Import upstream version 2.25.3
381
<p>
382
Unregisters a previously registered message type. This is especially useful 
383
for plugins which should unregister message types when they are deactivated.
384
</p>
385
<p>
386
This function emits the <a class="link" href="GeditMessageBus.html#GeditMessageBus-unregistered" title='The "unregistered" signal'><span class="type">"unregistered"</span></a> signal.</p>
387
<div class="variablelist"><table border="0">
388
<col align="left" valign="top">
389
<tbody>
390
<tr>
391
<td><p><span class="term"><em class="parameter"><code>bus</code></em> :</span></p></td>
1.1.77 by Sebastien Bacher
Import upstream version 2.30.0
392
<td> a <a class="link" href="GeditMessageBus.html" title="GeditMessageBus"><span class="type">GeditMessageBus</span></a>
1.1.54 by Baptiste Mille-Mathias
Import upstream version 2.25.3
393
</td>
394
</tr>
395
<tr>
396
<td><p><span class="term"><em class="parameter"><code>message_type</code></em> :</span></p></td>
1.1.77 by Sebastien Bacher
Import upstream version 2.30.0
397
<td> the <a class="link" href="gedit-GeditMessageType.html#GeditMessageType" title="GeditMessageType"><span class="type">GeditMessageType</span></a> to unregister
1.1.54 by Baptiste Mille-Mathias
Import upstream version 2.25.3
398
</td>
399
</tr>
400
</tbody>
401
</table></div>
402
</div>
403
<hr>
1.1.69 by Sebastien Bacher
Import upstream version 2.29.2
404
<div class="refsect2" title="gedit_message_bus_unregister_all ()">
1.1.54 by Baptiste Mille-Mathias
Import upstream version 2.25.3
405
<a name="gedit-message-bus-unregister-all"></a><h3>gedit_message_bus_unregister_all ()</h3>
1.1.77 by Sebastien Bacher
Import upstream version 2.30.0
406
<pre class="programlisting"><span class="returnvalue">void</span>                gedit_message_bus_unregister_all    (<a class="link" href="GeditMessageBus.html" title="GeditMessageBus"><span class="returnvalue">GeditMessageBus</span></a> *bus,
407
                                                         const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *object_path);</pre>
1.1.54 by Baptiste Mille-Mathias
Import upstream version 2.25.3
408
<p>
409
Unregisters all message types for <em class="parameter"><code>object_path</code></em>. This is especially useful for
410
plugins which should unregister message types when they are deactivated.
411
</p>
412
<p>
413
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
414
unregistered message types.</p>
415
<div class="variablelist"><table border="0">
416
<col align="left" valign="top">
417
<tbody>
418
<tr>
419
<td><p><span class="term"><em class="parameter"><code>bus</code></em> :</span></p></td>
1.1.77 by Sebastien Bacher
Import upstream version 2.30.0
420
<td> a <a class="link" href="GeditMessageBus.html" title="GeditMessageBus"><span class="type">GeditMessageBus</span></a>
1.1.54 by Baptiste Mille-Mathias
Import upstream version 2.25.3
421
</td>
422
</tr>
423
<tr>
424
<td><p><span class="term"><em class="parameter"><code>object_path</code></em> :</span></p></td>
1.1.77 by Sebastien Bacher
Import upstream version 2.30.0
425
<td> the object path
1.1.54 by Baptiste Mille-Mathias
Import upstream version 2.25.3
426
</td>
427
</tr>
428
</tbody>
429
</table></div>
430
</div>
431
<hr>
1.1.69 by Sebastien Bacher
Import upstream version 2.29.2
432
<div class="refsect2" title="gedit_message_bus_is_registered ()">
1.1.54 by Baptiste Mille-Mathias
Import upstream version 2.25.3
433
<a name="gedit-message-bus-is-registered"></a><h3>gedit_message_bus_is_registered ()</h3>
1.1.77 by Sebastien Bacher
Import upstream version 2.30.0
434
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            gedit_message_bus_is_registered     (<a class="link" href="GeditMessageBus.html" title="GeditMessageBus"><span class="returnvalue">GeditMessageBus</span></a> *bus,
435
                                                         const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *object_path,
436
                                                         const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *method);</pre>
1.1.54 by Baptiste Mille-Mathias
Import upstream version 2.25.3
437
<p>
438
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 
439
bus.</p>
440
<div class="variablelist"><table border="0">
441
<col align="left" valign="top">
442
<tbody>
443
<tr>
444
<td><p><span class="term"><em class="parameter"><code>bus</code></em> :</span></p></td>
1.1.77 by Sebastien Bacher
Import upstream version 2.30.0
445
<td> a <a class="link" href="GeditMessageBus.html" title="GeditMessageBus"><span class="type">GeditMessageBus</span></a>
1.1.54 by Baptiste Mille-Mathias
Import upstream version 2.25.3
446
</td>
447
</tr>
448
<tr>
449
<td><p><span class="term"><em class="parameter"><code>object_path</code></em> :</span></p></td>
1.1.77 by Sebastien Bacher
Import upstream version 2.30.0
450
<td> the object path
1.1.54 by Baptiste Mille-Mathias
Import upstream version 2.25.3
451
</td>
452
</tr>
453
<tr>
454
<td><p><span class="term"><em class="parameter"><code>method</code></em> :</span></p></td>
1.1.77 by Sebastien Bacher
Import upstream version 2.30.0
455
<td> the method
1.1.54 by Baptiste Mille-Mathias
Import upstream version 2.25.3
456
</td>
457
</tr>
458
<tr>
459
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1.1.76 by Sebastien Bacher
Import upstream version 2.29.9
460
<td> <a href="http://library.gnome.org/devel/glib/unstable/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 
1.1.54 by Baptiste Mille-Mathias
Import upstream version 2.25.3
461
              type on the bus
462
463
</td>
464
</tr>
465
</tbody>
466
</table></div>
467
</div>
468
<hr>
1.1.69 by Sebastien Bacher
Import upstream version 2.29.2
469
<div class="refsect2" title="gedit_message_bus_foreach ()">
1.1.55 by Sebastien Bacher
Import upstream version 2.25.4
470
<a name="gedit-message-bus-foreach"></a><h3>gedit_message_bus_foreach ()</h3>
1.1.77 by Sebastien Bacher
Import upstream version 2.30.0
471
<pre class="programlisting"><span class="returnvalue">void</span>                gedit_message_bus_foreach           (<a class="link" href="GeditMessageBus.html" title="GeditMessageBus"><span class="returnvalue">GeditMessageBus</span></a> *bus,
472
                                                         <span class="returnvalue">GeditMessageBusForeach</span> func,
473
                                                         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="returnvalue">gpointer</span></a> userdata);</pre>
1.1.55 by Sebastien Bacher
Import upstream version 2.25.4
474
<p>
475
Calls <em class="parameter"><code>func</code></em> for each message type registered on the bus</p>
476
<div class="variablelist"><table border="0">
477
<col align="left" valign="top">
478
<tbody>
479
<tr>
480
<td><p><span class="term"><em class="parameter"><code>bus</code></em> :</span></p></td>
1.1.77 by Sebastien Bacher
Import upstream version 2.30.0
481
<td> the <span class="type">GeditMessagebus</span>
1.1.55 by Sebastien Bacher
Import upstream version 2.25.4
482
</td>
483
</tr>
484
<tr>
485
<td><p><span class="term"><em class="parameter"><code>func</code></em> :</span></p></td>
1.1.77 by Sebastien Bacher
Import upstream version 2.30.0
486
<td> the callback function
1.1.55 by Sebastien Bacher
Import upstream version 2.25.4
487
</td>
488
</tr>
489
<tr>
490
<td><p><span class="term"><em class="parameter"><code>userdata</code></em> :</span></p></td>
1.1.77 by Sebastien Bacher
Import upstream version 2.30.0
491
<td> the user data to supply to the callback function
1.1.55 by Sebastien Bacher
Import upstream version 2.25.4
492
</td>
493
</tr>
494
</tbody>
495
</table></div>
496
</div>
497
<hr>
1.1.69 by Sebastien Bacher
Import upstream version 2.29.2
498
<div class="refsect2" title="gedit_message_bus_connect ()">
1.1.54 by Baptiste Mille-Mathias
Import upstream version 2.25.3
499
<a name="gedit-message-bus-connect"></a><h3>gedit_message_bus_connect ()</h3>
1.1.77 by Sebastien Bacher
Import upstream version 2.30.0
500
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               gedit_message_bus_connect           (<a class="link" href="GeditMessageBus.html" title="GeditMessageBus"><span class="returnvalue">GeditMessageBus</span></a> *bus,
501
                                                         const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *object_path,
502
                                                         const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *method,
503
                                                         <a class="link" href="GeditMessageBus.html#GeditMessageCallback" title="GeditMessageCallback ()"><span class="returnvalue">GeditMessageCallback</span></a> callback,
504
                                                         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="returnvalue">gpointer</span></a> userdata,
505
                                                         <a href="http://library.gnome.org/devel/glib/unstable/glib-Datasets.html#GDestroyNotify"><span class="returnvalue">GDestroyNotify</span></a> destroy_data);</pre>
1.1.54 by Baptiste Mille-Mathias
Import upstream version 2.25.3
506
<p>
507
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>
508
is sent over the bus.</p>
509
<div class="variablelist"><table border="0">
510
<col align="left" valign="top">
511
<tbody>
512
<tr>
513
<td><p><span class="term"><em class="parameter"><code>bus</code></em> :</span></p></td>
1.1.77 by Sebastien Bacher
Import upstream version 2.30.0
514
<td> a <a class="link" href="GeditMessageBus.html" title="GeditMessageBus"><span class="type">GeditMessageBus</span></a>
1.1.54 by Baptiste Mille-Mathias
Import upstream version 2.25.3
515
</td>
516
</tr>
517
<tr>
518
<td><p><span class="term"><em class="parameter"><code>object_path</code></em> :</span></p></td>
1.1.77 by Sebastien Bacher
Import upstream version 2.30.0
519
<td> the object path
1.1.54 by Baptiste Mille-Mathias
Import upstream version 2.25.3
520
</td>
521
</tr>
522
<tr>
523
<td><p><span class="term"><em class="parameter"><code>method</code></em> :</span></p></td>
1.1.77 by Sebastien Bacher
Import upstream version 2.30.0
524
<td> the method
1.1.54 by Baptiste Mille-Mathias
Import upstream version 2.25.3
525
</td>
526
</tr>
527
<tr>
528
<td><p><span class="term"><em class="parameter"><code>callback</code></em> :</span></p></td>
1.1.77 by Sebastien Bacher
Import upstream version 2.30.0
529
<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
1.1.54 by Baptiste Mille-Mathias
Import upstream version 2.25.3
530
</td>
531
</tr>
532
<tr>
533
<td><p><span class="term"><em class="parameter"><code>userdata</code></em> :</span></p></td>
1.1.77 by Sebastien Bacher
Import upstream version 2.30.0
534
<td> userdata to use for the callback
1.1.54 by Baptiste Mille-Mathias
Import upstream version 2.25.3
535
</td>
536
</tr>
537
<tr>
538
<td><p><span class="term"><em class="parameter"><code>destroy_data</code></em> :</span></p></td>
1.1.77 by Sebastien Bacher
Import upstream version 2.30.0
539
<td> function to evoke with <em class="parameter"><code>userdata</code></em> as argument when <em class="parameter"><code>userdata</code></em>
1.1.54 by Baptiste Mille-Mathias
Import upstream version 2.25.3
540
               needs to be freed
541
</td>
542
</tr>
543
<tr>
544
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
545
<td> the callback identifier
546
547
</td>
548
</tr>
549
</tbody>
550
</table></div>
551
</div>
552
<hr>
1.1.69 by Sebastien Bacher
Import upstream version 2.29.2
553
<div class="refsect2" title="gedit_message_bus_disconnect ()">
1.1.54 by Baptiste Mille-Mathias
Import upstream version 2.25.3
554
<a name="gedit-message-bus-disconnect"></a><h3>gedit_message_bus_disconnect ()</h3>
1.1.77 by Sebastien Bacher
Import upstream version 2.30.0
555
<pre class="programlisting"><span class="returnvalue">void</span>                gedit_message_bus_disconnect        (<a class="link" href="GeditMessageBus.html" title="GeditMessageBus"><span class="returnvalue">GeditMessageBus</span></a> *bus,
556
                                                         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a> id);</pre>
1.1.54 by Baptiste Mille-Mathias
Import upstream version 2.25.3
557
<p>
558
Disconnects a previously connected message callback.</p>
559
<div class="variablelist"><table border="0">
560
<col align="left" valign="top">
561
<tbody>
562
<tr>
563
<td><p><span class="term"><em class="parameter"><code>bus</code></em> :</span></p></td>
1.1.77 by Sebastien Bacher
Import upstream version 2.30.0
564
<td> a <a class="link" href="GeditMessageBus.html" title="GeditMessageBus"><span class="type">GeditMessageBus</span></a>
1.1.54 by Baptiste Mille-Mathias
Import upstream version 2.25.3
565
</td>
566
</tr>
567
<tr>
568
<td><p><span class="term"><em class="parameter"><code>id</code></em> :</span></p></td>
1.1.77 by Sebastien Bacher
Import upstream version 2.30.0
569
<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>
1.1.54 by Baptiste Mille-Mathias
Import upstream version 2.25.3
570
</td>
571
</tr>
572
</tbody>
573
</table></div>
574
</div>
575
<hr>
1.1.69 by Sebastien Bacher
Import upstream version 2.29.2
576
<div class="refsect2" title="gedit_message_bus_disconnect_by_func ()">
1.1.54 by Baptiste Mille-Mathias
Import upstream version 2.25.3
577
<a name="gedit-message-bus-disconnect-by-func"></a><h3>gedit_message_bus_disconnect_by_func ()</h3>
1.1.76 by Sebastien Bacher
Import upstream version 2.29.9
578
<pre class="programlisting"><span class="returnvalue">void</span>                gedit_message_bus_disconnect_by_func
1.1.77 by Sebastien Bacher
Import upstream version 2.30.0
579
                                                        (<a class="link" href="GeditMessageBus.html" title="GeditMessageBus"><span class="returnvalue">GeditMessageBus</span></a> *bus,
580
                                                         const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *object_path,
581
                                                         const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *method,
582
                                                         <a class="link" href="GeditMessageBus.html#GeditMessageCallback" title="GeditMessageCallback ()"><span class="returnvalue">GeditMessageCallback</span></a> callback,
583
                                                         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="returnvalue">gpointer</span></a> userdata);</pre>
1.1.54 by Baptiste Mille-Mathias
Import upstream version 2.25.3
584
<p>
585
Disconnects a previously connected message callback by matching the 
586
provided callback function and userdata. See also 
587
<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>
588
<div class="variablelist"><table border="0">
589
<col align="left" valign="top">
590
<tbody>
591
<tr>
592
<td><p><span class="term"><em class="parameter"><code>bus</code></em> :</span></p></td>
1.1.77 by Sebastien Bacher
Import upstream version 2.30.0
593
<td> a <a class="link" href="GeditMessageBus.html" title="GeditMessageBus"><span class="type">GeditMessageBus</span></a>
1.1.54 by Baptiste Mille-Mathias
Import upstream version 2.25.3
594
</td>
595
</tr>
596
<tr>
597
<td><p><span class="term"><em class="parameter"><code>object_path</code></em> :</span></p></td>
1.1.77 by Sebastien Bacher
Import upstream version 2.30.0
598
<td> the object path
1.1.54 by Baptiste Mille-Mathias
Import upstream version 2.25.3
599
</td>
600
</tr>
601
<tr>
602
<td><p><span class="term"><em class="parameter"><code>method</code></em> :</span></p></td>
1.1.77 by Sebastien Bacher
Import upstream version 2.30.0
603
<td> the method
1.1.54 by Baptiste Mille-Mathias
Import upstream version 2.25.3
604
</td>
605
</tr>
606
<tr>
607
<td><p><span class="term"><em class="parameter"><code>callback</code></em> :</span></p></td>
1.1.77 by Sebastien Bacher
Import upstream version 2.30.0
608
<td> the connected callback
1.1.54 by Baptiste Mille-Mathias
Import upstream version 2.25.3
609
</td>
610
</tr>
611
<tr>
612
<td><p><span class="term"><em class="parameter"><code>userdata</code></em> :</span></p></td>
1.1.77 by Sebastien Bacher
Import upstream version 2.30.0
613
<td> the userdata with which the callback was connected
1.1.54 by Baptiste Mille-Mathias
Import upstream version 2.25.3
614
</td>
615
</tr>
616
</tbody>
617
</table></div>
618
</div>
619
<hr>
1.1.69 by Sebastien Bacher
Import upstream version 2.29.2
620
<div class="refsect2" title="gedit_message_bus_block ()">
1.1.54 by Baptiste Mille-Mathias
Import upstream version 2.25.3
621
<a name="gedit-message-bus-block"></a><h3>gedit_message_bus_block ()</h3>
1.1.77 by Sebastien Bacher
Import upstream version 2.30.0
622
<pre class="programlisting"><span class="returnvalue">void</span>                gedit_message_bus_block             (<a class="link" href="GeditMessageBus.html" title="GeditMessageBus"><span class="returnvalue">GeditMessageBus</span></a> *bus,
623
                                                         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a> id);</pre>
1.1.54 by Baptiste Mille-Mathias
Import upstream version 2.25.3
624
<p>
625
Blocks evoking the callback specified by <em class="parameter"><code>id</code></em>. Unblock the callback by
626
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>
627
<div class="variablelist"><table border="0">
628
<col align="left" valign="top">
629
<tbody>
630
<tr>
631
<td><p><span class="term"><em class="parameter"><code>bus</code></em> :</span></p></td>
1.1.77 by Sebastien Bacher
Import upstream version 2.30.0
632
<td> a <a class="link" href="GeditMessageBus.html" title="GeditMessageBus"><span class="type">GeditMessageBus</span></a>
1.1.54 by Baptiste Mille-Mathias
Import upstream version 2.25.3
633
</td>
634
</tr>
635
<tr>
636
<td><p><span class="term"><em class="parameter"><code>id</code></em> :</span></p></td>
1.1.77 by Sebastien Bacher
Import upstream version 2.30.0
637
<td> the callback id
1.1.54 by Baptiste Mille-Mathias
Import upstream version 2.25.3
638
</td>
639
</tr>
640
</tbody>
641
</table></div>
642
</div>
643
<hr>
1.1.69 by Sebastien Bacher
Import upstream version 2.29.2
644
<div class="refsect2" title="gedit_message_bus_block_by_func ()">
1.1.54 by Baptiste Mille-Mathias
Import upstream version 2.25.3
645
<a name="gedit-message-bus-block-by-func"></a><h3>gedit_message_bus_block_by_func ()</h3>
1.1.77 by Sebastien Bacher
Import upstream version 2.30.0
646
<pre class="programlisting"><span class="returnvalue">void</span>                gedit_message_bus_block_by_func     (<a class="link" href="GeditMessageBus.html" title="GeditMessageBus"><span class="returnvalue">GeditMessageBus</span></a> *bus,
647
                                                         const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *object_path,
648
                                                         const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *method,
649
                                                         <a class="link" href="GeditMessageBus.html#GeditMessageCallback" title="GeditMessageCallback ()"><span class="returnvalue">GeditMessageCallback</span></a> callback,
650
                                                         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="returnvalue">gpointer</span></a> userdata);</pre>
1.1.54 by Baptiste Mille-Mathias
Import upstream version 2.25.3
651
<p>
652
Blocks evoking the callback that matches provided <em class="parameter"><code>callback</code></em> and <em class="parameter"><code>userdata</code></em>.
653
Unblock the callback using <code class="function">gedit_message_unblock_by_func()</code>.</p>
654
<div class="variablelist"><table border="0">
655
<col align="left" valign="top">
656
<tbody>
657
<tr>
658
<td><p><span class="term"><em class="parameter"><code>bus</code></em> :</span></p></td>
1.1.77 by Sebastien Bacher
Import upstream version 2.30.0
659
<td> a <a class="link" href="GeditMessageBus.html" title="GeditMessageBus"><span class="type">GeditMessageBus</span></a>
1.1.54 by Baptiste Mille-Mathias
Import upstream version 2.25.3
660
</td>
661
</tr>
662
<tr>
663
<td><p><span class="term"><em class="parameter"><code>object_path</code></em> :</span></p></td>
1.1.77 by Sebastien Bacher
Import upstream version 2.30.0
664
<td> the object path
1.1.54 by Baptiste Mille-Mathias
Import upstream version 2.25.3
665
</td>
666
</tr>
667
<tr>
668
<td><p><span class="term"><em class="parameter"><code>method</code></em> :</span></p></td>
1.1.77 by Sebastien Bacher
Import upstream version 2.30.0
669
<td> the method
1.1.54 by Baptiste Mille-Mathias
Import upstream version 2.25.3
670
</td>
671
</tr>
672
<tr>
673
<td><p><span class="term"><em class="parameter"><code>callback</code></em> :</span></p></td>
1.1.77 by Sebastien Bacher
Import upstream version 2.30.0
674
<td> the callback to block
1.1.54 by Baptiste Mille-Mathias
Import upstream version 2.25.3
675
</td>
676
</tr>
677
<tr>
678
<td><p><span class="term"><em class="parameter"><code>userdata</code></em> :</span></p></td>
1.1.77 by Sebastien Bacher
Import upstream version 2.30.0
679
<td> the userdata with which the callback was connected
1.1.54 by Baptiste Mille-Mathias
Import upstream version 2.25.3
680
</td>
681
</tr>
682
</tbody>
683
</table></div>
684
</div>
685
<hr>
1.1.69 by Sebastien Bacher
Import upstream version 2.29.2
686
<div class="refsect2" title="gedit_message_bus_unblock ()">
1.1.54 by Baptiste Mille-Mathias
Import upstream version 2.25.3
687
<a name="gedit-message-bus-unblock"></a><h3>gedit_message_bus_unblock ()</h3>
1.1.77 by Sebastien Bacher
Import upstream version 2.30.0
688
<pre class="programlisting"><span class="returnvalue">void</span>                gedit_message_bus_unblock           (<a class="link" href="GeditMessageBus.html" title="GeditMessageBus"><span class="returnvalue">GeditMessageBus</span></a> *bus,
689
                                                         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a> id);</pre>
1.1.54 by Baptiste Mille-Mathias
Import upstream version 2.25.3
690
<p>
691
Unblocks the callback specified by <em class="parameter"><code>id</code></em>.</p>
692
<div class="variablelist"><table border="0">
693
<col align="left" valign="top">
694
<tbody>
695
<tr>
696
<td><p><span class="term"><em class="parameter"><code>bus</code></em> :</span></p></td>
1.1.77 by Sebastien Bacher
Import upstream version 2.30.0
697
<td> a <a class="link" href="GeditMessageBus.html" title="GeditMessageBus"><span class="type">GeditMessageBus</span></a>
1.1.54 by Baptiste Mille-Mathias
Import upstream version 2.25.3
698
</td>
699
</tr>
700
<tr>
701
<td><p><span class="term"><em class="parameter"><code>id</code></em> :</span></p></td>
1.1.77 by Sebastien Bacher
Import upstream version 2.30.0
702
<td> the callback id
1.1.54 by Baptiste Mille-Mathias
Import upstream version 2.25.3
703
</td>
704
</tr>
705
</tbody>
706
</table></div>
707
</div>
708
<hr>
1.1.69 by Sebastien Bacher
Import upstream version 2.29.2
709
<div class="refsect2" title="gedit_message_bus_unblock_by_func ()">
1.1.54 by Baptiste Mille-Mathias
Import upstream version 2.25.3
710
<a name="gedit-message-bus-unblock-by-func"></a><h3>gedit_message_bus_unblock_by_func ()</h3>
1.1.77 by Sebastien Bacher
Import upstream version 2.30.0
711
<pre class="programlisting"><span class="returnvalue">void</span>                gedit_message_bus_unblock_by_func   (<a class="link" href="GeditMessageBus.html" title="GeditMessageBus"><span class="returnvalue">GeditMessageBus</span></a> *bus,
712
                                                         const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *object_path,
713
                                                         const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *method,
714
                                                         <a class="link" href="GeditMessageBus.html#GeditMessageCallback" title="GeditMessageCallback ()"><span class="returnvalue">GeditMessageCallback</span></a> callback,
715
                                                         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="returnvalue">gpointer</span></a> userdata);</pre>
1.1.54 by Baptiste Mille-Mathias
Import upstream version 2.25.3
716
<p>
717
Unblocks the callback that matches provided <em class="parameter"><code>callback</code></em> and <em class="parameter"><code>userdata</code></em>.</p>
718
<div class="variablelist"><table border="0">
719
<col align="left" valign="top">
720
<tbody>
721
<tr>
722
<td><p><span class="term"><em class="parameter"><code>bus</code></em> :</span></p></td>
1.1.77 by Sebastien Bacher
Import upstream version 2.30.0
723
<td> a <a class="link" href="GeditMessageBus.html" title="GeditMessageBus"><span class="type">GeditMessageBus</span></a>
1.1.54 by Baptiste Mille-Mathias
Import upstream version 2.25.3
724
</td>
725
</tr>
726
<tr>
727
<td><p><span class="term"><em class="parameter"><code>object_path</code></em> :</span></p></td>
1.1.77 by Sebastien Bacher
Import upstream version 2.30.0
728
<td> the object path
1.1.54 by Baptiste Mille-Mathias
Import upstream version 2.25.3
729
</td>
730
</tr>
731
<tr>
732
<td><p><span class="term"><em class="parameter"><code>method</code></em> :</span></p></td>
1.1.77 by Sebastien Bacher
Import upstream version 2.30.0
733
<td> the method
1.1.54 by Baptiste Mille-Mathias
Import upstream version 2.25.3
734
</td>
735
</tr>
736
<tr>
737
<td><p><span class="term"><em class="parameter"><code>callback</code></em> :</span></p></td>
1.1.77 by Sebastien Bacher
Import upstream version 2.30.0
738
<td> the callback to block
1.1.54 by Baptiste Mille-Mathias
Import upstream version 2.25.3
739
</td>
740
</tr>
741
<tr>
742
<td><p><span class="term"><em class="parameter"><code>userdata</code></em> :</span></p></td>
1.1.77 by Sebastien Bacher
Import upstream version 2.30.0
743
<td> the userdata with which the callback was connected
1.1.54 by Baptiste Mille-Mathias
Import upstream version 2.25.3
744
</td>
745
</tr>
746
</tbody>
747
</table></div>
748
</div>
749
<hr>
1.1.69 by Sebastien Bacher
Import upstream version 2.29.2
750
<div class="refsect2" title="gedit_message_bus_send_message ()">
1.1.54 by Baptiste Mille-Mathias
Import upstream version 2.25.3
751
<a name="gedit-message-bus-send-message"></a><h3>gedit_message_bus_send_message ()</h3>
1.1.77 by Sebastien Bacher
Import upstream version 2.30.0
752
<pre class="programlisting"><span class="returnvalue">void</span>                gedit_message_bus_send_message      (<a class="link" href="GeditMessageBus.html" title="GeditMessageBus"><span class="returnvalue">GeditMessageBus</span></a> *bus,
753
                                                         <a class="link" href="GeditMessage.html" title="GeditMessage"><span class="returnvalue">GeditMessage</span></a> *message);</pre>
1.1.54 by Baptiste Mille-Mathias
Import upstream version 2.25.3
754
<p>
755
This sends the provided <em class="parameter"><code>message</code></em> asynchronously over the bus. To send
756
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 
757
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
758
a message without constructing the message object explicitly first.</p>
759
<div class="variablelist"><table border="0">
760
<col align="left" valign="top">
761
<tbody>
762
<tr>
763
<td><p><span class="term"><em class="parameter"><code>bus</code></em> :</span></p></td>
1.1.77 by Sebastien Bacher
Import upstream version 2.30.0
764
<td> a <a class="link" href="GeditMessageBus.html" title="GeditMessageBus"><span class="type">GeditMessageBus</span></a>
1.1.54 by Baptiste Mille-Mathias
Import upstream version 2.25.3
765
</td>
766
</tr>
767
<tr>
768
<td><p><span class="term"><em class="parameter"><code>message</code></em> :</span></p></td>
1.1.77 by Sebastien Bacher
Import upstream version 2.30.0
769
<td> the message to send
1.1.54 by Baptiste Mille-Mathias
Import upstream version 2.25.3
770
</td>
771
</tr>
772
</tbody>
773
</table></div>
774
</div>
775
<hr>
1.1.69 by Sebastien Bacher
Import upstream version 2.29.2
776
<div class="refsect2" title="gedit_message_bus_send_message_sync ()">
1.1.54 by Baptiste Mille-Mathias
Import upstream version 2.25.3
777
<a name="gedit-message-bus-send-message-sync"></a><h3>gedit_message_bus_send_message_sync ()</h3>
1.1.77 by Sebastien Bacher
Import upstream version 2.30.0
778
<pre class="programlisting"><span class="returnvalue">void</span>                gedit_message_bus_send_message_sync (<a class="link" href="GeditMessageBus.html" title="GeditMessageBus"><span class="returnvalue">GeditMessageBus</span></a> *bus,
779
                                                         <a class="link" href="GeditMessage.html" title="GeditMessage"><span class="returnvalue">GeditMessage</span></a> *message);</pre>
1.1.54 by Baptiste Mille-Mathias
Import upstream version 2.25.3
780
<p>
781
This sends the provided <em class="parameter"><code>message</code></em> synchronously over the bus. To send
782
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 
783
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
784
a message without constructing the message object explicitly first.</p>
785
<div class="variablelist"><table border="0">
786
<col align="left" valign="top">
787
<tbody>
788
<tr>
789
<td><p><span class="term"><em class="parameter"><code>bus</code></em> :</span></p></td>
1.1.77 by Sebastien Bacher
Import upstream version 2.30.0
790
<td> a <a class="link" href="GeditMessageBus.html" title="GeditMessageBus"><span class="type">GeditMessageBus</span></a>
1.1.54 by Baptiste Mille-Mathias
Import upstream version 2.25.3
791
</td>
792
</tr>
793
<tr>
794
<td><p><span class="term"><em class="parameter"><code>message</code></em> :</span></p></td>
1.1.77 by Sebastien Bacher
Import upstream version 2.30.0
795
<td> the message to send
1.1.54 by Baptiste Mille-Mathias
Import upstream version 2.25.3
796
</td>
797
</tr>
798
</tbody>
799
</table></div>
800
</div>
801
<hr>
1.1.69 by Sebastien Bacher
Import upstream version 2.29.2
802
<div class="refsect2" title="gedit_message_bus_send ()">
1.1.54 by Baptiste Mille-Mathias
Import upstream version 2.25.3
803
<a name="gedit-message-bus-send"></a><h3>gedit_message_bus_send ()</h3>
1.1.77 by Sebastien Bacher
Import upstream version 2.30.0
804
<pre class="programlisting"><span class="returnvalue">void</span>                gedit_message_bus_send              (<a class="link" href="GeditMessageBus.html" title="GeditMessageBus"><span class="returnvalue">GeditMessageBus</span></a> *bus,
805
                                                         const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *object_path,
806
                                                         const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *method,
807
                                                         ...);</pre>
1.1.54 by Baptiste Mille-Mathias
Import upstream version 2.25.3
808
<p>
809
This provides a convenient way to quickly send a message <em class="parameter"><code>method</code></em> at 
810
<em class="parameter"><code>object_path</code></em> asynchronously over the bus. The variable argument list 
811
specifies key (string) value pairs used to construct the message arguments. 
812
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>
813
<div class="variablelist"><table border="0">
814
<col align="left" valign="top">
815
<tbody>
816
<tr>
817
<td><p><span class="term"><em class="parameter"><code>bus</code></em> :</span></p></td>
1.1.77 by Sebastien Bacher
Import upstream version 2.30.0
818
<td> a <a class="link" href="GeditMessageBus.html" title="GeditMessageBus"><span class="type">GeditMessageBus</span></a>
1.1.54 by Baptiste Mille-Mathias
Import upstream version 2.25.3
819
</td>
820
</tr>
821
<tr>
822
<td><p><span class="term"><em class="parameter"><code>object_path</code></em> :</span></p></td>
1.1.77 by Sebastien Bacher
Import upstream version 2.30.0
823
<td> the object path
1.1.54 by Baptiste Mille-Mathias
Import upstream version 2.25.3
824
</td>
825
</tr>
826
<tr>
827
<td><p><span class="term"><em class="parameter"><code>method</code></em> :</span></p></td>
1.1.77 by Sebastien Bacher
Import upstream version 2.30.0
828
<td> the method
1.1.54 by Baptiste Mille-Mathias
Import upstream version 2.25.3
829
</td>
830
</tr>
831
<tr>
832
<td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td>
1.1.77 by Sebastien Bacher
Import upstream version 2.30.0
833
<td> NULL terminated list of key/value pairs
1.1.54 by Baptiste Mille-Mathias
Import upstream version 2.25.3
834
</td>
835
</tr>
836
</tbody>
837
</table></div>
838
</div>
839
<hr>
1.1.69 by Sebastien Bacher
Import upstream version 2.29.2
840
<div class="refsect2" title="gedit_message_bus_send_sync ()">
1.1.54 by Baptiste Mille-Mathias
Import upstream version 2.25.3
841
<a name="gedit-message-bus-send-sync"></a><h3>gedit_message_bus_send_sync ()</h3>
1.1.77 by Sebastien Bacher
Import upstream version 2.30.0
842
<pre class="programlisting"><a class="link" href="GeditMessage.html" title="GeditMessage"><span class="returnvalue">GeditMessage</span></a> *      gedit_message_bus_send_sync         (<a class="link" href="GeditMessageBus.html" title="GeditMessageBus"><span class="returnvalue">GeditMessageBus</span></a> *bus,
843
                                                         const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *object_path,
844
                                                         const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *method,
845
                                                         ...);</pre>
1.1.54 by Baptiste Mille-Mathias
Import upstream version 2.25.3
846
<p>
847
This provides a convenient way to quickly send a message <em class="parameter"><code>method</code></em> at 
848
<em class="parameter"><code>object_path</code></em> synchronously over the bus. The variable argument list 
849
specifies key (string) value pairs used to construct the message 
850
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>
851
<div class="variablelist"><table border="0">
852
<col align="left" valign="top">
853
<tbody>
854
<tr>
855
<td><p><span class="term"><em class="parameter"><code>bus</code></em> :</span></p></td>
1.1.77 by Sebastien Bacher
Import upstream version 2.30.0
856
<td> a <a class="link" href="GeditMessageBus.html" title="GeditMessageBus"><span class="type">GeditMessageBus</span></a>
1.1.54 by Baptiste Mille-Mathias
Import upstream version 2.25.3
857
</td>
858
</tr>
859
<tr>
860
<td><p><span class="term"><em class="parameter"><code>object_path</code></em> :</span></p></td>
1.1.77 by Sebastien Bacher
Import upstream version 2.30.0
861
<td> the object path
1.1.54 by Baptiste Mille-Mathias
Import upstream version 2.25.3
862
</td>
863
</tr>
864
<tr>
865
<td><p><span class="term"><em class="parameter"><code>method</code></em> :</span></p></td>
1.1.77 by Sebastien Bacher
Import upstream version 2.30.0
866
<td> the method
1.1.54 by Baptiste Mille-Mathias
Import upstream version 2.25.3
867
</td>
868
</tr>
869
<tr>
870
<td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td>
1.1.77 by Sebastien Bacher
Import upstream version 2.30.0
871
<td> NULL terminated list of key/value pairs
1.1.54 by Baptiste Mille-Mathias
Import upstream version 2.25.3
872
</td>
873
</tr>
874
<tr>
875
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1.1.63 by Robert Ancell
Import upstream version 2.27.2
876
<td> the constructed <a class="link" href="GeditMessage.html" title="GeditMessage"><span class="type">GeditMessage</span></a>. The caller owns a reference
1.1.76 by Sebastien Bacher
Import upstream version 2.29.9
877
              to the <a class="link" href="GeditMessage.html" title="GeditMessage"><span class="type">GeditMessage</span></a> and should call <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a> when
1.1.54 by Baptiste Mille-Mathias
Import upstream version 2.25.3
878
              it is no longer needed
879
</td>
880
</tr>
881
</tbody>
882
</table></div>
883
</div>
884
</div>
1.1.69 by Sebastien Bacher
Import upstream version 2.29.2
885
<div class="refsect1" title="Signal Details">
1.1.54 by Baptiste Mille-Mathias
Import upstream version 2.25.3
886
<a name="GeditMessageBus.signal-details"></a><h2>Signal Details</h2>
1.1.69 by Sebastien Bacher
Import upstream version 2.29.2
887
<div class="refsect2" title='The "dispatch" signal'>
1.1.54 by Baptiste Mille-Mathias
Import upstream version 2.25.3
888
<a name="GeditMessageBus-dispatch"></a><h3>The <code class="literal">"dispatch"</code> signal</h3>
1.1.76 by Sebastien Bacher
Import upstream version 2.29.9
889
<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,
890
                                                        <a class="link" href="GeditMessage.html" title="GeditMessage"><span class="type">GeditMessage</span></a>    *message,
891
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>         user_data)      : Run Last</pre>
1.1.54 by Baptiste Mille-Mathias
Import upstream version 2.25.3
892
<p>
893
The "dispatch" signal is emitted when a message is to be dispatched.
1.1.61 by Sebastien Bacher
Import upstream version 2.26.1
894
The message is dispatched in the default handler of this signal.
1.1.54 by Baptiste Mille-Mathias
Import upstream version 2.25.3
895
Primary use of this signal is to customize the dispatch of a message
896
(for instance to automatically dispatch all messages over DBus).
897
2</p>
898
<div class="variablelist"><table border="0">
899
<col align="left" valign="top">
900
<tbody>
901
<tr>
902
<td><p><span class="term"><em class="parameter"><code>bus</code></em> :</span></p></td>
1.1.77 by Sebastien Bacher
Import upstream version 2.30.0
903
<td> a <a class="link" href="GeditMessageBus.html" title="GeditMessageBus"><span class="type">GeditMessageBus</span></a>
1.1.54 by Baptiste Mille-Mathias
Import upstream version 2.25.3
904
</td>
905
</tr>
906
<tr>
907
<td><p><span class="term"><em class="parameter"><code>message</code></em> :</span></p></td>
1.1.77 by Sebastien Bacher
Import upstream version 2.30.0
908
<td> the <a class="link" href="GeditMessage.html" title="GeditMessage"><span class="type">GeditMessage</span></a> to dispatch
1.1.54 by Baptiste Mille-Mathias
Import upstream version 2.25.3
909
</td>
910
</tr>
911
<tr>
912
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
913
<td>user data set when the signal handler was connected.</td>
914
</tr>
915
</tbody>
916
</table></div>
917
</div>
918
<hr>
1.1.69 by Sebastien Bacher
Import upstream version 2.29.2
919
<div class="refsect2" title='The "registered" signal'>
1.1.54 by Baptiste Mille-Mathias
Import upstream version 2.25.3
920
<a name="GeditMessageBus-registered"></a><h3>The <code class="literal">"registered"</code> signal</h3>
1.1.76 by Sebastien Bacher
Import upstream version 2.29.9
921
<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,
922
                                                        <a class="link" href="gedit-GeditMessageType.html#GeditMessageType" title="GeditMessageType"><span class="type">GeditMessageType</span></a> *message_type,
923
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>          user_data)         : Run Last</pre>
1.1.54 by Baptiste Mille-Mathias
Import upstream version 2.25.3
924
<p>
925
The "registered" signal is emitted when a message has been registered
926
on the bus.</p>
927
<div class="variablelist"><table border="0">
928
<col align="left" valign="top">
929
<tbody>
930
<tr>
931
<td><p><span class="term"><em class="parameter"><code>bus</code></em> :</span></p></td>
1.1.77 by Sebastien Bacher
Import upstream version 2.30.0
932
<td> a <a class="link" href="GeditMessageBus.html" title="GeditMessageBus"><span class="type">GeditMessageBus</span></a>
1.1.54 by Baptiste Mille-Mathias
Import upstream version 2.25.3
933
</td>
934
</tr>
935
<tr>
936
<td><p><span class="term"><em class="parameter"><code>message_type</code></em> :</span></p></td>
1.1.77 by Sebastien Bacher
Import upstream version 2.30.0
937
<td> the registered <a class="link" href="gedit-GeditMessageType.html#GeditMessageType" title="GeditMessageType"><span class="type">GeditMessageType</span></a>
1.1.54 by Baptiste Mille-Mathias
Import upstream version 2.25.3
938
</td>
939
</tr>
940
<tr>
941
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
942
<td>user data set when the signal handler was connected.</td>
943
</tr>
944
</tbody>
945
</table></div>
946
</div>
947
<hr>
1.1.69 by Sebastien Bacher
Import upstream version 2.29.2
948
<div class="refsect2" title='The "unregistered" signal'>
1.1.54 by Baptiste Mille-Mathias
Import upstream version 2.25.3
949
<a name="GeditMessageBus-unregistered"></a><h3>The <code class="literal">"unregistered"</code> signal</h3>
1.1.76 by Sebastien Bacher
Import upstream version 2.29.9
950
<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,
951
                                                        <a class="link" href="gedit-GeditMessageType.html#GeditMessageType" title="GeditMessageType"><span class="type">GeditMessageType</span></a> *message_type,
952
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>          user_data)         : Run Last</pre>
1.1.54 by Baptiste Mille-Mathias
Import upstream version 2.25.3
953
<p>
954
The "unregistered" signal is emitted when a message has been 
955
unregistered from the bus.</p>
956
<div class="variablelist"><table border="0">
957
<col align="left" valign="top">
958
<tbody>
959
<tr>
960
<td><p><span class="term"><em class="parameter"><code>bus</code></em> :</span></p></td>
1.1.77 by Sebastien Bacher
Import upstream version 2.30.0
961
<td> a <a class="link" href="GeditMessageBus.html" title="GeditMessageBus"><span class="type">GeditMessageBus</span></a>
1.1.54 by Baptiste Mille-Mathias
Import upstream version 2.25.3
962
</td>
963
</tr>
964
<tr>
965
<td><p><span class="term"><em class="parameter"><code>message_type</code></em> :</span></p></td>
1.1.77 by Sebastien Bacher
Import upstream version 2.30.0
966
<td> the unregistered <a class="link" href="gedit-GeditMessageType.html#GeditMessageType" title="GeditMessageType"><span class="type">GeditMessageType</span></a>
1.1.54 by Baptiste Mille-Mathias
Import upstream version 2.25.3
967
</td>
968
</tr>
969
<tr>
970
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
971
<td>user data set when the signal handler was connected.</td>
972
</tr>
973
</tbody>
974
</table></div>
975
</div>
976
</div>
977
</div>
978
<div class="footer">
979
<hr>
1.1.77 by Sebastien Bacher
Import upstream version 2.30.0
980
          Generated by GTK-Doc V1.13</div>
1.1.54 by Baptiste Mille-Mathias
Import upstream version 2.25.3
981
</body>
1.1.76 by Sebastien Bacher
Import upstream version 2.29.9
982
</html>