/usr/share/gtk-doc/html/libgwyddion/GwyResource.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 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 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 | <!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: GwyResource</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="GwyInventory.html" title="GwyInventory">
<link rel="next" href="GwyStringList.html" title="GwyStringList">
<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="#GwyResource.description" class="shortcut">Description</a>
|
<a href="#GwyResource.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#GwyResource.properties" class="shortcut">Properties</a>
|
<a href="#GwyResource.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="GwyInventory.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="GwyStringList.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="GwyResource"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GwyResource.top_of_page"></a>GwyResource</span></h2>
<p>GwyResource — Built-in and/or user supplied application resources</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="GwyResource.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include <libgwyddion/gwyddion.h>
struct <a class="link" href="GwyResource.html#GwyResource-struct" title="struct GwyResource">GwyResource</a>;
struct <a class="link" href="GwyResource.html#GwyResourceClass" title="struct GwyResourceClass">GwyResourceClass</a>;
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="GwyResource.html#gwy-resource-get-name" title="gwy_resource_get_name ()">gwy_resource_get_name</a> (<em class="parameter"><code><a class="link" href="GwyResource.html" title="GwyResource"><span class="type">GwyResource</span></a> *resource</code></em>);
<a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="GwyResource.html#gwy-resource-get-is-modifiable" title="gwy_resource_get_is_modifiable ()">gwy_resource_get_is_modifiable</a> (<em class="parameter"><code><a class="link" href="GwyResource.html" title="GwyResource"><span class="type">GwyResource</span></a> *resource</code></em>);
<a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="GwyResource.html#gwy-resource-get-is-preferred" title="gwy_resource_get_is_preferred ()">gwy_resource_get_is_preferred</a> (<em class="parameter"><code><a class="link" href="GwyResource.html" title="GwyResource"><span class="type">GwyResource</span></a> *resource</code></em>);
<span class="returnvalue">void</span> <a class="link" href="GwyResource.html#gwy-resource-set-is-preferred" title="gwy_resource_set_is_preferred ()">gwy_resource_set_is_preferred</a> (<em class="parameter"><code><a class="link" href="GwyResource.html" title="GwyResource"><span class="type">GwyResource</span></a> *resource</code></em>,
<em class="parameter"><code><a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> is_preferred</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="GwyResource.html#gwy-resource-class-get-name" title="gwy_resource_class_get_name ()">gwy_resource_class_get_name</a> (<em class="parameter"><code><a class="link" href="GwyResource.html#GwyResourceClass" title="struct GwyResourceClass"><span class="type">GwyResourceClass</span></a> *klass</code></em>);
<a class="link" href="GwyInventory.html" title="GwyInventory"><span class="returnvalue">GwyInventory</span></a> * <a class="link" href="GwyResource.html#gwy-resource-class-get-inventory" title="gwy_resource_class_get_inventory ()">gwy_resource_class_get_inventory</a> (<em class="parameter"><code><a class="link" href="GwyResource.html#GwyResourceClass" title="struct GwyResourceClass"><span class="type">GwyResourceClass</span></a> *klass</code></em>);
const <a class="link" href="GwyInventory.html#GwyInventoryItemType" title="struct GwyInventoryItemType"><span class="returnvalue">GwyInventoryItemType</span></a> * <a class="link" href="GwyResource.html#gwy-resource-class-get-item-type" title="gwy_resource_class_get_item_type ()">gwy_resource_class_get_item_type</a>
(<em class="parameter"><code><a class="link" href="GwyResource.html#GwyResourceClass" title="struct GwyResourceClass"><span class="type">GwyResourceClass</span></a> *klass</code></em>);
<span class="returnvalue">void</span> <a class="link" href="GwyResource.html#gwy-resource-use" title="gwy_resource_use ()">gwy_resource_use</a> (<em class="parameter"><code><a class="link" href="GwyResource.html" title="GwyResource"><span class="type">GwyResource</span></a> *resource</code></em>);
<span class="returnvalue">void</span> <a class="link" href="GwyResource.html#gwy-resource-release" title="gwy_resource_release ()">gwy_resource_release</a> (<em class="parameter"><code><a class="link" href="GwyResource.html" title="GwyResource"><span class="type">GwyResource</span></a> *resource</code></em>);
<a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="GwyResource.html#gwy-resource-is-used" title="gwy_resource_is_used ()">gwy_resource_is_used</a> (<em class="parameter"><code><a class="link" href="GwyResource.html" title="GwyResource"><span class="type">GwyResource</span></a> *resource</code></em>);
<span class="returnvalue">void</span> <a class="link" href="GwyResource.html#gwy-resource-data-changed" title="gwy_resource_data_changed ()">gwy_resource_data_changed</a> (<em class="parameter"><code><a class="link" href="GwyResource.html" title="GwyResource"><span class="type">GwyResource</span></a> *resource</code></em>);
<span class="returnvalue">void</span> <a class="link" href="GwyResource.html#gwy-resource-data-saved" title="gwy_resource_data_saved ()">gwy_resource_data_saved</a> (<em class="parameter"><code><a class="link" href="GwyResource.html" title="GwyResource"><span class="type">GwyResource</span></a> *resource</code></em>);
<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="GwyResource.html#gwy-resource-build-filename" title="gwy_resource_build_filename ()">gwy_resource_build_filename</a> (<em class="parameter"><code><a class="link" href="GwyResource.html" title="GwyResource"><span class="type">GwyResource</span></a> *resource</code></em>);
<a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Strings.html#GString"><span class="returnvalue">GString</span></a> * <a class="link" href="GwyResource.html#gwy-resource-dump" title="gwy_resource_dump ()">gwy_resource_dump</a> (<em class="parameter"><code><a class="link" href="GwyResource.html" title="GwyResource"><span class="type">GwyResource</span></a> *resource</code></em>);
<a class="link" href="GwyResource.html" title="GwyResource"><span class="returnvalue">GwyResource</span></a> * <a class="link" href="GwyResource.html#gwy-resource-parse" title="gwy_resource_parse ()">gwy_resource_parse</a> (<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> *text</code></em>,
<em class="parameter"><code><a href="http://developer.gnome.org/doc/API/2.0/gobject/gobject-Type-Information.html#GType"><span class="type">GType</span></a> expected_type</code></em>);
<span class="returnvalue">void</span> <a class="link" href="GwyResource.html#gwy-resource-class-load" title="gwy_resource_class_load ()">gwy_resource_class_load</a> (<em class="parameter"><code><a class="link" href="GwyResource.html#GwyResourceClass" title="struct GwyResourceClass"><span class="type">GwyResourceClass</span></a> *klass</code></em>);
<a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="GwyResource.html#gwy-resource-class-mkdir" title="gwy_resource_class_mkdir ()">gwy_resource_class_mkdir</a> (<em class="parameter"><code><a class="link" href="GwyResource.html#GwyResourceClass" title="struct GwyResourceClass"><span class="type">GwyResourceClass</span></a> *klass</code></em>);
<span class="returnvalue">void</span> <a class="link" href="GwyResource.html#gwy-resource-classes-finalize" title="gwy_resource_classes_finalize ()">gwy_resource_classes_finalize</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
</pre>
</div>
<div class="refsect1">
<a name="GwyResource.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>
+----GwyResource
+----<a class="link" href="GwyNLFitPreset.html" title="GwyNLFitPreset">GwyNLFitPreset</a>
</pre>
</div>
<div class="refsect1">
<a name="GwyResource.properties"></a><h2>Properties</h2>
<pre class="synopsis">
"<a class="link" href="GwyResource.html#GwyResource--is-const" title='The "is-const" property'>is-const</a>" <a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write / Construct Only
"<a class="link" href="GwyResource.html#GwyResource--is-preferred" title='The "is-preferred" property'>is-preferred</a>" <a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write
"<a class="link" href="GwyResource.html#GwyResource--name" title='The "name" property'>name</a>" <a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read
</pre>
</div>
<div class="refsect1">
<a name="GwyResource.signals"></a><h2>Signals</h2>
<pre class="synopsis">
"<a class="link" href="GwyResource.html#GwyResource-data-changed" title='The "data-changed" signal'>data-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="GwyResource.description"></a><h2>Description</h2>
<p>
<a class="link" href="GwyResource.html" title="GwyResource"><span class="type">GwyResource</span></a> is a base class for various application resources. It defines
common interface: questioning resource name (<a class="link" href="GwyResource.html#gwy-resource-get-name" title="gwy_resource_get_name ()"><code class="function">gwy_resource_get_name()</code></a>),
modifiability (<a class="link" href="GwyResource.html#gwy-resource-get-is-modifiable" title="gwy_resource_get_is_modifiable ()"><code class="function">gwy_resource_get_is_modifiable()</code></a>), loading resources from
files and saving them.
</p>
</div>
<div class="refsect1">
<a name="GwyResource.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="GwyResource-struct"></a><h3>struct GwyResource</h3>
<pre class="programlisting">struct GwyResource;</pre>
<p>
The <a class="link" href="GwyResource.html" title="GwyResource"><span class="type">GwyResource</span></a> struct contains private data only and should be accessed
using the functions below.
</p>
</div>
<hr>
<div class="refsect2">
<a name="GwyResourceClass"></a><h3>struct GwyResourceClass</h3>
<pre class="programlisting">struct GwyResourceClass {
GwyInventory *inventory;
const gchar *name;
/* Traits */
GwyInventoryItemType item_type;
/* Signals */
void (*data_changed)(GwyResource *resource);
/* Virtual table */
void (*use)(GwyResource *resource);
void (*release)(GwyResource *resource);
void (*dump)(GwyResource *resource,
GString *string);
GwyResource* (*parse)(const gchar *text,
gboolean is_const);
};
</pre>
<p>
Resource class.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><a class="link" href="GwyInventory.html" title="GwyInventory"><span class="type">GwyInventory</span></a> *<em class="structfield"><code><a name="GwyResourceClass.inventory"></a>inventory</code></em>;</span></p></td>
<td>Inventory with resources.</td>
</tr>
<tr>
<td><p><span class="term">const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *<em class="structfield"><code><a name="GwyResourceClass.name"></a>name</code></em>;</span></p></td>
<td>Resource class name, usable as resource directory name for on-disk
resources.</td>
</tr>
<tr>
<td><p><span class="term"><a class="link" href="GwyInventory.html#GwyInventoryItemType" title="struct GwyInventoryItemType"><span class="type">GwyInventoryItemType</span></a> <em class="structfield"><code><a name="GwyResourceClass.item-type"></a>item_type</code></em>;</span></p></td>
<td>Inventory item type. Most fields are pre-filled, but namely
<em class="parameter"><code>type</code></em> and <em class="parameter"><code>copy</code></em> must be filled by particular resource type.</td>
</tr>
<tr>
<td><p><span class="term"><em class="structfield"><code><a name="GwyResourceClass.data-changed"></a>data_changed</code></em> ()</span></p></td>
<td>"data-changed" signal method.</td>
</tr>
<tr>
<td><p><span class="term"><em class="structfield"><code><a name="GwyResourceClass.use"></a>use</code></em> ()</span></p></td>
<td>gwy_resource_use() virtual method.</td>
</tr>
<tr>
<td><p><span class="term"><em class="structfield"><code><a name="GwyResourceClass.release"></a>release</code></em> ()</span></p></td>
<td>gwy_resource_release() virtual method.</td>
</tr>
<tr>
<td><p><span class="term"><em class="structfield"><code><a name="GwyResourceClass.dump"></a>dump</code></em> ()</span></p></td>
<td>gwy_resource_dump() virtual method, it only cares about resource
data itself, the envelope is handled by <a class="link" href="GwyResource.html" title="GwyResource"><span class="type">GwyResource</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="structfield"><code><a name="GwyResourceClass.parse"></a>parse</code></em> ()</span></p></td>
<td>gwy_resource_parse() virtual method, in only cares about resource
data itself, the envelope is handled by <a class="link" href="GwyResource.html" title="GwyResource"><span class="type">GwyResource</span></a>.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-resource-get-name"></a><h3>gwy_resource_get_name ()</h3>
<pre class="programlisting">const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * gwy_resource_get_name (<em class="parameter"><code><a class="link" href="GwyResource.html" title="GwyResource"><span class="type">GwyResource</span></a> *resource</code></em>);</pre>
<p>
Returns resource name.
</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>resource</code></em> :</span></p></td>
<td>A resource.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>Name of <em class="parameter"><code>resource</code></em>. The string is owned by <em class="parameter"><code>resource</code></em> and must not
be modfied or freed.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-resource-get-is-modifiable"></a><h3>gwy_resource_get_is_modifiable ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gwy_resource_get_is_modifiable (<em class="parameter"><code><a class="link" href="GwyResource.html" title="GwyResource"><span class="type">GwyResource</span></a> *resource</code></em>);</pre>
<p>
Returns whether a resource is modifiable.
</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>resource</code></em> :</span></p></td>
<td>A resource.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if resource is modifiable, <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if it's fixed (system)
resource.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-resource-get-is-preferred"></a><h3>gwy_resource_get_is_preferred ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gwy_resource_get_is_preferred (<em class="parameter"><code><a class="link" href="GwyResource.html" title="GwyResource"><span class="type">GwyResource</span></a> *resource</code></em>);</pre>
<p>
Returns whether a resource is preferred.
</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>resource</code></em> :</span></p></td>
<td>A resource.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if resource is preferred, <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-resource-set-is-preferred"></a><h3>gwy_resource_set_is_preferred ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gwy_resource_set_is_preferred (<em class="parameter"><code><a class="link" href="GwyResource.html" title="GwyResource"><span class="type">GwyResource</span></a> *resource</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> is_preferred</code></em>);</pre>
<p>
Sets preferability of a resource.
</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>resource</code></em> :</span></p></td>
<td>A resource.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>is_preferred</code></em> :</span></p></td>
<td>
<a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> to make <em class="parameter"><code>resource</code></em> preferred, <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> to make it not
preferred.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-resource-class-get-name"></a><h3>gwy_resource_class_get_name ()</h3>
<pre class="programlisting">const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * gwy_resource_class_get_name (<em class="parameter"><code><a class="link" href="GwyResource.html#GwyResourceClass" title="struct GwyResourceClass"><span class="type">GwyResourceClass</span></a> *klass</code></em>);</pre>
<p>
Gets the name of resource class.
</p>
<p>
This is an simple identifier usable for example as directory name.
</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>klass</code></em> :</span></p></td>
<td>A resource class.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>Resource class name, as a constant string that must not be modified
nor freed.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-resource-class-get-inventory"></a><h3>gwy_resource_class_get_inventory ()</h3>
<pre class="programlisting"><a class="link" href="GwyInventory.html" title="GwyInventory"><span class="returnvalue">GwyInventory</span></a> * gwy_resource_class_get_inventory (<em class="parameter"><code><a class="link" href="GwyResource.html#GwyResourceClass" title="struct GwyResourceClass"><span class="type">GwyResourceClass</span></a> *klass</code></em>);</pre>
<p>
Gets inventory which holds resources of a resource class.
</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>klass</code></em> :</span></p></td>
<td>A resource class.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>Resource class inventory.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-resource-class-get-item-type"></a><h3>gwy_resource_class_get_item_type ()</h3>
<pre class="programlisting">const <a class="link" href="GwyInventory.html#GwyInventoryItemType" title="struct GwyInventoryItemType"><span class="returnvalue">GwyInventoryItemType</span></a> * gwy_resource_class_get_item_type
(<em class="parameter"><code><a class="link" href="GwyResource.html#GwyResourceClass" title="struct GwyResourceClass"><span class="type">GwyResourceClass</span></a> *klass</code></em>);</pre>
<p>
Gets inventory item type for a resource class.
</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>klass</code></em> :</span></p></td>
<td>A resource class.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>Inventory item type.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-resource-use"></a><h3>gwy_resource_use ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gwy_resource_use (<em class="parameter"><code><a class="link" href="GwyResource.html" title="GwyResource"><span class="type">GwyResource</span></a> *resource</code></em>);</pre>
<p>
Starts using a resource.
</p>
<p>
Call to this function is necessary to use a resource properly.
It makes the resource to create any auxiliary structures that consume
considerable amount of memory and perform other initialization to
ready-to-use form.
</p>
<p>
When a resource is no longer used, it should be released with
<a class="link" href="GwyResource.html#gwy-resource-release" title="gwy_resource_release ()"><code class="function">gwy_resource_release()</code></a>.
</p>
<p>
In addition, it calls <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#g-object-ref"><code class="function">g_object_ref()</code></a> on the resource.
</p>
<p>
Resources usually exist through almost whole program lifetime from
<a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> perspective, but from the viewpoint of use this method is the
constructor and <a class="link" href="GwyResource.html#gwy-resource-release" title="gwy_resource_release ()"><code class="function">gwy_resource_release()</code></a> is the destructor.
</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>resource</code></em> :</span></p></td>
<td>A resource.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-resource-release"></a><h3>gwy_resource_release ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gwy_resource_release (<em class="parameter"><code><a class="link" href="GwyResource.html" title="GwyResource"><span class="type">GwyResource</span></a> *resource</code></em>);</pre>
<p>
Releases a resource.
</p>
<p>
When the number of resource uses drops to zero, it frees all auxiliary data
and returns back to `latent' form. In addition, it calls <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a>
on it. See <a class="link" href="GwyResource.html#gwy-resource-use" title="gwy_resource_use ()"><code class="function">gwy_resource_use()</code></a> for more.
</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>resource</code></em> :</span></p></td>
<td>A resource.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-resource-is-used"></a><h3>gwy_resource_is_used ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gwy_resource_is_used (<em class="parameter"><code><a class="link" href="GwyResource.html" title="GwyResource"><span class="type">GwyResource</span></a> *resource</code></em>);</pre>
<p>
Tells whether a resource is currently in use.
</p>
<p>
See <a class="link" href="GwyResource.html#gwy-resource-use" title="gwy_resource_use ()"><code class="function">gwy_resource_use()</code></a> for details.
</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>resource</code></em> :</span></p></td>
<td>A resource.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if resource is in use, <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-resource-data-changed"></a><h3>gwy_resource_data_changed ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gwy_resource_data_changed (<em class="parameter"><code><a class="link" href="GwyResource.html" title="GwyResource"><span class="type">GwyResource</span></a> *resource</code></em>);</pre>
<p>
Emits signal "data-changed" on a resource.
</p>
<p>
It can be called only on non-constant resources. The default handler
sets <em class="parameter"><code>is_modified</code></em> flag on the resource.
</p>
<p>
Mostly useful in resource implementation.
</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>resource</code></em> :</span></p></td>
<td>A resource.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-resource-data-saved"></a><h3>gwy_resource_data_saved ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gwy_resource_data_saved (<em class="parameter"><code><a class="link" href="GwyResource.html" title="GwyResource"><span class="type">GwyResource</span></a> *resource</code></em>);</pre>
<p>
Clears <em class="parameter"><code>is_modified</code></em> flag of a resource.
</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>resource</code></em> :</span></p></td>
<td>A resource.</td>
</tr></tbody>
</table></div>
<p class="since">Since 2.8</p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-resource-build-filename"></a><h3>gwy_resource_build_filename ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * gwy_resource_build_filename (<em class="parameter"><code><a class="link" href="GwyResource.html" title="GwyResource"><span class="type">GwyResource</span></a> *resource</code></em>);</pre>
<p>
Builds file name a resource should be saved to.
</p>
<p>
If the resource has not been newly created, renamed, or system it was
probably loaded from file of the same name.
</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>resource</code></em> :</span></p></td>
<td>A resource.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>Resource file name as a newly allocated string that must be freed
by caller.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-resource-dump"></a><h3>gwy_resource_dump ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Strings.html#GString"><span class="returnvalue">GString</span></a> * gwy_resource_dump (<em class="parameter"><code><a class="link" href="GwyResource.html" title="GwyResource"><span class="type">GwyResource</span></a> *resource</code></em>);</pre>
<p>
Dumps a resource to a textual (human readable) form.
</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>resource</code></em> :</span></p></td>
<td>A resource.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>Textual resource representation.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-resource-parse"></a><h3>gwy_resource_parse ()</h3>
<pre class="programlisting"><a class="link" href="GwyResource.html" title="GwyResource"><span class="returnvalue">GwyResource</span></a> * gwy_resource_parse (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *text</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#GType"><span class="type">GType</span></a> expected_type</code></em>);</pre>
<p>
Reconstructs a resource from human readable form.
</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>text</code></em> :</span></p></td>
<td>Textual resource representation.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>expected_type</code></em> :</span></p></td>
<td>Resource object type. If not 0, only resources of give type
are allowed. Zero value means any <a class="link" href="GwyResource.html" title="GwyResource"><span class="type">GwyResource</span></a> is allowed.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>Newly created resource (or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>).</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-resource-class-load"></a><h3>gwy_resource_class_load ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gwy_resource_class_load (<em class="parameter"><code><a class="link" href="GwyResource.html#GwyResourceClass" title="struct GwyResourceClass"><span class="type">GwyResourceClass</span></a> *klass</code></em>);</pre>
<p>
Loads resources of a resources class from disk.
</p>
<p>
Resources are loaded from system directory (and marked constant) and from
user directory (marked modifiable).
</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>klass</code></em> :</span></p></td>
<td>A resource class.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-resource-class-mkdir"></a><h3>gwy_resource_class_mkdir ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gwy_resource_class_mkdir (<em class="parameter"><code><a class="link" href="GwyResource.html#GwyResourceClass" title="struct GwyResourceClass"><span class="type">GwyResourceClass</span></a> *klass</code></em>);</pre>
<p>
Creates directory for user resources if it does not exist.
</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>klass</code></em> :</span></p></td>
<td>A resource class.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the directory exists or has been successfully created.
<a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if it doesn't exist and cannot be created, consult errno
for reason.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-resource-classes-finalize"></a><h3>gwy_resource_classes_finalize ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gwy_resource_classes_finalize (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Destroys the inventories of all resource classes.
</p>
<p>
This function makes the affected resource classes unusable. Its purpose is
to faciliate reference leak debugging by destroying a large number of
objects that normally live forever.
</p>
<p>
Note static resource classes that never called <a class="link" href="GwyResource.html#gwy-resource-class-load" title="gwy_resource_class_load ()"><code class="function">gwy_resource_class_load()</code></a>
are excluded.
</p>
<p class="since">Since 2.8</p>
</div>
</div>
<div class="refsect1">
<a name="GwyResource.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="GwyResource--is-const"></a><h3>The <code class="literal">"is-const"</code> property</h3>
<pre class="programlisting"> "is-const" <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write / Construct Only</pre>
<p>Whether a resource is constant (system).</p>
<p>Default value: FALSE</p>
</div>
<hr>
<div class="refsect2">
<a name="GwyResource--is-preferred"></a><h3>The <code class="literal">"is-preferred"</code> property</h3>
<pre class="programlisting"> "is-preferred" <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write</pre>
<p>Whether a resource is preferred.</p>
<p>Default value: FALSE</p>
</div>
<hr>
<div class="refsect2">
<a name="GwyResource--name"></a><h3>The <code class="literal">"name"</code> property</h3>
<pre class="programlisting"> "name" <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read</pre>
<p>Resource name.</p>
<p>Default value: NULL</p>
</div>
</div>
<div class="refsect1">
<a name="GwyResource.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="GwyResource-data-changed"></a><h3>The <code class="literal">"data-changed"</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="GwyResource.html" title="GwyResource"><span class="type">GwyResource</span></a> *gwyresource,
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data) : <a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS"><code class="literal">Run First</code></a></pre>
<p>
The ::data-changed signal is emitted when resource data 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>gwyresource</code></em> :</span></p></td>
<td>The <a class="link" href="GwyResource.html" title="GwyResource"><span class="type">GwyResource</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 class="refsect1">
<a name="GwyResource.see-also"></a><h2>See Also</h2>
<a class="link" href="GwyInventory.html" title="GwyInventory"><span class="type">GwyInventory</span></a>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.19</div>
</body>
</html>
|