/usr/share/gtk-doc/html/evolution-util/GalViewCollection.html is in evolution-dev 3.10.4-0ubuntu1.
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 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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GalViewCollection</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="Evolution Utilities Reference Manual">
<link rel="up" href="ch13.html" title="View Management">
<link rel="prev" href="GalViewInstance.html" title="GalViewInstance">
<link rel="next" href="GalViewEtable.html" title="GalViewEtable">
<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="2">
<tr valign="middle">
<td><a accesskey="p" href="GalViewInstance.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch13.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">Evolution Utilities Reference Manual</th>
<td><a accesskey="n" href="GalViewEtable.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#GalViewCollection.synopsis" class="shortcut">Top</a>
|
<a href="#GalViewCollection.description" class="shortcut">Description</a>
|
<a href="#GalViewCollection.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#GalViewCollection.properties" class="shortcut">Properties</a>
|
<a href="#GalViewCollection.signals" class="shortcut">Signals</a>
</td></tr>
</table>
<div class="refentry">
<a name="GalViewCollection"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GalViewCollection.top_of_page"></a>GalViewCollection</span></h2>
<p>GalViewCollection</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="GalViewCollection.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">struct <a class="link" href="GalViewCollection.html#GalViewCollectionItem" title="struct GalViewCollectionItem">GalViewCollectionItem</a>;
struct <a class="link" href="GalViewCollection.html#GalViewCollection-struct" title="struct GalViewCollection">GalViewCollection</a>;
<a class="link" href="GalViewCollection.html" title="GalViewCollection"><span class="returnvalue">GalViewCollection</span></a> * <a class="link" href="GalViewCollection.html#gal-view-collection-new" title="gal_view_collection_new ()">gal_view_collection_new</a> (<em class="parameter"><code>const <span class="type">gchar</span> *system_directory</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *user_directory</code></em>);
const <span class="returnvalue">gchar</span> * <a class="link" href="GalViewCollection.html#gal-view-collection-get-system-directory" title="gal_view_collection_get_system_directory ()">gal_view_collection_get_system_directory</a>
(<em class="parameter"><code><a class="link" href="GalViewCollection.html" title="GalViewCollection"><span class="type">GalViewCollection</span></a> *collection</code></em>);
const <span class="returnvalue">gchar</span> * <a class="link" href="GalViewCollection.html#gal-view-collection-get-user-directory" title="gal_view_collection_get_user_directory ()">gal_view_collection_get_user_directory</a>
(<em class="parameter"><code><a class="link" href="GalViewCollection.html" title="GalViewCollection"><span class="type">GalViewCollection</span></a> *collection</code></em>);
<span class="returnvalue">gint</span> <a class="link" href="GalViewCollection.html#gal-view-collection-get-count" title="gal_view_collection_get_count ()">gal_view_collection_get_count</a> (<em class="parameter"><code><a class="link" href="GalViewCollection.html" title="GalViewCollection"><span class="type">GalViewCollection</span></a> *collection</code></em>);
<a class="link" href="GalView.html" title="GalView"><span class="returnvalue">GalView</span></a> * <a class="link" href="GalViewCollection.html#gal-view-collection-get-view" title="gal_view_collection_get_view ()">gal_view_collection_get_view</a> (<em class="parameter"><code><a class="link" href="GalViewCollection.html" title="GalViewCollection"><span class="type">GalViewCollection</span></a> *collection</code></em>,
<em class="parameter"><code><span class="type">gint</span> n</code></em>);
<a class="link" href="GalViewCollection.html#GalViewCollectionItem" title="struct GalViewCollectionItem"><span class="returnvalue">GalViewCollectionItem</span></a> * <a class="link" href="GalViewCollection.html#gal-view-collection-get-view-item" title="gal_view_collection_get_view_item ()">gal_view_collection_get_view_item</a>
(<em class="parameter"><code><a class="link" href="GalViewCollection.html" title="GalViewCollection"><span class="type">GalViewCollection</span></a> *collection</code></em>,
<em class="parameter"><code><span class="type">gint</span> n</code></em>);
<span class="returnvalue">gint</span> <a class="link" href="GalViewCollection.html#gal-view-collection-get-view-index-by-id" title="gal_view_collection_get_view_index_by_id ()">gal_view_collection_get_view_index_by_id</a>
(<em class="parameter"><code><a class="link" href="GalViewCollection.html" title="GalViewCollection"><span class="type">GalViewCollection</span></a> *collection</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *view_id</code></em>);
<span class="returnvalue">void</span> <a class="link" href="GalViewCollection.html#gal-view-collection-delete-view" title="gal_view_collection_delete_view ()">gal_view_collection_delete_view</a> (<em class="parameter"><code><a class="link" href="GalViewCollection.html" title="GalViewCollection"><span class="type">GalViewCollection</span></a> *collection</code></em>,
<em class="parameter"><code><span class="type">gint</span> i</code></em>);
<span class="returnvalue">void</span> <a class="link" href="GalViewCollection.html#gal-view-collection-save" title="gal_view_collection_save ()">gal_view_collection_save</a> (<em class="parameter"><code><a class="link" href="GalViewCollection.html" title="GalViewCollection"><span class="type">GalViewCollection</span></a> *collection</code></em>);
<a class="link" href="GalView.html" title="GalView"><span class="returnvalue">GalView</span></a> * <a class="link" href="GalViewCollection.html#gal-view-collection-load-view-from-file" title="gal_view_collection_load_view_from_file ()">gal_view_collection_load_view_from_file</a>
(<em class="parameter"><code><a class="link" href="GalViewCollection.html" title="GalViewCollection"><span class="type">GalViewCollection</span></a> *collection</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *type</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *filename</code></em>);
const <span class="returnvalue">gchar</span> * <a class="link" href="GalViewCollection.html#gal-view-collection-append-with-title" title="gal_view_collection_append_with_title ()">gal_view_collection_append_with_title</a>
(<em class="parameter"><code><a class="link" href="GalViewCollection.html" title="GalViewCollection"><span class="type">GalViewCollection</span></a> *collection</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *title</code></em>,
<em class="parameter"><code><a class="link" href="GalView.html" title="GalView"><span class="type">GalView</span></a> *view</code></em>);
const <span class="returnvalue">gchar</span> * <a class="link" href="GalViewCollection.html#gal-view-collection-set-nth-view" title="gal_view_collection_set_nth_view ()">gal_view_collection_set_nth_view</a> (<em class="parameter"><code><a class="link" href="GalViewCollection.html" title="GalViewCollection"><span class="type">GalViewCollection</span></a> *collection</code></em>,
<em class="parameter"><code><span class="type">gint</span> i</code></em>,
<em class="parameter"><code><a class="link" href="GalView.html" title="GalView"><span class="type">GalView</span></a> *view</code></em>);
const <span class="returnvalue">gchar</span> * <a class="link" href="GalViewCollection.html#gal-view-collection-get-default-view" title="gal_view_collection_get_default_view ()">gal_view_collection_get_default_view</a>
(<em class="parameter"><code><a class="link" href="GalViewCollection.html" title="GalViewCollection"><span class="type">GalViewCollection</span></a> *collection</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="GalViewCollection.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
GObject
+----GalViewCollection
</pre>
</div>
<div class="refsect1">
<a name="GalViewCollection.properties"></a><h2>Properties</h2>
<pre class="synopsis">
"<a class="link" href="GalViewCollection.html#GalViewCollection--system-directory" title='The "system-directory" property'>system-directory</a>" <span class="type">gchar</span>* : Read / Write / Construct Only
"<a class="link" href="GalViewCollection.html#GalViewCollection--user-directory" title='The "user-directory" property'>user-directory</a>" <span class="type">gchar</span>* : Read / Write / Construct Only
</pre>
</div>
<div class="refsect1">
<a name="GalViewCollection.signals"></a><h2>Signals</h2>
<pre class="synopsis">
"<a class="link" href="GalViewCollection.html#GalViewCollection-changed" title='The "changed" signal'>changed</a>" : <code class="literal">Run Last</code>
</pre>
</div>
<div class="refsect1">
<a name="GalViewCollection.description"></a><h2>Description</h2>
</div>
<div class="refsect1">
<a name="GalViewCollection.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="GalViewCollectionItem"></a><h3>struct GalViewCollectionItem</h3>
<pre class="programlisting">struct GalViewCollectionItem {
GalView *view;
gchar *id;
gboolean changed;
gboolean ever_changed;
gboolean built_in;
gchar *filename;
gchar *title;
gchar *type;
GalViewCollection *collection;
guint view_changed_id;
};
</pre>
</div>
<hr>
<div class="refsect2">
<a name="GalViewCollection-struct"></a><h3>struct GalViewCollection</h3>
<pre class="programlisting">struct GalViewCollection;</pre>
</div>
<hr>
<div class="refsect2">
<a name="gal-view-collection-new"></a><h3>gal_view_collection_new ()</h3>
<pre class="programlisting"><a class="link" href="GalViewCollection.html" title="GalViewCollection"><span class="returnvalue">GalViewCollection</span></a> * gal_view_collection_new (<em class="parameter"><code>const <span class="type">gchar</span> *system_directory</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *user_directory</code></em>);</pre>
<p>
Creates a <a class="link" href="GalViewCollection.html" title="GalViewCollection"><span class="type">GalViewCollection</span></a> and loads ".galview" files from
<em class="parameter"><code>system_directory</code></em> and <em class="parameter"><code>user_directory</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>system_directory</code></em> :</span></p></td>
<td>directory from which to load built-in views</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_directory</code></em> :</span></p></td>
<td>directory from which to load user-created views</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gal-view-collection-get-system-directory"></a><h3>gal_view_collection_get_system_directory ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> * gal_view_collection_get_system_directory
(<em class="parameter"><code><a class="link" href="GalViewCollection.html" title="GalViewCollection"><span class="type">GalViewCollection</span></a> *collection</code></em>);</pre>
<p>
Returns the directory from which built-in views were loaded.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>collection</code></em> :</span></p></td>
<td>a <a class="link" href="GalViewCollection.html" title="GalViewCollection"><span class="type">GalViewCollection</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the system directory for <em class="parameter"><code>collection</code></em>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gal-view-collection-get-user-directory"></a><h3>gal_view_collection_get_user_directory ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> * gal_view_collection_get_user_directory
(<em class="parameter"><code><a class="link" href="GalViewCollection.html" title="GalViewCollection"><span class="type">GalViewCollection</span></a> *collection</code></em>);</pre>
<p>
Returns the directory from which user-created views were loaded.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>collection</code></em> :</span></p></td>
<td>a <a class="link" href="GalViewCollection.html" title="GalViewCollection"><span class="type">GalViewCollection</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the user directory for <em class="parameter"><code>collection</code></em>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gal-view-collection-get-count"></a><h3>gal_view_collection_get_count ()</h3>
<pre class="programlisting"><span class="returnvalue">gint</span> gal_view_collection_get_count (<em class="parameter"><code><a class="link" href="GalViewCollection.html" title="GalViewCollection"><span class="type">GalViewCollection</span></a> *collection</code></em>);</pre>
<p>
Calculates the number of views in the given collection.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>collection</code></em> :</span></p></td>
<td>The view collection to count</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The number of views in the collection.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gal-view-collection-get-view"></a><h3>gal_view_collection_get_view ()</h3>
<pre class="programlisting"><a class="link" href="GalView.html" title="GalView"><span class="returnvalue">GalView</span></a> * gal_view_collection_get_view (<em class="parameter"><code><a class="link" href="GalViewCollection.html" title="GalViewCollection"><span class="type">GalViewCollection</span></a> *collection</code></em>,
<em class="parameter"><code><span class="type">gint</span> n</code></em>);</pre>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>collection</code></em> :</span></p></td>
<td>The view collection to query</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>n</code></em> :</span></p></td>
<td>The view to get.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The nth view in the collection</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gal-view-collection-get-view-item"></a><h3>gal_view_collection_get_view_item ()</h3>
<pre class="programlisting"><a class="link" href="GalViewCollection.html#GalViewCollectionItem" title="struct GalViewCollectionItem"><span class="returnvalue">GalViewCollectionItem</span></a> * gal_view_collection_get_view_item
(<em class="parameter"><code><a class="link" href="GalViewCollection.html" title="GalViewCollection"><span class="type">GalViewCollection</span></a> *collection</code></em>,
<em class="parameter"><code><span class="type">gint</span> n</code></em>);</pre>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>collection</code></em> :</span></p></td>
<td>The view collection to query</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>n</code></em> :</span></p></td>
<td>The view item to get.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The nth view item in the collection</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gal-view-collection-get-view-index-by-id"></a><h3>gal_view_collection_get_view_index_by_id ()</h3>
<pre class="programlisting"><span class="returnvalue">gint</span> gal_view_collection_get_view_index_by_id
(<em class="parameter"><code><a class="link" href="GalViewCollection.html" title="GalViewCollection"><span class="type">GalViewCollection</span></a> *collection</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *view_id</code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="gal-view-collection-delete-view"></a><h3>gal_view_collection_delete_view ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gal_view_collection_delete_view (<em class="parameter"><code><a class="link" href="GalViewCollection.html" title="GalViewCollection"><span class="type">GalViewCollection</span></a> *collection</code></em>,
<em class="parameter"><code><span class="type">gint</span> i</code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="gal-view-collection-save"></a><h3>gal_view_collection_save ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gal_view_collection_save (<em class="parameter"><code><a class="link" href="GalViewCollection.html" title="GalViewCollection"><span class="type">GalViewCollection</span></a> *collection</code></em>);</pre>
<p>
Saves the data to the user directory specified in set storage
directories. This is primarily for internal use by other parts of
gal_view.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>collection</code></em> :</span></p></td>
<td>The view collection to save information for</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gal-view-collection-load-view-from-file"></a><h3>gal_view_collection_load_view_from_file ()</h3>
<pre class="programlisting"><a class="link" href="GalView.html" title="GalView"><span class="returnvalue">GalView</span></a> * gal_view_collection_load_view_from_file
(<em class="parameter"><code><a class="link" href="GalViewCollection.html" title="GalViewCollection"><span class="type">GalViewCollection</span></a> *collection</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *type</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *filename</code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="gal-view-collection-append-with-title"></a><h3>gal_view_collection_append_with_title ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> * gal_view_collection_append_with_title
(<em class="parameter"><code><a class="link" href="GalViewCollection.html" title="GalViewCollection"><span class="type">GalViewCollection</span></a> *collection</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *title</code></em>,
<em class="parameter"><code><a class="link" href="GalView.html" title="GalView"><span class="type">GalView</span></a> *view</code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="gal-view-collection-set-nth-view"></a><h3>gal_view_collection_set_nth_view ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> * gal_view_collection_set_nth_view (<em class="parameter"><code><a class="link" href="GalViewCollection.html" title="GalViewCollection"><span class="type">GalViewCollection</span></a> *collection</code></em>,
<em class="parameter"><code><span class="type">gint</span> i</code></em>,
<em class="parameter"><code><a class="link" href="GalView.html" title="GalView"><span class="type">GalView</span></a> *view</code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="gal-view-collection-get-default-view"></a><h3>gal_view_collection_get_default_view ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> * gal_view_collection_get_default_view
(<em class="parameter"><code><a class="link" href="GalViewCollection.html" title="GalViewCollection"><span class="type">GalViewCollection</span></a> *collection</code></em>);</pre>
</div>
</div>
<div class="refsect1">
<a name="GalViewCollection.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="GalViewCollection--system-directory"></a><h3>The <code class="literal">"system-directory"</code> property</h3>
<pre class="programlisting"> "system-directory" <span class="type">gchar</span>* : Read / Write / Construct Only</pre>
<p>Directory from which to load built-in views.</p>
<p>Default value: NULL</p>
</div>
<hr>
<div class="refsect2">
<a name="GalViewCollection--user-directory"></a><h3>The <code class="literal">"user-directory"</code> property</h3>
<pre class="programlisting"> "user-directory" <span class="type">gchar</span>* : Read / Write / Construct Only</pre>
<p>Directory from which to load user-created views.</p>
<p>Default value: NULL</p>
</div>
</div>
<div class="refsect1">
<a name="GalViewCollection.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="GalViewCollection-changed"></a><h3>The <code class="literal">"changed"</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="GalViewCollection.html" title="GalViewCollection"><span class="type">GalViewCollection</span></a> *galviewcollection,
<span class="type">gpointer</span> user_data) : <code class="literal">Run Last</code></pre>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.19</div>
</body>
</html>
|