/usr/share/gtk-doc/html/libgwyddion/GwyStringList.html is in libgwyddion20-doc 2.34-3ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Gwyddion Library Reference Manual: GwyStringList</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<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="libgwyddion-gwymd5.html" title="gwymd5">
<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="10"><tr valign="middle">
<td width="100%" align="left">
<a href="#" class="shortcut">Top</a>
|
<a href="#GwyStringList.description" class="shortcut">Description</a>
|
<a href="#GwyStringList.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#GwyStringList.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
|
<a href="#GwyStringList.signals" class="shortcut">Signals</a>
</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="libgwyddion-gwymd5.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</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="GwyStringList.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include <libgwyddion/gwyddion.h>
struct <a class="link" href="GwyStringList.html#GwyStringList-struct" title="struct GwyStringList">GwyStringList</a>;
struct <a class="link" href="GwyStringList.html#GwyStringListClass" title="struct GwyStringListClass">GwyStringListClass</a>;
#define <a class="link" href="GwyStringList.html#gwy-string-list-duplicate" title="gwy_string_list_duplicate()">gwy_string_list_duplicate</a> (strlist)
<a class="link" href="GwyStringList.html" title="GwyStringList"><span class="returnvalue">GwyStringList</span></a> * <a class="link" href="GwyStringList.html#gwy-string-list-new" title="gwy_string_list_new ()">gwy_string_list_new</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
<span class="returnvalue">void</span> <a class="link" href="GwyStringList.html#gwy-string-list-append" title="gwy_string_list_append ()">gwy_string_list_append</a> (<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>);
<a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a> <a class="link" href="GwyStringList.html#gwy-string-list-get-length" title="gwy_string_list_get_length ()">gwy_string_list_get_length</a> (<em class="parameter"><code><a class="link" href="GwyStringList.html" title="GwyStringList"><span class="type">GwyStringList</span></a> *strlist</code></em>);
const <a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * <a class="link" href="GwyStringList.html#gwy-string-list-get" title="gwy_string_list_get ()">gwy_string_list_get</a> (<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>
</div>
<div class="refsect1">
<a name="GwyStringList.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
<a href="http://developer.gnome.org/doc/API/2.0/gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a>
+----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.signals"></a><h2>Signals</h2>
<pre class="synopsis">
"<a class="link" href="GwyStringList.html#GwyStringList-value-changed" title='The "value-changed" signal'>value-changed</a>" : <a href="http://developer.gnome.org/doc/API/2.0/gobject/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS"><code class="literal">Run First</code></a>
</pre>
</div>
<div class="refsect1">
<a name="GwyStringList.description"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1">
<a name="GwyStringList.details"></a><h2>Details</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);
void (*reserved1)(void);
void (*reserved2)(void);
void (*reserved3)(void);
};
</pre>
<p>
</p>
</div>
<hr>
<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="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>strlist</code></em> :</span></p></td>
<td>A string list to duplicate.</td>
</tr></tbody>
</table></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="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>A new empty string list.</td>
</tr></tbody>
</table></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="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>strlist</code></em> :</span></p></td>
<td>A string list.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>string</code></em> :</span></p></td>
<td>A string to add.</td>
</tr>
</tbody>
</table></div>
</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="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>strlist</code></em> :</span></p></td>
<td>A string list.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The number of strings in <em class="parameter"><code>strlist</code></em>.</td>
</tr>
</tbody>
</table></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="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>strlist</code></em> :</span></p></td>
<td>A string list.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>i</code></em> :</span></p></td>
<td>The position of string to get.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The string, owned by <em class="parameter"><code>strlist</code></em>. It is valid only until <em class="parameter"><code>strlist</code></em>
changes.</td>
</tr>
</tbody>
</table></div>
</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) : <a href="http://developer.gnome.org/doc/API/2.0/gobject/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS"><code class="literal">Run First</code></a></pre>
<p>
The ::value-changed signal is emitted whenever a string list changes.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>gwystrlist</code></em> :</span></p></td>
<td>The <a class="link" href="GwyStringList.html" title="GwyStringList"><span class="type">GwyStringList</span></a> which received the signal.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.19</div>
</body>
</html>
|