← Back to branch summary

~ubuntu-branches/ubuntu/lucid/gedit/lucid-proposed

« back to all changes in this revision

Viewing changes to docs/reference/xml/gedit-message-type.xml

  • Committer: Bazaar Package Importer
  • Author(s): Sebastien Bacher
  • Date: 2010-03-18 00:37:05 UTC
  • mfrom: (1.1.76 upstream)
  • Revision ID: james.westby@ubuntu.com-20100318003705-typ8fgrsezmc334h
Tags: 2.29.9-0ubuntu1
* New upstream version:
  - Fix a file corruption bug in the new file saving code 
  - Misc bugfixes
* debian/patches/80_not_using_localmodlibs.patch:
  - dropped, the change is in the new version

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/xml/gedit-message-type.xml
1
 
<?xml version="1.0"?>
2
 
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" 
3
 
               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
4
 
<refentry id="gedit-GeditMessageType">
5
 
<refmeta>
6
 
<refentrytitle role="top_of_page" id="gedit-GeditMessageType.top_of_page">GeditMessageType</refentrytitle>
7
 
<manvolnum>3</manvolnum>
8
 
<refmiscinfo>GEDIT Library</refmiscinfo>
9
 
</refmeta>
10
 
 
11
 
<refnamediv>
12
 
<refname>GeditMessageType</refname>
13
 
<refpurpose>message type description</refpurpose>
14
 
</refnamediv>
15
 
 
16
 
<refsynopsisdiv id="gedit-GeditMessageType.synopsis" role="synopsis">
17
 
<title role="synopsis.title">Synopsis</title>
18
 
 
19
 
<synopsis>
20
 
 
21
 
#include &lt;gedit/gedit-message-type.h&gt;
22
 
 
23
 
                    <link linkend="GeditMessageType">GeditMessageType</link>;
24
 
<link linkend="GType">GType</link>               <link linkend="gedit-message-type-get-type">gedit_message_type_get_type</link>         (void);
25
 
<link linkend="gboolean">gboolean</link>            <link linkend="gedit-message-type-is-supported">gedit_message_type_is_supported</link>     (<link linkend="GType">GType</link> type);
26
 
<link linkend="gchar">gchar</link> *             <link linkend="gedit-message-type-identifier">gedit_message_type_identifier</link>       (const <link linkend="gchar">gchar</link> *object_path,
27
 
                                                         const <link linkend="gchar">gchar</link> *method);
28
 
<link linkend="gboolean">gboolean</link>            <link linkend="gedit-message-type-is-valid-object-path">gedit_message_type_is_valid_object_path</link>
29
 
                                                        (const <link linkend="gchar">gchar</link> *object_path);
30
 
<link linkend="GeditMessageType">GeditMessageType</link> *  <link linkend="gedit-message-type-new">gedit_message_type_new</link>              (const <link linkend="gchar">gchar</link> *object_path,
31
 
                                                         const <link linkend="gchar">gchar</link> *method,
32
 
                                                         <link linkend="guint">guint</link> num_optional,
33
 
                                                         ...);
34
 
<link linkend="GeditMessageType">GeditMessageType</link> *  <link linkend="gedit-message-type-new-valist">gedit_message_type_new_valist</link>       (const <link linkend="gchar">gchar</link> *object_path,
35
 
                                                         const <link linkend="gchar">gchar</link> *method,
36
 
                                                         <link linkend="guint">guint</link> num_optional,
37
 
                                                         <link linkend="va-list">va_list</link> va_args);
38
 
<link linkend="GeditMessageType">GeditMessageType</link> *  <link linkend="gedit-message-type-ref">gedit_message_type_ref</link>              (<link linkend="GeditMessageType">GeditMessageType</link> *message_type);
39
 
<link linkend="void">void</link>                <link linkend="gedit-message-type-unref">gedit_message_type_unref</link>            (<link linkend="GeditMessageType">GeditMessageType</link> *message_type);
40
 
<link linkend="void">void</link>                <link linkend="gedit-message-type-set">gedit_message_type_set</link>              (<link linkend="GeditMessageType">GeditMessageType</link> *message_type,
41
 
                                                         <link linkend="guint">guint</link> num_optional,
42
 
                                                         ...);
43
 
<link linkend="void">void</link>                <link linkend="gedit-message-type-set-valist">gedit_message_type_set_valist</link>       (<link linkend="GeditMessageType">GeditMessageType</link> *message_type,
44
 
                                                         <link linkend="guint">guint</link> num_optional,
45
 
                                                         <link linkend="va-list">va_list</link> va_args);
46
 
<link linkend="GeditMessage">GeditMessage</link> *      <link linkend="gedit-message-type-instantiate">gedit_message_type_instantiate</link>      (<link linkend="GeditMessageType">GeditMessageType</link> *message_type,
47
 
                                                         ...);
48
 
<link linkend="GeditMessage">GeditMessage</link> *      <link linkend="gedit-message-type-instantiate-valist">gedit_message_type_instantiate_valist</link>
49
 
                                                        (<link linkend="GeditMessageType">GeditMessageType</link> *message_type,
50
 
                                                         <link linkend="va-list">va_list</link> va_args);
51
 
const <link linkend="gchar">gchar</link> *       <link linkend="gedit-message-type-get-object-path">gedit_message_type_get_object_path</link>  (<link linkend="GeditMessageType">GeditMessageType</link> *message_type);
52
 
const <link linkend="gchar">gchar</link> *       <link linkend="gedit-message-type-get-method">gedit_message_type_get_method</link>       (<link linkend="GeditMessageType">GeditMessageType</link> *message_type);
53
 
<link linkend="GType">GType</link>               <link linkend="gedit-message-type-lookup">gedit_message_type_lookup</link>           (<link linkend="GeditMessageType">GeditMessageType</link> *message_type,
54
 
                                                         const <link linkend="gchar">gchar</link> *key);
55
 
<link linkend="void">void</link>                <link linkend="gedit-message-type-foreach">gedit_message_type_foreach</link>          (<link linkend="GeditMessageType">GeditMessageType</link> *message_type,
56
 
                                                         <link linkend="GeditMessageTypeForeach">GeditMessageTypeForeach</link> func,
57
 
                                                         <link linkend="gpointer">gpointer</link> user_data);
58
 
</synopsis>
59
 
</refsynopsisdiv>
60
 
 
61
 
 
62
 
 
63
 
 
64
 
 
65
 
 
66
 
 
67
 
 
68
 
 
69
 
<refsect1 id="gedit-GeditMessageType.description" role="desc">
70
 
<title role="desc.title">Description</title>
71
 
<para>
72
 
A message type is a prototype description for a <link linkend="GeditMessage"><type>GeditMessage</type></link> used to
73
 
transmit messages on a <link linkend="GeditMessageBus"><type>GeditMessageBus</type></link>. The message type describes
74
 
the Object Path, Method and Arguments of the message.
75
 
</para>
76
 
<para>
77
 
A message type can contain any number of required and optional arguments.
78
 
To instantiate a <link linkend="GeditMessage"><type>GeditMessage</type></link> from a <link linkend="GeditMessageType"><type>GeditMessageType</type></link>, use 
79
 
<link linkend="gedit-message-type-instantiate"><function>gedit_message_type_instantiate()</function></link>.
80
 
</para>
81
 
<para>
82
 
Registering a new message type on a <link linkend="GeditMessageBus"><type>GeditMessageBus</type></link> with
83
 
<link linkend="gedit-message-bus-register"><function>gedit_message_bus_register()</function></link> internally creates a new <link linkend="GeditMessageType"><type>GeditMessageType</type></link>. When
84
 
then using <link linkend="gedit-message-bus-send"><function>gedit_message_bus_send()</function></link>, an actual instantiation of the 
85
 
registered type is internally created and send over the bus.
86
 
</para>
87
 
<para>
88
 
<example>
89
 
<programlisting>
90
 
// Defining a new message type
91
 
GeditMessageType *message_type = gedit_message_type_new ("/plugins/example",
92
 
                                                         "method",
93
 
                                                         0,
94
 
                                                         "arg1", G_TYPE_STRING,
95
 
                                                         NULL);
96
 
 
97
 
// Instantiating an actual message from the type
98
 
GeditMessage *message = gedit_message_type_instantiate (message_type,
99
 
                                                        "arg1", "Hello World",
100
 
                                                        NULL);
101
 
</programlisting>
102
 
</example></para>
103
 
<para>
104
 
</para>
105
 
</refsect1>
106
 
 
107
 
<refsect1 id="gedit-GeditMessageType.details" role="details">
108
 
<title role="details.title">Details</title>
109
 
<refsect2 id="GeditMessageType" role="struct">
110
 
<title>GeditMessageType</title>
111
 
<indexterm zone="GeditMessageType"><primary sortas="GeditMessageType">GeditMessageType</primary></indexterm><programlisting>typedef struct _GeditMessageType GeditMessageType;</programlisting>
112
 
<para>
113
 
</para></refsect2>
114
 
<refsect2 id="gedit-message-type-get-type" role="function">
115
 
<title>gedit_message_type_get_type ()</title>
116
 
<indexterm zone="gedit-message-type-get-type"><primary sortas="gedit_message_type_get_type">gedit_message_type_get_type</primary></indexterm><programlisting><link linkend="GType">GType</link>               gedit_message_type_get_type         (void);</programlisting>
117
 
<para>
118
 
Retrieves the GType object which is associated with the
119
 
<link linkend="GeditMessageType"><type>GeditMessageType</type></link> class.</para>
120
 
<para>
121
 
</para><variablelist role="params">
122
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the GType associated with <link linkend="GeditMessageType"><type>GeditMessageType</type></link>.
123
 
</simpara></listitem></varlistentry>
124
 
</variablelist></refsect2>
125
 
<refsect2 id="gedit-message-type-is-supported" role="function">
126
 
<title>gedit_message_type_is_supported ()</title>
127
 
<indexterm zone="gedit-message-type-is-supported"><primary sortas="gedit_message_type_is_supported">gedit_message_type_is_supported</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gedit_message_type_is_supported     (<link linkend="GType">GType</link> type);</programlisting>
128
 
<para>
129
 
Returns if <parameter>type</parameter> is <link linkend="GType"><type>GType</type></link> supported by the message system.</para>
130
 
<para>
131
 
</para><variablelist role="params">
132
 
<varlistentry><term><parameter>type</parameter>&#160;:</term>
133
 
<listitem><simpara> the <link linkend="GType"><type>GType</type></link>
134
 
</simpara></listitem></varlistentry>
135
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if <parameter>type</parameter> is a supported <link linkend="GType"><type>GType</type></link>
136
 
 
137
 
</simpara></listitem></varlistentry>
138
 
</variablelist></refsect2>
139
 
<refsect2 id="gedit-message-type-identifier" role="function">
140
 
<title>gedit_message_type_identifier ()</title>
141
 
<indexterm zone="gedit-message-type-identifier"><primary sortas="gedit_message_type_identifier">gedit_message_type_identifier</primary></indexterm><programlisting><link linkend="gchar">gchar</link> *             gedit_message_type_identifier       (const <link linkend="gchar">gchar</link> *object_path,
142
 
                                                         const <link linkend="gchar">gchar</link> *method);</programlisting>
143
 
<para>
144
 
Get the string identifier for <parameter>method</parameter> at <parameter>object_path</parameter>.</para>
145
 
<para>
146
 
</para><variablelist role="params">
147
 
<varlistentry><term><parameter>object_path</parameter>&#160;:</term>
148
 
<listitem><simpara> the object path
149
 
</simpara></listitem></varlistentry>
150
 
<varlistentry><term><parameter>method</parameter>&#160;:</term>
151
 
<listitem><simpara> the method
152
 
</simpara></listitem></varlistentry>
153
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the identifier for <parameter>method</parameter> at <parameter>object_path</parameter>
154
 
 
155
 
</simpara></listitem></varlistentry>
156
 
</variablelist></refsect2>
157
 
<refsect2 id="gedit-message-type-is-valid-object-path" role="function">
158
 
<title>gedit_message_type_is_valid_object_path ()</title>
159
 
<indexterm zone="gedit-message-type-is-valid-object-path"><primary sortas="gedit_message_type_is_valid_object_path">gedit_message_type_is_valid_object_path</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gedit_message_type_is_valid_object_path
160
 
                                                        (const <link linkend="gchar">gchar</link> *object_path);</programlisting>
161
 
<para>
162
 
Returns whether <parameter>object_path</parameter> is a valid object path</para>
163
 
<para>
164
 
</para><variablelist role="params">
165
 
<varlistentry><term><parameter>object_path</parameter>&#160;:</term>
166
 
<listitem><simpara> the object path
167
 
</simpara></listitem></varlistentry>
168
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if <parameter>object_path</parameter> is a valid object path
169
 
 
170
 
</simpara></listitem></varlistentry>
171
 
</variablelist></refsect2>
172
 
<refsect2 id="gedit-message-type-new" role="function">
173
 
<title>gedit_message_type_new ()</title>
174
 
<indexterm zone="gedit-message-type-new"><primary sortas="gedit_message_type_new">gedit_message_type_new</primary></indexterm><programlisting><link linkend="GeditMessageType">GeditMessageType</link> *  gedit_message_type_new              (const <link linkend="gchar">gchar</link> *object_path,
175
 
                                                         const <link linkend="gchar">gchar</link> *method,
176
 
                                                         <link linkend="guint">guint</link> num_optional,
177
 
                                                         ...);</programlisting>
178
 
<para>
179
 
Create a new <link linkend="GeditMessageType"><type>GeditMessageType</type></link> for <parameter>method</parameter> at <parameter>object_path</parameter>. Argument names
180
 
and values are supplied by the NULL terminated variable argument list.
181
 
The last <parameter>num_optional</parameter> provided arguments are considered optional.</para>
182
 
<para>
183
 
</para><variablelist role="params">
184
 
<varlistentry><term><parameter>object_path</parameter>&#160;:</term>
185
 
<listitem><simpara> the object path
186
 
</simpara></listitem></varlistentry>
187
 
<varlistentry><term><parameter>method</parameter>&#160;:</term>
188
 
<listitem><simpara> the method
189
 
</simpara></listitem></varlistentry>
190
 
<varlistentry><term><parameter>num_optional</parameter>&#160;:</term>
191
 
<listitem><simpara> number of optional arguments
192
 
</simpara></listitem></varlistentry>
193
 
<varlistentry><term><parameter>...</parameter>&#160;:</term>
194
 
<listitem><simpara> key/gtype pair variable argument list
195
 
</simpara></listitem></varlistentry>
196
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the newly constructed <link linkend="GeditMessageType"><type>GeditMessageType</type></link>
197
 
 
198
 
</simpara></listitem></varlistentry>
199
 
</variablelist></refsect2>
200
 
<refsect2 id="gedit-message-type-new-valist" role="function">
201
 
<title>gedit_message_type_new_valist ()</title>
202
 
<indexterm zone="gedit-message-type-new-valist"><primary sortas="gedit_message_type_new_valist">gedit_message_type_new_valist</primary></indexterm><programlisting><link linkend="GeditMessageType">GeditMessageType</link> *  gedit_message_type_new_valist       (const <link linkend="gchar">gchar</link> *object_path,
203
 
                                                         const <link linkend="gchar">gchar</link> *method,
204
 
                                                         <link linkend="guint">guint</link> num_optional,
205
 
                                                         <link linkend="va-list">va_list</link> va_args);</programlisting>
206
 
<para>
207
 
Create a new <link linkend="GeditMessageType"><type>GeditMessageType</type></link> for <parameter>method</parameter> at <parameter>object_path</parameter>. Argument names
208
 
and values are supplied by the NULL terminated variable argument list.
209
 
The last <parameter>num_optional</parameter> provided arguments are considered optional.</para>
210
 
<para>
211
 
</para><variablelist role="params">
212
 
<varlistentry><term><parameter>object_path</parameter>&#160;:</term>
213
 
<listitem><simpara> the object path
214
 
</simpara></listitem></varlistentry>
215
 
<varlistentry><term><parameter>method</parameter>&#160;:</term>
216
 
<listitem><simpara> the method
217
 
</simpara></listitem></varlistentry>
218
 
<varlistentry><term><parameter>num_optional</parameter>&#160;:</term>
219
 
<listitem><simpara> number of optional arguments
220
 
</simpara></listitem></varlistentry>
221
 
<varlistentry><term><parameter>va_args</parameter>&#160;:</term>
222
 
<listitem><simpara>
223
 
</simpara></listitem></varlistentry>
224
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the newly constructed <link linkend="GeditMessageType"><type>GeditMessageType</type></link>
225
 
 
226
 
</simpara></listitem></varlistentry>
227
 
</variablelist></refsect2>
228
 
<refsect2 id="gedit-message-type-ref" role="function">
229
 
<title>gedit_message_type_ref ()</title>
230
 
<indexterm zone="gedit-message-type-ref"><primary sortas="gedit_message_type_ref">gedit_message_type_ref</primary></indexterm><programlisting><link linkend="GeditMessageType">GeditMessageType</link> *  gedit_message_type_ref              (<link linkend="GeditMessageType">GeditMessageType</link> *message_type);</programlisting>
231
 
<para>
232
 
Increases the reference count on <parameter>message_type</parameter>.</para>
233
 
<para>
234
 
</para><variablelist role="params">
235
 
<varlistentry><term><parameter>message_type</parameter>&#160;:</term>
236
 
<listitem><simpara> the <link linkend="GeditMessageType"><type>GeditMessageType</type></link>
237
 
</simpara></listitem></varlistentry>
238
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <parameter>message_type</parameter>
239
 
 
240
 
</simpara></listitem></varlistentry>
241
 
</variablelist></refsect2>
242
 
<refsect2 id="gedit-message-type-unref" role="function">
243
 
<title>gedit_message_type_unref ()</title>
244
 
<indexterm zone="gedit-message-type-unref"><primary sortas="gedit_message_type_unref">gedit_message_type_unref</primary></indexterm><programlisting><link linkend="void">void</link>                gedit_message_type_unref            (<link linkend="GeditMessageType">GeditMessageType</link> *message_type);</programlisting>
245
 
<para>
246
 
Decreases the reference count on <parameter>message_type</parameter>. When the reference count
247
 
drops to 0, <parameter>message_type</parameter> is destroyed.</para>
248
 
<para>
249
 
</para><variablelist role="params">
250
 
<varlistentry><term><parameter>message_type</parameter>&#160;:</term>
251
 
<listitem><simpara> the <link linkend="GeditMessageType"><type>GeditMessageType</type></link>
252
 
</simpara></listitem></varlistentry>
253
 
</variablelist></refsect2>
254
 
<refsect2 id="gedit-message-type-set" role="function">
255
 
<title>gedit_message_type_set ()</title>
256
 
<indexterm zone="gedit-message-type-set"><primary sortas="gedit_message_type_set">gedit_message_type_set</primary></indexterm><programlisting><link linkend="void">void</link>                gedit_message_type_set              (<link linkend="GeditMessageType">GeditMessageType</link> *message_type,
257
 
                                                         <link linkend="guint">guint</link> num_optional,
258
 
                                                         ...);</programlisting>
259
 
<para>
260
 
Sets argument names/types supplied by the NULL terminated variable
261
 
argument list. The last <parameter>num_optional</parameter> provided arguments are considered
262
 
optional.</para>
263
 
<para>
264
 
</para><variablelist role="params">
265
 
<varlistentry><term><parameter>message_type</parameter>&#160;:</term>
266
 
<listitem><simpara> the <link linkend="GeditMessageType"><type>GeditMessageType</type></link>
267
 
</simpara></listitem></varlistentry>
268
 
<varlistentry><term><parameter>num_optional</parameter>&#160;:</term>
269
 
<listitem><simpara> number of optional arguments
270
 
</simpara></listitem></varlistentry>
271
 
<varlistentry><term><parameter>...</parameter>&#160;:</term>
272
 
<listitem><simpara> key/gtype pair variable argument list
273
 
</simpara></listitem></varlistentry>
274
 
</variablelist></refsect2>
275
 
<refsect2 id="gedit-message-type-set-valist" role="function">
276
 
<title>gedit_message_type_set_valist ()</title>
277
 
<indexterm zone="gedit-message-type-set-valist"><primary sortas="gedit_message_type_set_valist">gedit_message_type_set_valist</primary></indexterm><programlisting><link linkend="void">void</link>                gedit_message_type_set_valist       (<link linkend="GeditMessageType">GeditMessageType</link> *message_type,
278
 
                                                         <link linkend="guint">guint</link> num_optional,
279
 
                                                         <link linkend="va-list">va_list</link> va_args);</programlisting>
280
 
<para>
281
 
Sets argument names/types supplied by the NULL terminated variable
282
 
argument list <parameter>var_args</parameter>. The last <parameter>num_optional</parameter> provided arguments are 
283
 
considered optional.</para>
284
 
<para>
285
 
</para><variablelist role="params">
286
 
<varlistentry><term><parameter>message_type</parameter>&#160;:</term>
287
 
<listitem><simpara> the <link linkend="GeditMessageType"><type>GeditMessageType</type></link>
288
 
</simpara></listitem></varlistentry>
289
 
<varlistentry><term><parameter>num_optional</parameter>&#160;:</term>
290
 
<listitem><simpara> number of optional arguments
291
 
</simpara></listitem></varlistentry>
292
 
<varlistentry><term><parameter>va_args</parameter>&#160;:</term>
293
 
<listitem><simpara>
294
 
</simpara></listitem></varlistentry>
295
 
</variablelist></refsect2>
296
 
<refsect2 id="gedit-message-type-instantiate" role="function">
297
 
<title>gedit_message_type_instantiate ()</title>
298
 
<indexterm zone="gedit-message-type-instantiate"><primary sortas="gedit_message_type_instantiate">gedit_message_type_instantiate</primary></indexterm><programlisting><link linkend="GeditMessage">GeditMessage</link> *      gedit_message_type_instantiate      (<link linkend="GeditMessageType">GeditMessageType</link> *message_type,
299
 
                                                         ...);</programlisting>
300
 
<para>
301
 
Instantiate a new message from the message type with specific values
302
 
for the message arguments.</para>
303
 
<para>
304
 
</para><variablelist role="params">
305
 
<varlistentry><term><parameter>message_type</parameter>&#160;:</term>
306
 
<listitem><simpara> the <link linkend="GeditMessageType"><type>GeditMessageType</type></link>
307
 
</simpara></listitem></varlistentry>
308
 
<varlistentry><term><parameter>...</parameter>&#160;:</term>
309
 
<listitem><simpara> NULL terminated variable list of key/value pairs
310
 
</simpara></listitem></varlistentry>
311
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the newly created message
312
 
 
313
 
</simpara></listitem></varlistentry>
314
 
</variablelist></refsect2>
315
 
<refsect2 id="gedit-message-type-instantiate-valist" role="function">
316
 
<title>gedit_message_type_instantiate_valist ()</title>
317
 
<indexterm zone="gedit-message-type-instantiate-valist"><primary sortas="gedit_message_type_instantiate_valist">gedit_message_type_instantiate_valist</primary></indexterm><programlisting><link linkend="GeditMessage">GeditMessage</link> *      gedit_message_type_instantiate_valist
318
 
                                                        (<link linkend="GeditMessageType">GeditMessageType</link> *message_type,
319
 
                                                         <link linkend="va-list">va_list</link> va_args);</programlisting>
320
 
<para>
321
 
Instantiate a new message from the message type with specific values
322
 
for the message arguments.</para>
323
 
<para>
324
 
</para><variablelist role="params">
325
 
<varlistentry><term><parameter>message_type</parameter>&#160;:</term>
326
 
<listitem><simpara> the <link linkend="GeditMessageType"><type>GeditMessageType</type></link>
327
 
</simpara></listitem></varlistentry>
328
 
<varlistentry><term><parameter>va_args</parameter>&#160;:</term>
329
 
<listitem><simpara> NULL terminated variable list of key/value pairs
330
 
</simpara></listitem></varlistentry>
331
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the newly created message
332
 
 
333
 
</simpara></listitem></varlistentry>
334
 
</variablelist></refsect2>
335
 
<refsect2 id="gedit-message-type-get-object-path" role="function">
336
 
<title>gedit_message_type_get_object_path ()</title>
337
 
<indexterm zone="gedit-message-type-get-object-path"><primary sortas="gedit_message_type_get_object_path">gedit_message_type_get_object_path</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link> *       gedit_message_type_get_object_path  (<link linkend="GeditMessageType">GeditMessageType</link> *message_type);</programlisting>
338
 
<para>
339
 
Get the message type object path.</para>
340
 
<para>
341
 
</para><variablelist role="params">
342
 
<varlistentry><term><parameter>message_type</parameter>&#160;:</term>
343
 
<listitem><simpara> the <link linkend="GeditMessageType"><type>GeditMessageType</type></link>
344
 
</simpara></listitem></varlistentry>
345
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the message type object path
346
 
 
347
 
</simpara></listitem></varlistentry>
348
 
</variablelist></refsect2>
349
 
<refsect2 id="gedit-message-type-get-method" role="function">
350
 
<title>gedit_message_type_get_method ()</title>
351
 
<indexterm zone="gedit-message-type-get-method"><primary sortas="gedit_message_type_get_method">gedit_message_type_get_method</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link> *       gedit_message_type_get_method       (<link linkend="GeditMessageType">GeditMessageType</link> *message_type);</programlisting>
352
 
<para>
353
 
Get the message type method.</para>
354
 
<para>
355
 
</para><variablelist role="params">
356
 
<varlistentry><term><parameter>message_type</parameter>&#160;:</term>
357
 
<listitem><simpara> the <link linkend="GeditMessageType"><type>GeditMessageType</type></link>
358
 
</simpara></listitem></varlistentry>
359
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the message type method
360
 
 
361
 
</simpara></listitem></varlistentry>
362
 
</variablelist></refsect2>
363
 
<refsect2 id="gedit-message-type-lookup" role="function">
364
 
<title>gedit_message_type_lookup ()</title>
365
 
<indexterm zone="gedit-message-type-lookup"><primary sortas="gedit_message_type_lookup">gedit_message_type_lookup</primary></indexterm><programlisting><link linkend="GType">GType</link>               gedit_message_type_lookup           (<link linkend="GeditMessageType">GeditMessageType</link> *message_type,
366
 
                                                         const <link linkend="gchar">gchar</link> *key);</programlisting>
367
 
<para>
368
 
Get the argument key <link linkend="GType"><type>GType</type></link>.</para>
369
 
<para>
370
 
</para><variablelist role="params">
371
 
<varlistentry><term><parameter>message_type</parameter>&#160;:</term>
372
 
<listitem><simpara> the <link linkend="GeditMessageType"><type>GeditMessageType</type></link>
373
 
</simpara></listitem></varlistentry>
374
 
<varlistentry><term><parameter>key</parameter>&#160;:</term>
375
 
<listitem><simpara> the argument key
376
 
</simpara></listitem></varlistentry>
377
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the <link linkend="GType"><type>GType</type></link> of <parameter>key</parameter>
378
 
 
379
 
</simpara></listitem></varlistentry>
380
 
</variablelist></refsect2>
381
 
<refsect2 id="gedit-message-type-foreach" role="function">
382
 
<title>gedit_message_type_foreach ()</title>
383
 
<indexterm zone="gedit-message-type-foreach"><primary sortas="gedit_message_type_foreach">gedit_message_type_foreach</primary></indexterm><programlisting><link linkend="void">void</link>                gedit_message_type_foreach          (<link linkend="GeditMessageType">GeditMessageType</link> *message_type,
384
 
                                                         <link linkend="GeditMessageTypeForeach">GeditMessageTypeForeach</link> func,
385
 
                                                         <link linkend="gpointer">gpointer</link> user_data);</programlisting>
386
 
<para>
387
 
Calls <parameter>func</parameter> for each argument in the message type.</para>
388
 
<para>
389
 
</para><variablelist role="params">
390
 
<varlistentry><term><parameter>message_type</parameter>&#160;:</term>
391
 
<listitem><simpara> the <link linkend="GeditMessageType"><type>GeditMessageType</type></link>
392
 
</simpara></listitem></varlistentry>
393
 
<varlistentry><term><parameter>func</parameter>&#160;:</term>
394
 
<listitem><simpara> the callback function
395
 
</simpara></listitem></varlistentry>
396
 
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
397
 
<listitem><simpara> user data supplied to the callback function
398
 
</simpara></listitem></varlistentry>
399
 
</variablelist></refsect2>
400
 
 
401
 
</refsect1>
402
 
 
403
 
 
404
 
 
405
 
 
406
 
</refentry>