1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
|
<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"
[
<!ENTITY % local.common.attrib "xmlns:xi CDATA #FIXED 'http://www.w3.org/2003/XInclude'">
]>
<refentry id="ListallerMessageObject">
<refmeta>
<refentrytitle role="top_of_page" id="ListallerMessageObject.top_of_page">ListallerMessageObject</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>
LISTALLER Library
</refmiscinfo>
</refmeta>
<refnamediv>
<refname>ListallerMessageObject</refname>
<refpurpose>Class providing basic message handling</refpurpose>
</refnamediv>
<refsect1 id="ListallerMessageObject.functions" role="functions_proto">
<title role="functions_proto.title">Functions</title>
<informaltable pgwide="1" frame="none">
<tgroup cols="2">
<colspec colname="functions_return" colwidth="150px"/>
<colspec colname="functions_name"/>
<tbody>
<row><entry role="define_keyword">#define</entry><entry role="function_name"><link linkend="LISTALLER-TYPE-MESSAGE-OBJECT:CAPS">LISTALLER_TYPE_MESSAGE_OBJECT</link></entry></row>
<row><entry role="function_type"><link linkend="void"><returnvalue>void</returnvalue></link>
</entry><entry role="function_name"><link linkend="listaller-message-object-set-error-hint-str">listaller_message_object_set_error_hint_str</link> <phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="void"><returnvalue>void</returnvalue></link>
</entry><entry role="function_name"><link linkend="listaller-message-object-connect-with-object">listaller_message_object_connect_with_object</link> <phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="void"><returnvalue>void</returnvalue></link>
</entry><entry role="function_name"><link linkend="listaller-message-object-connect-with-object-all">listaller_message_object_connect_with_object_all</link> <phrase role="c_punctuation">()</phrase></entry></row>
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 id="ListallerMessageObject.signals" role="signal_proto">
<title role="signal_proto.title">Signals</title>
<informaltable frame="none">
<tgroup cols="3">
<colspec colname="signals_return" colwidth="150px"/>
<colspec colname="signals_name" colwidth="300px"/>
<colspec colname="signals_flags" colwidth="200px"/>
<tbody>
<row><entry role="signal_type"><link linkend="void"><returnvalue>void</returnvalue></link></entry><entry role="signal_name"><link linkend="ListallerMessageObject-error-code">error-code</link></entry><entry role="signal_flags"><link linkend="G-SIGNAL-RUN-LAST:CAPS">Run Last</link></entry></row>
<row><entry role="signal_type"><link linkend="void"><returnvalue>void</returnvalue></link></entry><entry role="signal_name"><link linkend="ListallerMessageObject-message">message</link></entry><entry role="signal_flags"><link linkend="G-SIGNAL-RUN-LAST:CAPS">Run Last</link></entry></row>
<row><entry role="signal_type"><link linkend="void"><returnvalue>void</returnvalue></link></entry><entry role="signal_name"><link linkend="ListallerMessageObject-progress">progress</link></entry><entry role="signal_flags"><link linkend="G-SIGNAL-RUN-LAST:CAPS">Run Last</link></entry></row>
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 id="ListallerMessageObject.other" role="other_proto">
<title role="other_proto.title">Types and Values</title>
<informaltable role="enum_members_table" pgwide="1" frame="none">
<tgroup cols="2">
<colspec colname="name" colwidth="150px"/>
<colspec colname="description"/>
<tbody>
<row><entry role="datatype_keyword">struct</entry><entry role="function_name"><link linkend="ListallerMessageObject-struct">ListallerMessageObject</link></entry></row>
<row><entry role="datatype_keyword">struct</entry><entry role="function_name"><link linkend="ListallerMessageObjectClass">ListallerMessageObjectClass</link></entry></row>
<row><entry role="datatype_keyword">enum</entry><entry role="function_name"><link linkend="ListallerObjConnectFlags">ListallerObjConnectFlags</link></entry></row>
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 id="ListallerMessageObject.object-hierarchy" role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<screen> <link linkend="GEnum">GEnum</link>
<phrase role="lineart">╰──</phrase> ListallerObjConnectFlags
<link linkend="GObject">GObject</link>
<phrase role="lineart">╰──</phrase> ListallerMessageObject
<phrase role="lineart">├──</phrase> <link linkend="ListallerKeyManager">ListallerKeyManager</link>
<phrase role="lineart">├──</phrase> <link linkend="ListallerManager">ListallerManager</link>
<phrase role="lineart">├──</phrase> <link linkend="ListallerSetup">ListallerSetup</link>
<phrase role="lineart">╰──</phrase> <link linkend="ListallerUpdater">ListallerUpdater</link>
</screen>
</refsect1>
<refsect1 id="ListallerMessageObject.description" role="desc">
<title role="desc.title">Description</title>
<para>Base class for all Listaller classes which want to send messages to each other. (Used e.g. for GUI stuff and in the public API)</para>
</refsect1>
<refsect1 id="ListallerMessageObject.functions_details" role="details">
<title role="details.title">Functions</title>
<refsect2 id="LISTALLER-TYPE-MESSAGE-OBJECT:CAPS" role="macro">
<title>LISTALLER_TYPE_MESSAGE_OBJECT</title>
<indexterm zone="LISTALLER-TYPE-MESSAGE-OBJECT:CAPS"><primary sortas="TYPE_MESSAGE_OBJECT">LISTALLER_TYPE_MESSAGE_OBJECT</primary></indexterm>
<programlisting language="C">#define LISTALLER_TYPE_MESSAGE_OBJECT (listaller_message_object_get_type ())
</programlisting>
<para>The type for <link linkend="ListallerMessageObject"><type>ListallerMessageObject</type></link>.</para>
</refsect2>
<refsect2 id="listaller-message-object-set-error-hint-str" role="function">
<title>listaller_message_object_set_error_hint_str ()</title>
<indexterm zone="listaller-message-object-set-error-hint-str"><primary sortas="message_object_set_error_hint_str">listaller_message_object_set_error_hint_str</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
listaller_message_object_set_error_hint_str
(<parameter><link linkend="ListallerMessageObject"><type>ListallerMessageObject</type></link> *self</parameter>,
<parameter>const <link linkend="gchar"><type>gchar</type></link> *str</parameter>);</programlisting>
<refsect3 role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>self</para></entry>
<entry role="parameter_description"><para>the <link linkend="ListallerMessageObject"><type>ListallerMessageObject</type></link> instance</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>str</para></entry>
<entry role="parameter_description"><para> </para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3></refsect2>
<refsect2 id="listaller-message-object-connect-with-object" role="function">
<title>listaller_message_object_connect_with_object ()</title>
<indexterm zone="listaller-message-object-connect-with-object"><primary sortas="message_object_connect_with_object">listaller_message_object_connect_with_object</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
listaller_message_object_connect_with_object
(<parameter><link linkend="ListallerMessageObject"><type>ListallerMessageObject</type></link> *self</parameter>,
<parameter><link linkend="ListallerMessageObject"><type>ListallerMessageObject</type></link> *other_obj</parameter>,
<parameter><link linkend="ListallerObjConnectFlags"><type>ListallerObjConnectFlags</type></link> flags</parameter>);</programlisting>
<refsect3 role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>self</para></entry>
<entry role="parameter_description"><para>the <link linkend="ListallerMessageObject"><type>ListallerMessageObject</type></link> instance</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>other_obj</para></entry>
<entry role="parameter_description"><para> </para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>flags</para></entry>
<entry role="parameter_description"><para> </para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3></refsect2>
<refsect2 id="listaller-message-object-connect-with-object-all" role="function">
<title>listaller_message_object_connect_with_object_all ()</title>
<indexterm zone="listaller-message-object-connect-with-object-all"><primary sortas="message_object_connect_with_object_all">listaller_message_object_connect_with_object_all</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
listaller_message_object_connect_with_object_all
(<parameter><link linkend="ListallerMessageObject"><type>ListallerMessageObject</type></link> *self</parameter>,
<parameter><link linkend="ListallerMessageObject"><type>ListallerMessageObject</type></link> *other_obj</parameter>);</programlisting>
<refsect3 role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>self</para></entry>
<entry role="parameter_description"><para>the <link linkend="ListallerMessageObject"><type>ListallerMessageObject</type></link> instance</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>other_obj</para></entry>
<entry role="parameter_description"><para> </para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3></refsect2>
</refsect1>
<refsect1 id="ListallerMessageObject.other_details" role="details">
<title role="details.title">Types and Values</title>
<refsect2 id="ListallerMessageObject-struct" role="struct">
<title>struct ListallerMessageObject</title>
<indexterm zone="ListallerMessageObject-struct"><primary sortas="MessageObject">ListallerMessageObject</primary></indexterm>
<programlisting language="C">struct ListallerMessageObject;</programlisting>
<para>Class providing basic message handling</para>
<para>Base class for all Listaller classes which want to send messages to each other. (Used e.g. for GUI stuff and in the public API)</para>
</refsect2>
<refsect2 id="ListallerMessageObjectClass" role="struct">
<title>struct ListallerMessageObjectClass</title>
<indexterm zone="ListallerMessageObjectClass"><primary sortas="MessageObjectClass">ListallerMessageObjectClass</primary></indexterm>
<programlisting language="C">struct ListallerMessageObjectClass {
GObjectClass parent_class;
void (*emit_message) (ListallerMessageObject* self, const gchar* msg);
void (*emit_warning) (ListallerMessageObject* self, const gchar* msg);
void (*emit_error) (ListallerMessageObject* self, ListallerErrorEnum id, const gchar* details);
void (*change_progress) (ListallerMessageObject* self, gint prog_value);
void (*change_item_progress) (ListallerMessageObject* self, const gchar* id, guint item_progress);
};
</programlisting>
<para>The class structure for <link linkend="LISTALLER-TYPE-MESSAGE-OBJECT:CAPS"><literal>LISTALLER_TYPE_MESSAGE_OBJECT</literal></link>. All the fields in this structure are private and should never be accessed directly.</para>
<refsect3 role="struct_members">
<title>Members</title>
<informaltable role="struct_members_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="struct_members_name" colwidth="300px"/>
<colspec colname="struct_members_description"/>
<colspec colname="struct_members_annotations" colwidth="200px"/>
<tbody>
<row><entry role="struct_member_name"><para><link linkend="GObjectClass"><type>GObjectClass</type></link> <structfield id="ListallerMessageObjectClass.parent-class">parent_class</structfield>;</para></entry>
<listitem><para>the parent class structure</para></listitem>
<entry role="struct_member_description"><para>the parent class structure</para></entry>
<entry role="struct_member_annotations"></entry>
</row>
<row><entry role="struct_member_name"><para><structfield id="ListallerMessageObjectClass.emit-message">emit_message</structfield> ()</para></entry>
<entry /><entry />
</row>
<row><entry role="struct_member_name"><para><structfield id="ListallerMessageObjectClass.emit-warning">emit_warning</structfield> ()</para></entry>
<entry /><entry />
</row>
<row><entry role="struct_member_name"><para><structfield id="ListallerMessageObjectClass.emit-error">emit_error</structfield> ()</para></entry>
<entry /><entry />
</row>
<row><entry role="struct_member_name"><para><structfield id="ListallerMessageObjectClass.change-progress">change_progress</structfield> ()</para></entry>
<entry /><entry />
</row>
<row><entry role="struct_member_name"><para><structfield id="ListallerMessageObjectClass.change-item-progress">change_item_progress</structfield> ()</para></entry>
<entry /><entry />
</row>
</tbody></tgroup></informaltable>
</refsect3>
</refsect2>
<refsect2 id="ListallerObjConnectFlags" role="enum">
<title>enum ListallerObjConnectFlags</title>
<indexterm zone="ListallerObjConnectFlags"><primary sortas="ObjConnectFlags">ListallerObjConnectFlags</primary></indexterm>
<refsect3 role="enum_members">
<title>Members</title>
<informaltable role="enum_members_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="enum_members_name" colwidth="300px"/>
<colspec colname="enum_members_description"/>
<colspec colname="enum_members_annotations" colwidth="200px"/>
<tbody>
<row role="constant"><entry role="enum_member_name"><para id="LISTALLER-OBJ-CONNECT-FLAGS-NONE:CAPS">LISTALLER_OBJ_CONNECT_FLAGS_NONE</para></entry>
<entry /><entry />
</row>
<row role="constant"><entry role="enum_member_name"><para id="LISTALLER-OBJ-CONNECT-FLAGS-PROGRESS-TO-SUBPROGRESS:CAPS">LISTALLER_OBJ_CONNECT_FLAGS_PROGRESS_TO_SUBPROGRESS</para></entry>
<entry /><entry />
</row>
<row role="constant"><entry role="enum_member_name"><para id="LISTALLER-OBJ-CONNECT-FLAGS-IGNORE-PROGRESS:CAPS">LISTALLER_OBJ_CONNECT_FLAGS_IGNORE_PROGRESS</para></entry>
<entry /><entry />
</row>
<row role="constant"><entry role="enum_member_name"><para id="LISTALLER-OBJ-CONNECT-FLAGS-IGNORE-ERROR-CODE:CAPS">LISTALLER_OBJ_CONNECT_FLAGS_IGNORE_ERROR_CODE</para></entry>
<entry /><entry />
</row>
</tbody></tgroup></informaltable>
</refsect3></refsect2>
</refsect1>
<refsect1 id="ListallerMessageObject.signal-details" role="signals">
<title role="signals.title">Signal Details</title>
<refsect2 id="ListallerMessageObject-error-code" role="signal"><title>The <literal>“error-code”</literal> signal</title>
<indexterm zone="ListallerMessageObject-error-code"><primary sortas="MessageObject::error-code">ListallerMessageObject::error-code</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
user_function (<link linkend="ListallerMessageObject"><type>ListallerMessageObject</type></link> *message_object,
<link linkend="ListallerErrorItem"><type>ListallerErrorItem</type></link> *error,
<link linkend="gpointer"><type>gpointer</type></link> user_data)</programlisting>
<refsect3 role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>message_object</para></entry>
<entry role="parameter_description"><para>the <link linkend="ListallerMessageObject"><type>ListallerMessageObject</type></link> instance that received the signal</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>error</para></entry>
<entry role="parameter_description"><para> </para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><simpara>user_data</simpara></entry>
<entry role="parameter_description"><simpara>user data set when the signal handler was connected.</simpara></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><para>Flags: <link linkend="G-SIGNAL-RUN-LAST:CAPS">Run Last</link></para>
</refsect2><refsect2 id="ListallerMessageObject-message" role="signal"><title>The <literal>“message”</literal> signal</title>
<indexterm zone="ListallerMessageObject-message"><primary sortas="MessageObject::message">ListallerMessageObject::message</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
user_function (<link linkend="ListallerMessageObject"><type>ListallerMessageObject</type></link> *message_object,
<link linkend="ListallerMessageItem"><type>ListallerMessageItem</type></link> *message,
<link linkend="gpointer"><type>gpointer</type></link> user_data)</programlisting>
<refsect3 role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>message_object</para></entry>
<entry role="parameter_description"><para>the <link linkend="ListallerMessageObject"><type>ListallerMessageObject</type></link> instance that received the signal</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>message</para></entry>
<entry role="parameter_description"><para> </para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><simpara>user_data</simpara></entry>
<entry role="parameter_description"><simpara>user data set when the signal handler was connected.</simpara></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><para>Flags: <link linkend="G-SIGNAL-RUN-LAST:CAPS">Run Last</link></para>
</refsect2><refsect2 id="ListallerMessageObject-progress" role="signal"><title>The <literal>“progress”</literal> signal</title>
<indexterm zone="ListallerMessageObject-progress"><primary sortas="MessageObject::progress">ListallerMessageObject::progress</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
user_function (<link linkend="ListallerMessageObject"><type>ListallerMessageObject</type></link> *message_object,
<link linkend="ListallerProgressItem"><type>ListallerProgressItem</type></link> *prog,
<link linkend="gpointer"><type>gpointer</type></link> user_data)</programlisting>
<refsect3 role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>message_object</para></entry>
<entry role="parameter_description"><para>the <link linkend="ListallerMessageObject"><type>ListallerMessageObject</type></link> instance that received the signal</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>prog</para></entry>
<entry role="parameter_description"><para> </para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><simpara>user_data</simpara></entry>
<entry role="parameter_description"><simpara>user data set when the signal handler was connected.</simpara></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><para>Flags: <link linkend="G-SIGNAL-RUN-LAST:CAPS">Run Last</link></para>
</refsect2>
</refsect1>
</refentry>
|
