← 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): Sebastien Bacher
  • Date: 2009-09-21 17:46:38 UTC
  • mfrom: (1.1.68 upstream)
  • Revision ID: james.westby@ubuntu.com-20090921174638-umsgmvz3cd1bwhtr
Tags: 2.28.0-0ubuntu1
https://launchpad.net/bugs/421221
* New upstream version:
  - Misc bugfixes (lp: #421221)

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
<para>
 
78
Communication on a <link linkend="GeditMessageBus"><type>GeditMessageBus</type></link> is done through messages. Messages are
 
79
sent over the bus and received by connecting callbacks on the message bus.
 
80
A <link linkend="GeditMessage"><type>GeditMessage</type></link> is an instantiation of a <link linkend="GeditMessageType"><type>GeditMessageType</type></link>, containing
 
81
values for the arguments as specified in the message type.
 
82
</para>
 
83
<para>
 
84
A message can be seen as a method call, or signal emission depending on
 
85
who is the sender and who is the receiver. There is no explicit distinction
 
86
between methods and signals.</para>
 
87
<para>
 
88
</para>
 
89
</refsect1>
 
90
 
 
91
<refsect1 id="GeditMessage.details" role="details">
 
92
<title role="details.title">Details</title>
 
93
<refsect2 id="GeditMessage-struct" role="struct">
 
94
<title>GeditMessage</title>
 
95
<indexterm zone="GeditMessage-struct"><primary sortas="GeditMessage">GeditMessage</primary></indexterm><programlisting>typedef struct _GeditMessage GeditMessage;</programlisting>
 
96
<para>
 
97
</para></refsect2>
 
98
<refsect2 id="gedit-message-get" role="function">
 
99
<title>gedit_message_get ()</title>
 
100
<indexterm zone="gedit-message-get"><primary sortas="gedit_message_get">gedit_message_get</primary></indexterm><programlisting><link linkend="void">void</link>                gedit_message_get                   (<link linkend="GeditMessage">GeditMessage</link> *message,
 
101
                                                         ...);</programlisting>
 
102
<para>
 
103
Get values of message arguments. The supplied <parameter>var_args</parameter> should contain
 
104
pairs of keys and pointers to variables which are set to the argument
 
105
value for the specified key.</para>
 
106
<para>
 
107
</para><variablelist role="params">
 
108
<varlistentry><term><parameter>message</parameter>&#160;:</term>
 
109
<listitem><simpara> the <link linkend="GeditMessage"><type>GeditMessage</type></link>
 
110
</simpara></listitem></varlistentry>
 
111
<varlistentry><term><parameter>...</parameter>&#160;:</term>
 
112
<listitem><simpara> a NULL variable argument list of key/value container pairs
 
113
</simpara></listitem></varlistentry>
 
114
</variablelist></refsect2>
 
115
<refsect2 id="gedit-message-get-valist" role="function">
 
116
<title>gedit_message_get_valist ()</title>
 
117
<indexterm zone="gedit-message-get-valist"><primary sortas="gedit_message_get_valist">gedit_message_get_valist</primary></indexterm><programlisting><link linkend="void">void</link>                gedit_message_get_valist            (<link linkend="GeditMessage">GeditMessage</link> *message,
 
118
                                                         <link linkend="va-list">va_list</link> var_args);</programlisting>
 
119
<para>
 
120
Get values of message arguments. The supplied <parameter>var_args</parameter> should contain
 
121
pairs of keys and pointers to variables which are set to the argument
 
122
value for the specified key.</para>
 
123
<para>
 
124
</para><variablelist role="params">
 
125
<varlistentry><term><parameter>message</parameter>&#160;:</term>
 
126
<listitem><simpara> the <link linkend="GeditMessage"><type>GeditMessage</type></link>
 
127
</simpara></listitem></varlistentry>
 
128
<varlistentry><term><parameter>var_args</parameter>&#160;:</term>
 
129
<listitem><simpara> a NULL variable argument list of key/value container pairs
 
130
</simpara></listitem></varlistentry>
 
131
</variablelist></refsect2>
 
132
<refsect2 id="gedit-message-get-value" role="function">
 
133
<title>gedit_message_get_value ()</title>
 
134
<indexterm zone="gedit-message-get-value"><primary sortas="gedit_message_get_value">gedit_message_get_value</primary></indexterm><programlisting><link linkend="void">void</link>                gedit_message_get_value             (<link linkend="GeditMessage">GeditMessage</link> *message,
 
135
                                                         const <link linkend="gchar">gchar</link> *key,
 
136
                                                         <link linkend="GValue">GValue</link> *value);</programlisting>
 
137
<para>
 
138
Get the value of a specific message argument. <parameter>value</parameter> will be initialized
 
139
with the correct type.</para>
 
140
<para>
 
141
</para><variablelist role="params">
 
142
<varlistentry><term><parameter>message</parameter>&#160;:</term>
 
143
<listitem><simpara> the <link linkend="GeditMessage"><type>GeditMessage</type></link>
 
144
</simpara></listitem></varlistentry>
 
145
<varlistentry><term><parameter>key</parameter>&#160;:</term>
 
146
<listitem><simpara> the argument key
 
147
</simpara></listitem></varlistentry>
 
148
<varlistentry><term><parameter>value</parameter>&#160;:</term>
 
149
<listitem><simpara> value return container
 
150
</simpara></listitem></varlistentry>
 
151
</variablelist></refsect2>
 
152
<refsect2 id="gedit-message-set" role="function">
 
153
<title>gedit_message_set ()</title>
 
154
<indexterm zone="gedit-message-set"><primary sortas="gedit_message_set">gedit_message_set</primary></indexterm><programlisting><link linkend="void">void</link>                gedit_message_set                   (<link linkend="GeditMessage">GeditMessage</link> *message,
 
155
                                                         ...);</programlisting>
 
156
<para>
 
157
Set values of message arguments. The supplied <parameter>var_args</parameter> should contain
 
158
pairs of keys and argument values.</para>
 
159
<para>
 
160
</para><variablelist role="params">
 
161
<varlistentry><term><parameter>message</parameter>&#160;:</term>
 
162
<listitem><simpara> the <link linkend="GeditMessage"><type>GeditMessage</type></link>
 
163
</simpara></listitem></varlistentry>
 
164
<varlistentry><term><parameter>...</parameter>&#160;:</term>
 
165
<listitem><simpara> a NULL terminated variable list of key/value pairs
 
166
</simpara></listitem></varlistentry>
 
167
</variablelist></refsect2>
 
168
<refsect2 id="gedit-message-set-valist" role="function">
 
169
<title>gedit_message_set_valist ()</title>
 
170
<indexterm zone="gedit-message-set-valist"><primary sortas="gedit_message_set_valist">gedit_message_set_valist</primary></indexterm><programlisting><link linkend="void">void</link>                gedit_message_set_valist            (<link linkend="GeditMessage">GeditMessage</link> *message,
 
171
                                                         <link linkend="va-list">va_list</link> var_args);</programlisting>
 
172
<para>
 
173
Set values of message arguments. The supplied <parameter>var_args</parameter> should contain
 
174
pairs of keys and argument values.</para>
 
175
<para>
 
176
</para><variablelist role="params">
 
177
<varlistentry><term><parameter>message</parameter>&#160;:</term>
 
178
<listitem><simpara> the <link linkend="GeditMessage"><type>GeditMessage</type></link>
 
179
</simpara></listitem></varlistentry>
 
180
<varlistentry><term><parameter>var_args</parameter>&#160;:</term>
 
181
<listitem><simpara> a NULL terminated variable list of key/value pairs
 
182
</simpara></listitem></varlistentry>
 
183
</variablelist></refsect2>
 
184
<refsect2 id="gedit-message-set-value" role="function">
 
185
<title>gedit_message_set_value ()</title>
 
186
<indexterm zone="gedit-message-set-value"><primary sortas="gedit_message_set_value">gedit_message_set_value</primary></indexterm><programlisting><link linkend="void">void</link>                gedit_message_set_value             (<link linkend="GeditMessage">GeditMessage</link> *message,
 
187
                                                         const <link linkend="gchar">gchar</link> *key,
 
188
                                                         <link linkend="GValue">GValue</link> *value);</programlisting>
 
189
<para>
 
190
Set value of message argument <parameter>key</parameter> to <parameter>value</parameter>.</para>
 
191
<para>
 
192
</para><variablelist role="params">
 
193
<varlistentry><term><parameter>message</parameter>&#160;:</term>
 
194
<listitem><simpara> the <link linkend="GeditMessage"><type>GeditMessage</type></link>
 
195
</simpara></listitem></varlistentry>
 
196
<varlistentry><term><parameter>key</parameter>&#160;:</term>
 
197
<listitem><simpara> the argument key
 
198
</simpara></listitem></varlistentry>
 
199
<varlistentry><term><parameter>value</parameter>&#160;:</term>
 
200
<listitem><simpara> the argument value
 
201
</simpara></listitem></varlistentry>
 
202
</variablelist></refsect2>
 
203
<refsect2 id="gedit-message-set-valuesv" role="function">
 
204
<title>gedit_message_set_valuesv ()</title>
 
205
<indexterm zone="gedit-message-set-valuesv"><primary sortas="gedit_message_set_valuesv">gedit_message_set_valuesv</primary></indexterm><programlisting><link linkend="void">void</link>                gedit_message_set_valuesv           (<link linkend="GeditMessage">GeditMessage</link> *message,
 
206
                                                         const <link linkend="gchar">gchar</link> **keys,
 
207
                                                         <link linkend="GValue">GValue</link> *values,
 
208
                                                         <link linkend="gint">gint</link> n_values);</programlisting>
 
209
<para>
 
210
Set message argument values.</para>
 
211
<para>
 
212
</para><variablelist role="params">
 
213
<varlistentry><term><parameter>message</parameter>&#160;:</term>
 
214
<listitem><simpara> the <link linkend="GeditMessage"><type>GeditMessage</type></link>
 
215
</simpara></listitem></varlistentry>
 
216
<varlistentry><term><parameter>keys</parameter>&#160;:</term>
 
217
<listitem><simpara> keys to set values for
 
218
</simpara></listitem></varlistentry>
 
219
<varlistentry><term><parameter>values</parameter>&#160;:</term>
 
220
<listitem><simpara> values to set
 
221
</simpara></listitem></varlistentry>
 
222
<varlistentry><term><parameter>n_values</parameter>&#160;:</term>
 
223
<listitem><simpara> number of arguments to set values for
 
224
</simpara></listitem></varlistentry>
 
225
</variablelist></refsect2>
 
226
<refsect2 id="gedit-message-get-object-path" role="function">
 
227
<title>gedit_message_get_object_path ()</title>
 
228
<indexterm zone="gedit-message-get-object-path"><primary sortas="gedit_message_get_object_path">gedit_message_get_object_path</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link> *       gedit_message_get_object_path       (<link linkend="GeditMessage">GeditMessage</link> *message);</programlisting>
 
229
<para>
 
230
Get the message object path.</para>
 
231
<para>
 
232
</para><variablelist role="params">
 
233
<varlistentry><term><parameter>message</parameter>&#160;:</term>
 
234
<listitem><simpara> the <link linkend="GeditMessage"><type>GeditMessage</type></link>
 
235
</simpara></listitem></varlistentry>
 
236
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the message object path
 
237
 
 
238
</simpara></listitem></varlistentry>
 
239
</variablelist></refsect2>
 
240
<refsect2 id="gedit-message-get-method" role="function">
 
241
<title>gedit_message_get_method ()</title>
 
242
<indexterm zone="gedit-message-get-method"><primary sortas="gedit_message_get_method">gedit_message_get_method</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link> *       gedit_message_get_method            (<link linkend="GeditMessage">GeditMessage</link> *message);</programlisting>
 
243
<para>
 
244
Get the message method.</para>
 
245
<para>
 
246
</para><variablelist role="params">
 
247
<varlistentry><term><parameter>message</parameter>&#160;:</term>
 
248
<listitem><simpara> the <link linkend="GeditMessage"><type>GeditMessage</type></link>
 
249
</simpara></listitem></varlistentry>
 
250
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the message method
 
251
 
 
252
</simpara></listitem></varlistentry>
 
253
</variablelist></refsect2>
 
254
<refsect2 id="gedit-message-has-key" role="function">
 
255
<title>gedit_message_has_key ()</title>
 
256
<indexterm zone="gedit-message-has-key"><primary sortas="gedit_message_has_key">gedit_message_has_key</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gedit_message_has_key               (<link linkend="GeditMessage">GeditMessage</link> *message,
 
257
                                                         const <link linkend="gchar">gchar</link> *key);</programlisting>
 
258
<para>
 
259
Check whether the message has a specific key.</para>
 
260
<para>
 
261
</para><variablelist role="params">
 
262
<varlistentry><term><parameter>message</parameter>&#160;:</term>
 
263
<listitem><simpara> the <link linkend="GeditMessage"><type>GeditMessage</type></link>
 
264
</simpara></listitem></varlistentry>
 
265
<varlistentry><term><parameter>key</parameter>&#160;:</term>
 
266
<listitem><simpara> the argument key
 
267
</simpara></listitem></varlistentry>
 
268
<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>
 
269
 
 
270
</simpara></listitem></varlistentry>
 
271
</variablelist></refsect2>
 
272
<refsect2 id="gedit-message-get-key-type" role="function">
 
273
<title>gedit_message_get_key_type ()</title>
 
274
<indexterm zone="gedit-message-get-key-type"><primary sortas="gedit_message_get_key_type">gedit_message_get_key_type</primary></indexterm><programlisting><link linkend="GType">GType</link>               gedit_message_get_key_type          (<link linkend="GeditMessage">GeditMessage</link> *message,
 
275
                                                         const <link linkend="gchar">gchar</link> *key);</programlisting>
 
276
<para>
 
277
Get the type of a message argument.</para>
 
278
<para>
 
279
</para><variablelist role="params">
 
280
<varlistentry><term><parameter>message</parameter>&#160;:</term>
 
281
<listitem><simpara> the <link linkend="GeditMessage"><type>GeditMessage</type></link>
 
282
</simpara></listitem></varlistentry>
 
283
<varlistentry><term><parameter>key</parameter>&#160;:</term>
 
284
<listitem><simpara> the argument key
 
285
</simpara></listitem></varlistentry>
 
286
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the type of <parameter>key</parameter>
 
287
 
 
288
</simpara></listitem></varlistentry>
 
289
</variablelist></refsect2>
 
290
<refsect2 id="gedit-message-validate" role="function">
 
291
<title>gedit_message_validate ()</title>
 
292
<indexterm zone="gedit-message-validate"><primary sortas="gedit_message_validate">gedit_message_validate</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gedit_message_validate              (<link linkend="GeditMessage">GeditMessage</link> *message);</programlisting>
 
293
<para>
 
294
Validates the message arguments according to the message type.</para>
 
295
<para>
 
296
</para><variablelist role="params">
 
297
<varlistentry><term><parameter>message</parameter>&#160;:</term>
 
298
<listitem><simpara> the <link linkend="GeditMessage"><type>GeditMessage</type></link>
 
299
</simpara></listitem></varlistentry>
 
300
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if the message is valid
 
301
 
 
302
</simpara></listitem></varlistentry>
 
303
</variablelist></refsect2>
 
304
 
 
305
</refsect1>
 
306
<refsect1 id="GeditMessage.property-details" role="property_details">
 
307
<title role="property_details.title">Property Details</title>
 
308
<refsect2 id="GeditMessage--method" role="property"><title>The <literal>&quot;method&quot;</literal> property</title>
 
309
<indexterm zone="GeditMessage--method"><primary sortas="GeditMessage:method">GeditMessage:method</primary></indexterm><programlisting>  &quot;method&quot;                   <link linkend="gchar">gchar</link>*                : Read</programlisting>
 
310
<para>
 
311
The messages method.</para>
 
312
<para>
 
313
</para><para>Default value: NULL</para>
 
314
</refsect2>
 
315
<refsect2 id="GeditMessage--object-path" role="property"><title>The <literal>&quot;object-path&quot;</literal> property</title>
 
316
<indexterm zone="GeditMessage--object-path"><primary sortas="GeditMessage:object-path">GeditMessage:object-path</primary></indexterm><programlisting>  &quot;object-path&quot;              <link linkend="gchar">gchar</link>*                : Read</programlisting>
 
317
<para>The message object path.</para><para>Default value: NULL</para>
 
318
</refsect2>
 
319
<refsect2 id="GeditMessage--type" role="property"><title>The <literal>&quot;type&quot;</literal> property</title>
 
320
<indexterm zone="GeditMessage--type"><primary sortas="GeditMessage:type">GeditMessage:type</primary></indexterm><programlisting>  &quot;type&quot;                     <link linkend="GeditMessageType">GeditMessageType</link>*     : Read / Write / Construct Only</programlisting>
 
321
<para>The message type.</para></refsect2>
 
322
</refsect1>
 
323
 
 
324
 
 
325
 
 
326
 
 
327
</refentry>