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
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GwyStringList: Gwyddion Library Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
<link rel="home" href="index.html" title="Gwyddion Library Reference Manual">
<link rel="up" href="index.html" title="Gwyddion Library Reference Manual">
<link rel="prev" href="GwyResource.html" title="GwyResource">
<link rel="next" href="GwyResults.html" title="GwyResults">
<meta name="generator" content="GTK-Doc V1.19 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
<a href="#GwyStringList.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#GwyStringList.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces"> <span class="dim">|</span>
<a href="#GwyStringList.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_signals"> <span class="dim">|</span>
<a href="#GwyStringList.signals" class="shortcut">Signals</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><img src="up-insensitive.png" width="16" height="16" border="0"></td>
<td><a accesskey="p" href="GwyResource.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="GwyResults.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="GwyStringList"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GwyStringList.top_of_page"></a>GwyStringList</span></h2>
<p>GwyStringList — A string list object wrapper</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="GwyStringList.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name">
<a class="link" href="GwyStringList.html#gwy-string-list-duplicate" title="gwy_string_list_duplicate()">gwy_string_list_duplicate</a><span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="GwyStringList.html" title="GwyStringList"><span class="returnvalue">GwyStringList</span></a> *
</td>
<td class="function_name">
<a class="link" href="GwyStringList.html#gwy-string-list-new" title="gwy_string_list_new ()">gwy_string_list_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GwyStringList.html#gwy-string-list-append" title="gwy_string_list_append ()">gwy_string_list_append</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GwyStringList.html#gwy-string-list-append-take" title="gwy_string_list_append_take ()">gwy_string_list_append_take</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>
</td>
<td class="function_name">
<a class="link" href="GwyStringList.html#gwy-string-list-get-length" title="gwy_string_list_get_length ()">gwy_string_list_get_length</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
</td>
<td class="function_name">
<a class="link" href="GwyStringList.html#gwy-string-list-get" title="gwy_string_list_get ()">gwy_string_list_get</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GwyStringList.html#gwy-string-list-clear" title="gwy_string_list_clear ()">gwy_string_list_clear</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GwyStringList.signals"></a><h2>Signals</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="signals_return">
<col width="300px" class="signals_name">
<col width="200px" class="signals_flags">
</colgroup>
<tbody><tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="GwyStringList.html#GwyStringList-value-changed" title="The “value-changed” signal">value-changed</a></td>
<td class="signal_flags"><a href="http://developer.gnome.org/doc/API/2.0/gobject/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS">Run First</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GwyStringList.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="GwyStringList.html#GwyStringList-struct" title="struct GwyStringList">GwyStringList</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="GwyStringList.html#GwyStringListClass" title="struct GwyStringListClass">GwyStringListClass</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GwyStringList.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> <a href="http://developer.gnome.org/doc/API/2.0/gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a>
<span class="lineart">╰──</span> GwyStringList
</pre>
</div>
<div class="refsect1">
<a name="GwyStringList.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
GwyStringList implements
<a class="link" href="GwySerializable.html" title="GwySerializable">GwySerializable</a>.</p>
</div>
<div class="refsect1">
<a name="GwyStringList.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include <libgwyddion/gwyddion.h>
</pre>
</div>
<div class="refsect1">
<a name="GwyStringList.description"></a><h2>Description</h2>
<p><a class="link" href="GwyStringList.html" title="GwyStringList"><span class="type">GwyStringList</span></a> object represents a reference-counted, serializable list of
strings. The current interface is very minimal, more methods may be added
later as needed.</p>
</div>
<div class="refsect1">
<a name="GwyStringList.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="gwy-string-list-duplicate"></a><h3>gwy_string_list_duplicate()</h3>
<pre class="programlisting">#define gwy_string_list_duplicate(strlist)</pre>
<p>Convenience macro doing <a class="link" href="GwySerializable.html#gwy-serializable-duplicate" title="gwy_serializable_duplicate ()"><code class="function">gwy_serializable_duplicate()</code></a> with all the necessary
typecasting.</p>
<div class="refsect3">
<a name="gwy-string-list-duplicate.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>strlist</p></td>
<td class="parameter_description"><p>A string list to duplicate.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-string-list-new"></a><h3>gwy_string_list_new ()</h3>
<pre class="programlisting"><a class="link" href="GwyStringList.html" title="GwyStringList"><span class="returnvalue">GwyStringList</span></a> *
gwy_string_list_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Creates a new string list.</p>
<div class="refsect3">
<a name="gwy-string-list-new.returns"></a><h4>Returns</h4>
<p> A new empty string list.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-string-list-append"></a><h3>gwy_string_list_append ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gwy_string_list_append (<em class="parameter"><code><a class="link" href="GwyStringList.html" title="GwyStringList"><span class="type">GwyStringList</span></a> *strlist</code></em>,
<em class="parameter"><code>const <a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *string</code></em>);</pre>
<p>Appends a string to the end of a string list.</p>
<div class="refsect3">
<a name="gwy-string-list-append.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>strlist</p></td>
<td class="parameter_description"><p>A string list.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>string</p></td>
<td class="parameter_description"><p>A string to add.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-string-list-append-take"></a><h3>gwy_string_list_append_take ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gwy_string_list_append_take (<em class="parameter"><code><a class="link" href="GwyStringList.html" title="GwyStringList"><span class="type">GwyStringList</span></a> *strlist</code></em>,
<em class="parameter"><code><a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *string</code></em>);</pre>
<p>Appends a string to the end of a string list, taking ownership of the string.</p>
<div class="refsect3">
<a name="gwy-string-list-append-take.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>strlist</p></td>
<td class="parameter_description"><p>A string list.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>string</p></td>
<td class="parameter_description"><p>A string to add.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-2-35.html#api-index-2.35">2.35</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-string-list-get-length"></a><h3>gwy_string_list_get_length ()</h3>
<pre class="programlisting"><a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>
gwy_string_list_get_length (<em class="parameter"><code><a class="link" href="GwyStringList.html" title="GwyStringList"><span class="type">GwyStringList</span></a> *strlist</code></em>);</pre>
<p>Gets the number of strings in a string list.</p>
<div class="refsect3">
<a name="gwy-string-list-get-length.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>strlist</p></td>
<td class="parameter_description"><p>A string list.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gwy-string-list-get-length.returns"></a><h4>Returns</h4>
<p> The number of strings in <em class="parameter"><code>strlist</code></em>
.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-string-list-get"></a><h3>gwy_string_list_get ()</h3>
<pre class="programlisting">const <a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
gwy_string_list_get (<em class="parameter"><code><a class="link" href="GwyStringList.html" title="GwyStringList"><span class="type">GwyStringList</span></a> *strlist</code></em>,
<em class="parameter"><code><a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> i</code></em>);</pre>
<p>Gets a string from a string list by position.</p>
<div class="refsect3">
<a name="gwy-string-list-get.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>strlist</p></td>
<td class="parameter_description"><p>A string list.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>i</p></td>
<td class="parameter_description"><p>The position of string to get.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gwy-string-list-get.returns"></a><h4>Returns</h4>
<p> The string, owned by <em class="parameter"><code>strlist</code></em>
. It is valid only until <em class="parameter"><code>strlist</code></em>
changes.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-string-list-clear"></a><h3>gwy_string_list_clear ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gwy_string_list_clear (<em class="parameter"><code><a class="link" href="GwyStringList.html" title="GwyStringList"><span class="type">GwyStringList</span></a> *strlist</code></em>);</pre>
<p>Clears the contents of a string list, removing all strings.</p>
<div class="refsect3">
<a name="gwy-string-list-clear.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>strlist</p></td>
<td class="parameter_description"><p>A string list.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-2-35.html#api-index-2.35">2.35</a></p>
</div>
</div>
<div class="refsect1">
<a name="GwyStringList.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GwyStringList-struct"></a><h3>struct GwyStringList</h3>
<pre class="programlisting">struct GwyStringList;</pre>
<p>The <a class="link" href="GwyStringList.html" title="GwyStringList"><span class="type">GwyStringList</span></a> struct contains private data only and should be accessed
using the functions below.</p>
</div>
<hr>
<div class="refsect2">
<a name="GwyStringListClass"></a><h3>struct GwyStringListClass</h3>
<pre class="programlisting">struct GwyStringListClass {
GObjectClass parent_class;
void (*value_changed)(GwyStringList *strlist);
};
</pre>
</div>
</div>
<div class="refsect1">
<a name="GwyStringList.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="GwyStringList-value-changed"></a><h3>The <code class="literal">“value-changed”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="GwyStringList.html" title="GwyStringList"><span class="type">GwyStringList</span></a> *gwystrlist,
<a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre>
<p>The ::value-changed signal is emitted whenever a string list changes.</p>
<div class="refsect3">
<a name="GwyStringList-value-changed.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>gwystrlist</p></td>
<td class="parameter_description"><p>The <a class="link" href="GwyStringList.html" title="GwyStringList"><span class="type">GwyStringList</span></a> which received the signal.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p>Flags: <a href="http://developer.gnome.org/doc/API/2.0/gobject/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS">Run First</a></p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.19</div>
</body>
</html>
|
