← Back to branch summary

~ubuntu-branches/ubuntu/karmic/gedit/karmic

« back to all changes in this revision

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

  • Committer: Bazaar Package Importer
  • Author(s): Andreas Moog
  • Date: 2009-05-27 14:00:44 UTC
  • mfrom: (1.1.62 upstream)
  • Revision ID: james.westby@ubuntu.com-20090527140044-4h5ypu02i3s4zi0q
Tags: 2.27.1-0ubuntu1
https://launchpad.net/bugs/380924
https://launchpad.net/bugs/348536
https://launchpad.net/bugs/368262
https://launchpad.net/bugs/368495
https://launchpad.net/bugs/367160
* New upstream release: (LP: #380924)
  - Remove the mmap document loader (Paolo Borelli)
  - Remove open location dialog and sample plugin (Paolo Borelli)
  - Added public API for document saving (Jesse van den Kieboom)
  - Put external tools in a submenu (Jesse van den Kieboom)
  - Added language support for external tools (Jesse van den Kieboom)
  - Implemented asynchronous reading and writing on external tools (Jesse van den Kieboom)
  - Add Quick Open plugin (Jesse van den Kieboom)
  - Misc bugfixes
  - New and updated translations
* debian/patches/90_autoconf.patch
  - updated for new version
* Launchpad bugs fixed:
  - various crasher bugs (LP: #348536, LP: #368262, LP: #368495)
  - fix modeline scanning (LP: #367160)

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/xml/gedit-message.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="GeditMessage">
5
 
<refmeta>
6
 
<refentrytitle role="top_of_page" id="GeditMessage.top_of_page">GeditMessage</refentrytitle>
7
 
<manvolnum>3</manvolnum>
8
 
<refmiscinfo>GEDIT Library</refmiscinfo>
9
 
</refmeta>
10
 
 
11
 
<refnamediv>
12
 
<refname>GeditMessage</refname>
13
 
<refpurpose>message bus message object</refpurpose>
14
 
</refnamediv>
15
 
 
16
 
<refsynopsisdiv id="GeditMessage.synopsis" role="synopsis">
17
 
<title role="synopsis.title">Synopsis</title>
18
 
 
19
 
<synopsis>
20
 
 
21
 
#include &lt;gedit/gedit-message.h&gt;
22
 
 
23
 
                    <link linkend="GeditMessage-struct">GeditMessage</link>;
24
 
<link linkend="void">void</link>                <link linkend="gedit-message-get">gedit_message_get</link>                   (<link linkend="GeditMessage">GeditMessage</link> *message,
25
 
                                                         ...);
26
 
<link linkend="void">void</link>                <link linkend="gedit-message-get-valist">gedit_message_get_valist</link>            (<link linkend="GeditMessage">GeditMessage</link> *message,
27
 
                                                         <link linkend="va-list">va_list</link> var_args);
28
 
<link linkend="void">void</link>                <link linkend="gedit-message-get-value">gedit_message_get_value</link>             (<link linkend="GeditMessage">GeditMessage</link> *message,
29
 
                                                         const <link linkend="gchar">gchar</link> *key,
30
 
                                                         <link linkend="GValue">GValue</link> *value);
31
 
<link linkend="void">void</link>                <link linkend="gedit-message-set">gedit_message_set</link>                   (<link linkend="GeditMessage">GeditMessage</link> *message,
32
 
                                                         ...);
33
 
<link linkend="void">void</link>                <link linkend="gedit-message-set-valist">gedit_message_set_valist</link>            (<link linkend="GeditMessage">GeditMessage</link> *message,
34
 
                                                         <link linkend="va-list">va_list</link> var_args);
35
 
<link linkend="void">void</link>                <link linkend="gedit-message-set-value">gedit_message_set_value</link>             (<link linkend="GeditMessage">GeditMessage</link> *message,
36
 
                                                         const <link linkend="gchar">gchar</link> *key,
37
 
                                                         <link linkend="GValue">GValue</link> *value);
38
 
<link linkend="void">void</link>                <link linkend="gedit-message-set-valuesv">gedit_message_set_valuesv</link>           (<link linkend="GeditMessage">GeditMessage</link> *message,
39
 
                                                         const <link linkend="gchar">gchar</link> **keys,
40
 
                                                         <link linkend="GValue">GValue</link> *values,
41
 
                                                         <link linkend="gint">gint</link> n_values);
42
 
const <link linkend="gchar">gchar</link> *       <link linkend="gedit-message-get-object-path">gedit_message_get_object_path</link>       (<link linkend="GeditMessage">GeditMessage</link> *message);
43
 
const <link linkend="gchar">gchar</link> *       <link linkend="gedit-message-get-method">gedit_message_get_method</link>            (<link linkend="GeditMessage">GeditMessage</link> *message);
44
 
<link linkend="gboolean">gboolean</link>            <link linkend="gedit-message-has-key">gedit_message_has_key</link>               (<link linkend="GeditMessage">GeditMessage</link> *message,
45
 
                                                         const <link linkend="gchar">gchar</link> *key);
46
 
<link linkend="GType">GType</link>               <link linkend="gedit-message-get-key-type">gedit_message_get_key_type</link>          (<link linkend="GeditMessage">GeditMessage</link> *message,
47
 
                                                         const <link linkend="gchar">gchar</link> *key);
48
 
<link linkend="gboolean">gboolean</link>            <link linkend="gedit-message-validate">gedit_message_validate</link>              (<link linkend="GeditMessage">GeditMessage</link> *message);
49
 
</synopsis>
50
 
</refsynopsisdiv>
51
 
 
52
 
<refsect1 id="GeditMessage.object-hierarchy" role="object_hierarchy">
53
 
<title role="object_hierarchy.title">Object Hierarchy</title>
54
 
<synopsis>
55
 
  <link linkend="GObject">GObject</link>
56
 
   +----GeditMessage
57
 
</synopsis>
58
 
</refsect1>
59
 
 
60
 
 
61
 
 
62
 
 
63
 
 
64
 
<refsect1 id="GeditMessage.properties" role="properties">
65
 
<title role="properties.title">Properties</title>
66
 
<synopsis>
67
 
  &quot;<link linkend="GeditMessage--method">method</link>&quot;                   <link linkend="gchar">gchar</link>*                : Read
68
 
  &quot;<link linkend="GeditMessage--object-path">object-path</link>&quot;              <link linkend="gchar">gchar</link>*                : Read
69
 
  &quot;<link linkend="GeditMessage--type">type</link>&quot;                     <link linkend="GeditMessageType">GeditMessageType</link>*     : Read / Write / Construct Only
70
 
</synopsis>
71
 
</refsect1>
72
 
 
73
 
 
74
 
 
75
 
<refsect1 id="GeditMessage.description" role="desc">
76
 
<title role="desc.title">Description</title>
77
 
 
78
 
<para>
79
 
Communication on a <link linkend="GeditMessageBus"><type>GeditMessageBus</type></link> is done through messages. Messages are
80
 
sent over the bus and received by connecting callbacks on the message bus.
81
 
A <link linkend="GeditMessage"><type>GeditMessage</type></link> is an instantiation of a <link linkend="GeditMessageType"><type>GeditMessageType</type></link>, containing
82
 
values for the arguments as specified in the message type.
83
 
</para>
84
 
<para>
85
 
A message can be seen as a method call, or signal emission depending on
86
 
who is the sender and who is the receiver. There is no explicit distinction
87
 
between methods and signals.</para>
88
 
<para>
89
 
</para>
90
 
</refsect1>
91
 
 
92
 
<refsect1 id="GeditMessage.details" role="details">
93
 
<title role="details.title">Details</title>
94
 
<refsect2 id="GeditMessage-struct" role="struct">
95
 
<title>GeditMessage</title>
96
 
<indexterm zone="GeditMessage-struct"><primary>GeditMessage</primary></indexterm>
97
 
<programlisting>typedef struct _GeditMessage GeditMessage;</programlisting>
98
 
<para>
99
 
</para></refsect2>
100
 
<refsect2 id="gedit-message-get" role="function">
101
 
<title>gedit_message_get ()</title>
102
 
<indexterm zone="gedit-message-get"><primary>gedit_message_get</primary></indexterm>
103
 
<programlisting><link linkend="void">void</link>                gedit_message_get                   (<link linkend="GeditMessage">GeditMessage</link> *message,
104
 
                                                         ...);</programlisting>
105
 
<para>
106
 
Get values of message arguments. The supplied <parameter>var_args</parameter> should contain
107
 
pairs of keys and pointers to variables which are set to the argument
108
 
value for the specified key.</para>
109
 
<para>
110
 
</para><variablelist role="params">
111
 
<varlistentry><term><parameter>message</parameter>&#160;:</term>
112
 
<listitem><simpara> the <link linkend="GeditMessage"><type>GeditMessage</type></link>
113
 
</simpara></listitem></varlistentry>
114
 
<varlistentry><term><parameter>...</parameter>&#160;:</term>
115
 
<listitem><simpara> a NULL variable argument list of key/value container pairs
116
 
</simpara></listitem></varlistentry>
117
 
</variablelist></refsect2>
118
 
<refsect2 id="gedit-message-get-valist" role="function">
119
 
<title>gedit_message_get_valist ()</title>
120
 
<indexterm zone="gedit-message-get-valist"><primary>gedit_message_get_valist</primary></indexterm>
121
 
<programlisting><link linkend="void">void</link>                gedit_message_get_valist            (<link linkend="GeditMessage">GeditMessage</link> *message,
122
 
                                                         <link linkend="va-list">va_list</link> var_args);</programlisting>
123
 
<para>
124
 
Get values of message arguments. The supplied <parameter>var_args</parameter> should contain
125
 
pairs of keys and pointers to variables which are set to the argument
126
 
value for the specified key.</para>
127
 
<para>
128
 
</para><variablelist role="params">
129
 
<varlistentry><term><parameter>message</parameter>&#160;:</term>
130
 
<listitem><simpara> the <link linkend="GeditMessage"><type>GeditMessage</type></link>
131
 
</simpara></listitem></varlistentry>
132
 
<varlistentry><term><parameter>var_args</parameter>&#160;:</term>
133
 
<listitem><simpara> a NULL variable argument list of key/value container pairs
134
 
</simpara></listitem></varlistentry>
135
 
</variablelist></refsect2>
136
 
<refsect2 id="gedit-message-get-value" role="function">
137
 
<title>gedit_message_get_value ()</title>
138
 
<indexterm zone="gedit-message-get-value"><primary>gedit_message_get_value</primary></indexterm>
139
 
<programlisting><link linkend="void">void</link>                gedit_message_get_value             (<link linkend="GeditMessage">GeditMessage</link> *message,
140
 
                                                         const <link linkend="gchar">gchar</link> *key,
141
 
                                                         <link linkend="GValue">GValue</link> *value);</programlisting>
142
 
<para>
143
 
Get the value of a specific message argument. <parameter>value</parameter> will be initialized
144
 
with the correct type.</para>
145
 
<para>
146
 
</para><variablelist role="params">
147
 
<varlistentry><term><parameter>message</parameter>&#160;:</term>
148
 
<listitem><simpara> the <link linkend="GeditMessage"><type>GeditMessage</type></link>
149
 
</simpara></listitem></varlistentry>
150
 
<varlistentry><term><parameter>key</parameter>&#160;:</term>
151
 
<listitem><simpara> the argument key
152
 
</simpara></listitem></varlistentry>
153
 
<varlistentry><term><parameter>value</parameter>&#160;:</term>
154
 
<listitem><simpara> value return container
155
 
</simpara></listitem></varlistentry>
156
 
</variablelist></refsect2>
157
 
<refsect2 id="gedit-message-set" role="function">
158
 
<title>gedit_message_set ()</title>
159
 
<indexterm zone="gedit-message-set"><primary>gedit_message_set</primary></indexterm>
160
 
<programlisting><link linkend="void">void</link>                gedit_message_set                   (<link linkend="GeditMessage">GeditMessage</link> *message,
161
 
                                                         ...);</programlisting>
162
 
<para>
163
 
Set values of message arguments. The supplied <parameter>var_args</parameter> should contain
164
 
pairs of keys and argument values.</para>
165
 
<para>
166
 
</para><variablelist role="params">
167
 
<varlistentry><term><parameter>message</parameter>&#160;:</term>
168
 
<listitem><simpara> the <link linkend="GeditMessage"><type>GeditMessage</type></link>
169
 
</simpara></listitem></varlistentry>
170
 
<varlistentry><term><parameter>...</parameter>&#160;:</term>
171
 
<listitem><simpara> a NULL terminated variable list of key/value pairs
172
 
</simpara></listitem></varlistentry>
173
 
</variablelist></refsect2>
174
 
<refsect2 id="gedit-message-set-valist" role="function">
175
 
<title>gedit_message_set_valist ()</title>
176
 
<indexterm zone="gedit-message-set-valist"><primary>gedit_message_set_valist</primary></indexterm>
177
 
<programlisting><link linkend="void">void</link>                gedit_message_set_valist            (<link linkend="GeditMessage">GeditMessage</link> *message,
178
 
                                                         <link linkend="va-list">va_list</link> var_args);</programlisting>
179
 
<para>
180
 
Set values of message arguments. The supplied <parameter>var_args</parameter> should contain
181
 
pairs of keys and argument values.</para>
182
 
<para>
183
 
</para><variablelist role="params">
184
 
<varlistentry><term><parameter>message</parameter>&#160;:</term>
185
 
<listitem><simpara> the <link linkend="GeditMessage"><type>GeditMessage</type></link>
186
 
</simpara></listitem></varlistentry>
187
 
<varlistentry><term><parameter>var_args</parameter>&#160;:</term>
188
 
<listitem><simpara> a NULL terminated variable list of key/value pairs
189
 
</simpara></listitem></varlistentry>
190
 
</variablelist></refsect2>
191
 
<refsect2 id="gedit-message-set-value" role="function">
192
 
<title>gedit_message_set_value ()</title>
193
 
<indexterm zone="gedit-message-set-value"><primary>gedit_message_set_value</primary></indexterm>
194
 
<programlisting><link linkend="void">void</link>                gedit_message_set_value             (<link linkend="GeditMessage">GeditMessage</link> *message,
195
 
                                                         const <link linkend="gchar">gchar</link> *key,
196
 
                                                         <link linkend="GValue">GValue</link> *value);</programlisting>
197
 
<para>
198
 
Set value of message argument <parameter>key</parameter> to <parameter>value</parameter>.</para>
199
 
<para>
200
 
</para><variablelist role="params">
201
 
<varlistentry><term><parameter>message</parameter>&#160;:</term>
202
 
<listitem><simpara> the <link linkend="GeditMessage"><type>GeditMessage</type></link>
203
 
</simpara></listitem></varlistentry>
204
 
<varlistentry><term><parameter>key</parameter>&#160;:</term>
205
 
<listitem><simpara> the argument key
206
 
</simpara></listitem></varlistentry>
207
 
<varlistentry><term><parameter>value</parameter>&#160;:</term>
208
 
<listitem><simpara> the argument value
209
 
</simpara></listitem></varlistentry>
210
 
</variablelist></refsect2>
211
 
<refsect2 id="gedit-message-set-valuesv" role="function">
212
 
<title>gedit_message_set_valuesv ()</title>
213
 
<indexterm zone="gedit-message-set-valuesv"><primary>gedit_message_set_valuesv</primary></indexterm>
214
 
<programlisting><link linkend="void">void</link>                gedit_message_set_valuesv           (<link linkend="GeditMessage">GeditMessage</link> *message,
215
 
                                                         const <link linkend="gchar">gchar</link> **keys,
216
 
                                                         <link linkend="GValue">GValue</link> *values,
217
 
                                                         <link linkend="gint">gint</link> n_values);</programlisting>
218
 
<para>
219
 
Set message argument values.</para>
220
 
<para>
221
 
</para><variablelist role="params">
222
 
<varlistentry><term><parameter>message</parameter>&#160;:</term>
223
 
<listitem><simpara> the <link linkend="GeditMessage"><type>GeditMessage</type></link>
224
 
</simpara></listitem></varlistentry>
225
 
<varlistentry><term><parameter>keys</parameter>&#160;:</term>
226
 
<listitem><simpara> keys to set values for
227
 
</simpara></listitem></varlistentry>
228
 
<varlistentry><term><parameter>values</parameter>&#160;:</term>
229
 
<listitem><simpara> values to set
230
 
</simpara></listitem></varlistentry>
231
 
<varlistentry><term><parameter>n_values</parameter>&#160;:</term>
232
 
<listitem><simpara> number of arguments to set values for
233
 
</simpara></listitem></varlistentry>
234
 
</variablelist></refsect2>
235
 
<refsect2 id="gedit-message-get-object-path" role="function">
236
 
<title>gedit_message_get_object_path ()</title>
237
 
<indexterm zone="gedit-message-get-object-path"><primary>gedit_message_get_object_path</primary></indexterm>
238
 
<programlisting>const <link linkend="gchar">gchar</link> *       gedit_message_get_object_path       (<link linkend="GeditMessage">GeditMessage</link> *message);</programlisting>
239
 
<para>
240
 
Get the message object path.</para>
241
 
<para>
242
 
</para><variablelist role="params">
243
 
<varlistentry><term><parameter>message</parameter>&#160;:</term>
244
 
<listitem><simpara> the <link linkend="GeditMessage"><type>GeditMessage</type></link>
245
 
</simpara></listitem></varlistentry>
246
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the message object path
247
 
 
248
 
</simpara></listitem></varlistentry>
249
 
</variablelist></refsect2>
250
 
<refsect2 id="gedit-message-get-method" role="function">
251
 
<title>gedit_message_get_method ()</title>
252
 
<indexterm zone="gedit-message-get-method"><primary>gedit_message_get_method</primary></indexterm>
253
 
<programlisting>const <link linkend="gchar">gchar</link> *       gedit_message_get_method            (<link linkend="GeditMessage">GeditMessage</link> *message);</programlisting>
254
 
<para>
255
 
Get the message method.</para>
256
 
<para>
257
 
</para><variablelist role="params">
258
 
<varlistentry><term><parameter>message</parameter>&#160;:</term>
259
 
<listitem><simpara> the <link linkend="GeditMessage"><type>GeditMessage</type></link>
260
 
</simpara></listitem></varlistentry>
261
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the message method
262
 
 
263
 
</simpara></listitem></varlistentry>
264
 
</variablelist></refsect2>
265
 
<refsect2 id="gedit-message-has-key" role="function">
266
 
<title>gedit_message_has_key ()</title>
267
 
<indexterm zone="gedit-message-has-key"><primary>gedit_message_has_key</primary></indexterm>
268
 
<programlisting><link linkend="gboolean">gboolean</link>            gedit_message_has_key               (<link linkend="GeditMessage">GeditMessage</link> *message,
269
 
                                                         const <link linkend="gchar">gchar</link> *key);</programlisting>
270
 
<para>
271
 
Check whether the message has a specific key.</para>
272
 
<para>
273
 
</para><variablelist role="params">
274
 
<varlistentry><term><parameter>message</parameter>&#160;:</term>
275
 
<listitem><simpara> the <link linkend="GeditMessage"><type>GeditMessage</type></link>
276
 
</simpara></listitem></varlistentry>
277
 
<varlistentry><term><parameter>key</parameter>&#160;:</term>
278
 
<listitem><simpara> the argument key
279
 
</simpara></listitem></varlistentry>
280
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if <parameter>message</parameter> has argument <parameter>key</parameter>
281
 
 
282
 
</simpara></listitem></varlistentry>
283
 
</variablelist></refsect2>
284
 
<refsect2 id="gedit-message-get-key-type" role="function">
285
 
<title>gedit_message_get_key_type ()</title>
286
 
<indexterm zone="gedit-message-get-key-type"><primary>gedit_message_get_key_type</primary></indexterm>
287
 
<programlisting><link linkend="GType">GType</link>               gedit_message_get_key_type          (<link linkend="GeditMessage">GeditMessage</link> *message,
288
 
                                                         const <link linkend="gchar">gchar</link> *key);</programlisting>
289
 
<para>
290
 
Get the type of a message argument.</para>
291
 
<para>
292
 
</para><variablelist role="params">
293
 
<varlistentry><term><parameter>message</parameter>&#160;:</term>
294
 
<listitem><simpara> the <link linkend="GeditMessage"><type>GeditMessage</type></link>
295
 
</simpara></listitem></varlistentry>
296
 
<varlistentry><term><parameter>key</parameter>&#160;:</term>
297
 
<listitem><simpara> the argument key
298
 
</simpara></listitem></varlistentry>
299
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the type of <parameter>key</parameter>
300
 
 
301
 
</simpara></listitem></varlistentry>
302
 
</variablelist></refsect2>
303
 
<refsect2 id="gedit-message-validate" role="function">
304
 
<title>gedit_message_validate ()</title>
305
 
<indexterm zone="gedit-message-validate"><primary>gedit_message_validate</primary></indexterm>
306
 
<programlisting><link linkend="gboolean">gboolean</link>            gedit_message_validate              (<link linkend="GeditMessage">GeditMessage</link> *message);</programlisting>
307
 
<para>
308
 
Validates the message arguments according to the message type.</para>
309
 
<para>
310
 
</para><variablelist role="params">
311
 
<varlistentry><term><parameter>message</parameter>&#160;:</term>
312
 
<listitem><simpara> the <link linkend="GeditMessage"><type>GeditMessage</type></link>
313
 
</simpara></listitem></varlistentry>
314
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if the message is valid
315
 
 
316
 
</simpara></listitem></varlistentry>
317
 
</variablelist></refsect2>
318
 
 
319
 
</refsect1>
320
 
<refsect1 id="GeditMessage.property-details" role="property_details">
321
 
<title role="property_details.title">Property Details</title>
322
 
<refsect2 id="GeditMessage--method" role="property"><title>The <literal>&quot;method&quot;</literal> property</title>
323
 
<indexterm zone="GeditMessage--method"><primary>GeditMessage:method</primary></indexterm>
324
 
<programlisting>  &quot;method&quot;                   <link linkend="gchar">gchar</link>*                : Read</programlisting>
325
 
<para>
326
 
The messages method.</para>
327
 
<para>
328
 
</para><para>Default value: NULL</para>
329
 
</refsect2>
330
 
<refsect2 id="GeditMessage--object-path" role="property"><title>The <literal>&quot;object-path&quot;</literal> property</title>
331
 
<indexterm zone="GeditMessage--object-path"><primary>GeditMessage:object-path</primary></indexterm>
332
 
<programlisting>  &quot;object-path&quot;              <link linkend="gchar">gchar</link>*                : Read</programlisting>
333
 
<para>The message object path.</para><para>Default value: NULL</para>
334
 
</refsect2>
335
 
<refsect2 id="GeditMessage--type" role="property"><title>The <literal>&quot;type&quot;</literal> property</title>
336
 
<indexterm zone="GeditMessage--type"><primary>GeditMessage:type</primary></indexterm>
337
 
<programlisting>  &quot;type&quot;                     <link linkend="GeditMessageType">GeditMessageType</link>*     : Read / Write / Construct Only</programlisting>
338
 
<para>The message type.</para></refsect2>
339
 
</refsect1>
340
 
 
341
 
 
342
 
 
343
 
 
344
 
</refentry>