43
43
<div class="refsynopsisdiv" title="Synopsis">
44
44
<a name="GeditMessageBus.synopsis"></a><h2>Synopsis</h2>
45
45
<pre class="synopsis">
47
46
#include <gedit/gedit-message-bus.h>
49
48
<a class="link" href="GeditMessageBus.html#GeditMessageBus-struct" title="GeditMessageBus">GeditMessageBus</a>;
50
void (<a class="link" href="GeditMessageBus.html#GeditMessageCallback" title="GeditMessageCallback ()">*GeditMessageCallback</a>) (<a class="link" href="GeditMessageBus.html" title="GeditMessageBus">GeditMessageBus</a> *bus,
51
<a class="link" href="GeditMessage.html" title="GeditMessage">GeditMessage</a> *message,
53
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"
54
>gpointer</a> userdata);
55
<a class="link" href="GeditMessageBus.html" title="GeditMessageBus">GeditMessageBus</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);
56
<a class="link" href="GeditMessageBus.html" title="GeditMessageBus">GeditMessageBus</a> * <a class="link" href="GeditMessageBus.html#gedit-message-bus-new" title="gedit_message_bus_new ()">gedit_message_bus_new</a> (void);
57
<a class="link" href="gedit-GeditMessageType.html#GeditMessageType" title="GeditMessageType">GeditMessageType</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">GeditMessageBus</a> *bus,
59
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
60
>gchar</a> *object_path,
62
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
64
<a class="link" href="gedit-GeditMessageType.html#GeditMessageType" title="GeditMessageType">GeditMessageType</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">GeditMessageBus</a> *bus,
66
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
67
>gchar</a> *object_path,
69
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
72
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"
73
>guint</a> num_optional,
75
void <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">GeditMessageBus</a> *bus,
76
<a class="link" href="gedit-GeditMessageType.html#GeditMessageType" title="GeditMessageType">GeditMessageType</a> *message_type);
77
void <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">GeditMessageBus</a> *bus,
79
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
80
>gchar</a> *object_path);
82
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
83
>gboolean</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">GeditMessageBus</a> *bus,
85
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
86
>gchar</a> *object_path,
88
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
90
void <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">GeditMessageBus</a> *bus,
91
GeditMessageBusForeach func,
93
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"
94
>gpointer</a> userdata);
96
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"
97
>guint</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">GeditMessageBus</a> *bus,
99
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
100
>gchar</a> *object_path,
102
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
104
<a class="link" href="GeditMessageBus.html#GeditMessageCallback" title="GeditMessageCallback ()">GeditMessageCallback</a> callback,
106
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"
107
>gpointer</a> userdata,
109
href="http://library.gnome.org/devel/glib/unstable/glib-Datasets.html#GDestroyNotify"
110
>GDestroyNotify</a> destroy_data);
111
void <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">GeditMessageBus</a> *bus,
113
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"
115
void <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>
116
(<a class="link" href="GeditMessageBus.html" title="GeditMessageBus">GeditMessageBus</a> *bus,
118
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
119
>gchar</a> *object_path,
121
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
123
<a class="link" href="GeditMessageBus.html#GeditMessageCallback" title="GeditMessageCallback ()">GeditMessageCallback</a> callback,
125
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"
126
>gpointer</a> userdata);
127
void <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">GeditMessageBus</a> *bus,
129
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"
131
void <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">GeditMessageBus</a> *bus,
133
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
134
>gchar</a> *object_path,
136
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
138
<a class="link" href="GeditMessageBus.html#GeditMessageCallback" title="GeditMessageCallback ()">GeditMessageCallback</a> callback,
140
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"
141
>gpointer</a> userdata);
142
void <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">GeditMessageBus</a> *bus,
144
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"
146
void <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">GeditMessageBus</a> *bus,
148
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
149
>gchar</a> *object_path,
151
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
153
<a class="link" href="GeditMessageBus.html#GeditMessageCallback" title="GeditMessageCallback ()">GeditMessageCallback</a> callback,
155
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"
156
>gpointer</a> userdata);
157
void <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">GeditMessageBus</a> *bus,
158
<a class="link" href="GeditMessage.html" title="GeditMessage">GeditMessage</a> *message);
159
void <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">GeditMessageBus</a> *bus,
160
<a class="link" href="GeditMessage.html" title="GeditMessage">GeditMessage</a> *message);
161
void <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">GeditMessageBus</a> *bus,
163
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
164
>gchar</a> *object_path,
166
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
169
<a class="link" href="GeditMessage.html" title="GeditMessage">GeditMessage</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">GeditMessageBus</a> *bus,
171
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
172
>gchar</a> *object_path,
174
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
49
<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>,
50
<em class="parameter"><code><a class="link" href="GeditMessage.html" title="GeditMessage"><span class="type">GeditMessage</span></a> *message</code></em>,
51
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> userdata</code></em>);
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> (<em class="parameter"><code><span class="type">void</span></code></em>);
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> (<em class="parameter"><code><span class="type">void</span></code></em>);
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> (<em class="parameter"><code><a class="link" href="GeditMessageBus.html" title="GeditMessageBus"><span class="type">GeditMessageBus</span></a> *bus</code></em>,
55
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *object_path</code></em>,
56
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *method</code></em>);
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> (<em class="parameter"><code><a class="link" href="GeditMessageBus.html" title="GeditMessageBus"><span class="type">GeditMessageBus</span></a> *bus</code></em>,
58
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *object_path</code></em>,
59
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *method</code></em>,
60
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> num_optional</code></em>,
61
<em class="parameter"><code>...</code></em>);
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> (<em class="parameter"><code><a class="link" href="GeditMessageBus.html" title="GeditMessageBus"><span class="type">GeditMessageBus</span></a> *bus</code></em>,
63
<em class="parameter"><code><a class="link" href="gedit-GeditMessageType.html#GeditMessageType" title="GeditMessageType"><span class="type">GeditMessageType</span></a> *message_type</code></em>);
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> (<em class="parameter"><code><a class="link" href="GeditMessageBus.html" title="GeditMessageBus"><span class="type">GeditMessageBus</span></a> *bus</code></em>,
65
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *object_path</code></em>);
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> (<em class="parameter"><code><a class="link" href="GeditMessageBus.html" title="GeditMessageBus"><span class="type">GeditMessageBus</span></a> *bus</code></em>,
67
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *object_path</code></em>,
68
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *method</code></em>);
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> (<em class="parameter"><code><a class="link" href="GeditMessageBus.html" title="GeditMessageBus"><span class="type">GeditMessageBus</span></a> *bus</code></em>,
70
<em class="parameter"><code><span class="type">GeditMessageBusForeach</span> func</code></em>,
71
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> userdata</code></em>);
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> (<em class="parameter"><code><a class="link" href="GeditMessageBus.html" title="GeditMessageBus"><span class="type">GeditMessageBus</span></a> *bus</code></em>,
73
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *object_path</code></em>,
74
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *method</code></em>,
75
<em class="parameter"><code><a class="link" href="GeditMessageBus.html#GeditMessageCallback" title="GeditMessageCallback ()"><span class="type">GeditMessageCallback</span></a> callback</code></em>,
76
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> userdata</code></em>,
77
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Datasets.html#GDestroyNotify"><span class="type">GDestroyNotify</span></a> destroy_data</code></em>);
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> (<em class="parameter"><code><a class="link" href="GeditMessageBus.html" title="GeditMessageBus"><span class="type">GeditMessageBus</span></a> *bus</code></em>,
79
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> id</code></em>);
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>
81
(<em class="parameter"><code><a class="link" href="GeditMessageBus.html" title="GeditMessageBus"><span class="type">GeditMessageBus</span></a> *bus</code></em>,
82
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *object_path</code></em>,
83
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *method</code></em>,
84
<em class="parameter"><code><a class="link" href="GeditMessageBus.html#GeditMessageCallback" title="GeditMessageCallback ()"><span class="type">GeditMessageCallback</span></a> callback</code></em>,
85
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> userdata</code></em>);
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> (<em class="parameter"><code><a class="link" href="GeditMessageBus.html" title="GeditMessageBus"><span class="type">GeditMessageBus</span></a> *bus</code></em>,
87
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> id</code></em>);
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> (<em class="parameter"><code><a class="link" href="GeditMessageBus.html" title="GeditMessageBus"><span class="type">GeditMessageBus</span></a> *bus</code></em>,
89
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *object_path</code></em>,
90
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *method</code></em>,
91
<em class="parameter"><code><a class="link" href="GeditMessageBus.html#GeditMessageCallback" title="GeditMessageCallback ()"><span class="type">GeditMessageCallback</span></a> callback</code></em>,
92
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> userdata</code></em>);
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> (<em class="parameter"><code><a class="link" href="GeditMessageBus.html" title="GeditMessageBus"><span class="type">GeditMessageBus</span></a> *bus</code></em>,
94
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> id</code></em>);
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> (<em class="parameter"><code><a class="link" href="GeditMessageBus.html" title="GeditMessageBus"><span class="type">GeditMessageBus</span></a> *bus</code></em>,
96
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *object_path</code></em>,
97
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *method</code></em>,
98
<em class="parameter"><code><a class="link" href="GeditMessageBus.html#GeditMessageCallback" title="GeditMessageCallback ()"><span class="type">GeditMessageCallback</span></a> callback</code></em>,
99
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> userdata</code></em>);
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> (<em class="parameter"><code><a class="link" href="GeditMessageBus.html" title="GeditMessageBus"><span class="type">GeditMessageBus</span></a> *bus</code></em>,
101
<em class="parameter"><code><a class="link" href="GeditMessage.html" title="GeditMessage"><span class="type">GeditMessage</span></a> *message</code></em>);
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> (<em class="parameter"><code><a class="link" href="GeditMessageBus.html" title="GeditMessageBus"><span class="type">GeditMessageBus</span></a> *bus</code></em>,
103
<em class="parameter"><code><a class="link" href="GeditMessage.html" title="GeditMessage"><span class="type">GeditMessage</span></a> *message</code></em>);
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> (<em class="parameter"><code><a class="link" href="GeditMessageBus.html" title="GeditMessageBus"><span class="type">GeditMessageBus</span></a> *bus</code></em>,
105
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *object_path</code></em>,
106
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *method</code></em>,
107
<em class="parameter"><code>...</code></em>);
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> (<em class="parameter"><code><a class="link" href="GeditMessageBus.html" title="GeditMessageBus"><span class="type">GeditMessageBus</span></a> *bus</code></em>,
109
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *object_path</code></em>,
110
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *method</code></em>,
111
<em class="parameter"><code>...</code></em>);
179
114
<div class="refsect1" title="Object Hierarchy">
180
115
<a name="GeditMessageBus.object-hierarchy"></a><h2>Object Hierarchy</h2>
181
116
<pre class="synopsis">
183
href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"
117
<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
185
118
+----GeditMessageBus
222
155
<div class="example">
223
<a name="id527769"></a><p class="title"><b>Example 1. Registering a message type</b></p>
224
<div class="example-contents"><pre class="programlisting">
225
GeditMessageBus *bus = gedit_message_bus_get_default ();
227
// Register 'method' at '/plugins/example' with one required
228
// string argument 'arg1'
229
GeditMessageType *message_type = gedit_message_bus_register ("/plugins/example", "method",
231
"arg1", G_TYPE_STRING,
156
<a name="id516774"></a><p class="title"><b>Example 1. Registering a message type</b></p>
157
<div class="example-contents">
158
<table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
161
<td class="listing_lines" align="right"><pre>1
169
<td class="listing_code"><pre class="programlisting">GeditMessageBus *bus = gedit_message_bus_get_default ();
171
<span class="comment">// Register 'method' at '/plugins/example' with one required</span>
172
<span class="comment">// string argument 'arg1'</span>
173
GeditMessageType *message_type = gedit_message_bus_register (<span class="number">"/plugins/example"</span>, <span class="number">"method"</span>,
174
<span class="number">0</span>,
175
<span class="number">"arg1"</span>, G_TYPE_STRING,
176
<span class="number">NULL</span>);</pre></td>
235
183
<p><br class="example-break">
237
185
<div class="example">
238
<a name="id527786"></a><p class="title"><b>Example 2. Connecting a callback</b></p>
239
<div class="example-contents"><pre class="programlisting">
186
<a name="id516791"></a><p class="title"><b>Example 2. Connecting a callback</b></p>
187
<div class="example-contents">
188
<table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
191
<td class="listing_lines" align="right"><pre>1
210
<td class="listing_code"><pre class="programlisting"><span class="type">static</span> <span class="type">void</span>
241
211
example_method_cb (GeditMessageBus *bus,
242
212
GeditMessage *message,
243
213
gpointer userdata)
215
gchar *arg1 = <span class="number">NULL</span>;
247
gedit_message_get (message, "arg1", &arg1, NULL);
248
g_message ("Evoked /plugins/example.method with: %s", arg1);
217
gedit_message_get (message, <span class="number">"arg1"</span>, &arg1, <span class="number">NULL</span>);
218
g_message (<span class="number">"Evoked /plugins/example.method with: </span><span class="symbol">%s</span><span class="number">"</span>, arg1);
252
222
GeditMessageBus *bus = gedit_message_bus_get_default ();
254
guint id = gedit_message_bus_connect (bus,
255
"/plugins/example", "method",
224
guint id = gedit_message_bus_connect (bus,
225
<span class="number">"/plugins/example"</span>, <span class="number">"method"</span>,
256
226
example_method_cb,
227
<span class="number">NULL</span>,
228
<span class="number">NULL</span>);</pre></td>
262
235
<p><br class="example-break">
264
237
<div class="example">
265
<a name="id527805"></a><p class="title"><b>Example 3. Sending a message</b></p>
266
<div class="example-contents"><pre class="programlisting">
267
GeditMessageBus *bus = gedit_message_bus_get_default ();
269
gedit_message_bus_send (bus,
270
"/plugins/example", "method",
271
"arg1", "Hello World",
238
<a name="id516810"></a><p class="title"><b>Example 3. Sending a message</b></p>
239
<div class="example-contents">
240
<table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
243
<td class="listing_lines" align="right"><pre>1
249
<td class="listing_code"><pre class="programlisting">GeditMessageBus *bus = gedit_message_bus_get_default ();
251
gedit_message_bus_send (bus,
252
<span class="number">"/plugins/example"</span>, <span class="number">"method"</span>,
253
<span class="number">"arg1"</span>, <span class="number">"Hello World"</span>,
254
<span class="number">NULL</span>);</pre></td>
275
261
<p><br class="example-break"></p>
279
263
<div class="refsect1" title="Details">
280
264
<a name="GeditMessageBus.details"></a><h2>Details</h2>
281
265
<div class="refsect2" title="GeditMessageBus">
282
266
<a name="GeditMessageBus-struct"></a><h3>GeditMessageBus</h3>
283
267
<pre class="programlisting">typedef struct _GeditMessageBus GeditMessageBus;</pre>
288
270
<div class="refsect2" title="GeditMessageCallback ()">
289
271
<a name="GeditMessageCallback"></a><h3>GeditMessageCallback ()</h3>
290
<pre class="programlisting">void (*GeditMessageCallback) (<a class="link" href="GeditMessageBus.html" title="GeditMessageBus">GeditMessageBus</a> *bus,
291
<a class="link" href="GeditMessage.html" title="GeditMessage">GeditMessage</a> *message,
293
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"
294
>gpointer</a> userdata);</pre>
272
<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>,
273
<em class="parameter"><code><a class="link" href="GeditMessage.html" title="GeditMessage"><span class="type">GeditMessage</span></a> *message</code></em>,
274
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> userdata</code></em>);</pre>
296
276
Callback signature used for connecting callback functions to be called
297
277
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>
300
278
<div class="variablelist"><table border="0">
301
279
<col align="left" valign="top">
304
282
<td><p><span class="term"><em class="parameter"><code>bus</code></em> :</span></p></td>
305
<td> the <a class="link" href="GeditMessageBus.html" title="GeditMessageBus"><span class="type">GeditMessageBus</span></a> on which the message was sent
283
<td>the <a class="link" href="GeditMessageBus.html" title="GeditMessageBus"><span class="type">GeditMessageBus</span></a> on which the message was sent
309
287
<td><p><span class="term"><em class="parameter"><code>message</code></em> :</span></p></td>
310
<td> the <a class="link" href="GeditMessage.html" title="GeditMessage"><span class="type">GeditMessage</span></a> which was sent
288
<td>the <a class="link" href="GeditMessage.html" title="GeditMessage"><span class="type">GeditMessage</span></a> which was sent
314
292
<td><p><span class="term"><em class="parameter"><code>userdata</code></em> :</span></p></td>
315
<td> the supplied user data when connecting the callback
293
<td>the supplied user data when connecting the callback
403
371
<div class="refsect2" title="gedit_message_bus_register ()">
404
372
<a name="gedit-message-bus-register"></a><h3>gedit_message_bus_register ()</h3>
405
<pre class="programlisting"><a class="link" href="gedit-GeditMessageType.html#GeditMessageType" title="GeditMessageType">GeditMessageType</a> * gedit_message_bus_register (<a class="link" href="GeditMessageBus.html" title="GeditMessageBus">GeditMessageBus</a> *bus,
407
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
408
>gchar</a> *object_path,
410
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
413
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"
414
>guint</a> num_optional,
373
<pre class="programlisting"><a class="link" href="gedit-GeditMessageType.html#GeditMessageType" title="GeditMessageType"><span class="returnvalue">GeditMessageType</span></a> * 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>,
374
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *object_path</code></em>,
375
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *method</code></em>,
376
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> num_optional</code></em>,
377
<em class="parameter"><code>...</code></em>);</pre>
417
379
Register a message on the bus. A message must be registered on the bus before
418
380
it can be send. This function registers the type arguments for <em class="parameter"><code>method</code></em> at
419
381
<em class="parameter"><code>object_path</code></em>. The arguments are specified with the variable arguments which
420
should contain pairs of const gchar *key and GType terminated by <code class="literal">NULL</code>. The
382
should contain pairs of const gchar *key and GType terminated by <a href="/opt/gnome/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>. The
421
383
last <em class="parameter"><code>num_optional</code></em> arguments are registered as optional (and are thus not
422
384
required when sending a message).
425
387
This function emits a <a class="link" href="GeditMessageBus.html#GeditMessageBus-registered" title='The "registered" signal'><span class="type">"registered"</span></a> signal.</p>
428
388
<div class="variablelist"><table border="0">
429
389
<col align="left" valign="top">
432
392
<td><p><span class="term"><em class="parameter"><code>bus</code></em> :</span></p></td>
433
<td> a <a class="link" href="GeditMessageBus.html" title="GeditMessageBus"><span class="type">GeditMessageBus</span></a>
393
<td>a <a class="link" href="GeditMessageBus.html" title="GeditMessageBus"><span class="type">GeditMessageBus</span></a>
437
397
<td><p><span class="term"><em class="parameter"><code>object_path</code></em> :</span></p></td>
442
402
<td><p><span class="term"><em class="parameter"><code>method</code></em> :</span></p></td>
443
<td> the method to register
403
<td>the method to register
447
407
<td><p><span class="term"><em class="parameter"><code>num_optional</code></em> :</span></p></td>
448
<td> the number of optional arguments
408
<td>the number of optional arguments
452
412
<td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td>
453
<td> NULL terminated list of key/gtype method argument pairs
413
<td>NULL terminated list of key/gtype method argument pairs
607
549
<div class="refsect2" title="gedit_message_bus_connect ()">
608
550
<a name="gedit-message-bus-connect"></a><h3>gedit_message_bus_connect ()</h3>
609
<pre class="programlisting"><a
610
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"
611
>guint</a> gedit_message_bus_connect (<a class="link" href="GeditMessageBus.html" title="GeditMessageBus">GeditMessageBus</a> *bus,
613
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
614
>gchar</a> *object_path,
616
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
618
<a class="link" href="GeditMessageBus.html#GeditMessageCallback" title="GeditMessageCallback ()">GeditMessageCallback</a> callback,
620
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"
621
>gpointer</a> userdata,
623
href="http://library.gnome.org/devel/glib/unstable/glib-Datasets.html#GDestroyNotify"
624
>GDestroyNotify</a> destroy_data);</pre>
551
<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 (<em class="parameter"><code><a class="link" href="GeditMessageBus.html" title="GeditMessageBus"><span class="type">GeditMessageBus</span></a> *bus</code></em>,
552
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *object_path</code></em>,
553
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *method</code></em>,
554
<em class="parameter"><code><a class="link" href="GeditMessageBus.html#GeditMessageCallback" title="GeditMessageCallback ()"><span class="type">GeditMessageCallback</span></a> callback</code></em>,
555
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> userdata</code></em>,
556
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Datasets.html#GDestroyNotify"><span class="type">GDestroyNotify</span></a> destroy_data</code></em>);</pre>
626
558
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>
627
559
is sent over the bus.</p>
630
560
<div class="variablelist"><table border="0">
631
561
<col align="left" valign="top">
634
564
<td><p><span class="term"><em class="parameter"><code>bus</code></em> :</span></p></td>
635
<td> a <a class="link" href="GeditMessageBus.html" title="GeditMessageBus"><span class="type">GeditMessageBus</span></a>
565
<td>a <a class="link" href="GeditMessageBus.html" title="GeditMessageBus"><span class="type">GeditMessageBus</span></a>
639
569
<td><p><span class="term"><em class="parameter"><code>object_path</code></em> :</span></p></td>
644
574
<td><p><span class="term"><em class="parameter"><code>method</code></em> :</span></p></td>
649
579
<td><p><span class="term"><em class="parameter"><code>callback</code></em> :</span></p></td>
650
<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
580
<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
654
584
<td><p><span class="term"><em class="parameter"><code>userdata</code></em> :</span></p></td>
655
<td> userdata to use for the callback
585
<td>userdata to use for the callback
659
589
<td><p><span class="term"><em class="parameter"><code>destroy_data</code></em> :</span></p></td>
660
<td> function to evoke with <em class="parameter"><code>userdata</code></em> as argument when <em class="parameter"><code>userdata</code></em>
590
<td>function to evoke with <em class="parameter"><code>userdata</code></em> as argument when <em class="parameter"><code>userdata</code></em>
661
591
needs to be freed