/usr/share/gtk-doc/html/nautilus-actions-3/NAIDuplicable.html is in nautilus-actions 3.2.3-1build3.
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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>NAIDuplicable</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="Nautilus-Actions™ Reference Manual">
<link rel="up" href="ch06.html" title="NAObject Hierarchy">
<link rel="prev" href="NAObjectMenu.html" title="NAObjectMenu">
<link rel="next" href="NAIContext.html" title="NAIContext">
<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="NAObjectMenu.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch06.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">
<span class="productname">Nautilus-Actions</span>™ Reference Manual</th>
<td><a accesskey="n" href="NAIContext.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#NAIDuplicable.synopsis" class="shortcut">Top</a>
|
<a href="#NAIDuplicable.description" class="shortcut">Description</a>
|
<a href="#NAIDuplicable.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#NAIDuplicable.prerequisites" class="shortcut">Prerequisites</a>
|
<a href="#NAIDuplicable.implementations" class="shortcut">Known Implementations</a>
</td></tr>
</table>
<div class="refentry">
<a name="NAIDuplicable"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="NAIDuplicable.top_of_page"></a>NAIDuplicable</span></h2>
<p>NAIDuplicable — The Duplication Interface</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="NAIDuplicable.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include <nautilus-actions/private/na-iduplicable.h>
#define <a class="link" href="NAIDuplicable.html#NA-TYPE-IDUPLICABLE:CAPS" title="NA_TYPE_IDUPLICABLE">NA_TYPE_IDUPLICABLE</a>
#define <a class="link" href="NAIDuplicable.html#NA-IDUPLICABLE:CAPS" title="NA_IDUPLICABLE()">NA_IDUPLICABLE</a> (instance)
#define <a class="link" href="NAIDuplicable.html#NA-IS-IDUPLICABLE:CAPS" title="NA_IS_IDUPLICABLE()">NA_IS_IDUPLICABLE</a> (instance)
#define <a class="link" href="NAIDuplicable.html#NA-IDUPLICABLE-GET-INTERFACE:CAPS" title="NA_IDUPLICABLE_GET_INTERFACE()">NA_IDUPLICABLE_GET_INTERFACE</a> (instance)
<a class="link" href="NAIDuplicable.html#NAIDuplicable-struct" title="NAIDuplicable">NAIDuplicable</a>;
<a class="link" href="NAIDuplicable.html#NAIDuplicableInterface" title="NAIDuplicableInterface">NAIDuplicableInterface</a>;
#define <a class="link" href="NAIDuplicable.html#IDUPLICABLE-SIGNAL-MODIFIED-CHANGED:CAPS" title="IDUPLICABLE_SIGNAL_MODIFIED_CHANGED">IDUPLICABLE_SIGNAL_MODIFIED_CHANGED</a>
#define <a class="link" href="NAIDuplicable.html#IDUPLICABLE-SIGNAL-VALID-CHANGED:CAPS" title="IDUPLICABLE_SIGNAL_VALID_CHANGED">IDUPLICABLE_SIGNAL_VALID_CHANGED</a>
<span class="returnvalue">void</span> <a class="link" href="NAIDuplicable.html#na-iduplicable-dispose" title="na_iduplicable_dispose ()">na_iduplicable_dispose</a> (<em class="parameter"><code>const <a class="link" href="NAIDuplicable.html" title="NAIDuplicable"><span class="type">NAIDuplicable</span></a> *object</code></em>);
<span class="returnvalue">void</span> <a class="link" href="NAIDuplicable.html#na-iduplicable-dump" title="na_iduplicable_dump ()">na_iduplicable_dump</a> (<em class="parameter"><code>const <a class="link" href="NAIDuplicable.html" title="NAIDuplicable"><span class="type">NAIDuplicable</span></a> *object</code></em>);
<a class="link" href="NAIDuplicable.html" title="NAIDuplicable"><span class="returnvalue">NAIDuplicable</span></a> * <a class="link" href="NAIDuplicable.html#na-iduplicable-duplicate" title="na_iduplicable_duplicate ()">na_iduplicable_duplicate</a> (<em class="parameter"><code>const <a class="link" href="NAIDuplicable.html" title="NAIDuplicable"><span class="type">NAIDuplicable</span></a> *object</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> mode</code></em>);
<span class="returnvalue">void</span> <a class="link" href="NAIDuplicable.html#na-iduplicable-check-status" title="na_iduplicable_check_status ()">na_iduplicable_check_status</a> (<em class="parameter"><code>const <a class="link" href="NAIDuplicable.html" title="NAIDuplicable"><span class="type">NAIDuplicable</span></a> *object</code></em>);
<a class="link" href="NAIDuplicable.html" title="NAIDuplicable"><span class="returnvalue">NAIDuplicable</span></a> * <a class="link" href="NAIDuplicable.html#na-iduplicable-get-origin" title="na_iduplicable_get_origin ()">na_iduplicable_get_origin</a> (<em class="parameter"><code>const <a class="link" href="NAIDuplicable.html" title="NAIDuplicable"><span class="type">NAIDuplicable</span></a> *object</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="NAIDuplicable.html#na-iduplicable-is-valid" title="na_iduplicable_is_valid ()">na_iduplicable_is_valid</a> (<em class="parameter"><code>const <a class="link" href="NAIDuplicable.html" title="NAIDuplicable"><span class="type">NAIDuplicable</span></a> *object</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="NAIDuplicable.html#na-iduplicable-is-modified" title="na_iduplicable_is_modified ()">na_iduplicable_is_modified</a> (<em class="parameter"><code>const <a class="link" href="NAIDuplicable.html" title="NAIDuplicable"><span class="type">NAIDuplicable</span></a> *object</code></em>);
<span class="returnvalue">void</span> <a class="link" href="NAIDuplicable.html#na-iduplicable-set-origin" title="na_iduplicable_set_origin ()">na_iduplicable_set_origin</a> (<em class="parameter"><code><a class="link" href="NAIDuplicable.html" title="NAIDuplicable"><span class="type">NAIDuplicable</span></a> *object</code></em>,
<em class="parameter"><code>const <a class="link" href="NAIDuplicable.html" title="NAIDuplicable"><span class="type">NAIDuplicable</span></a> *origin</code></em>);
<span class="returnvalue">void</span> <a class="link" href="NAIDuplicable.html#na-iduplicable-set-modified" title="na_iduplicable_set_modified ()">na_iduplicable_set_modified</a> (<em class="parameter"><code><a class="link" href="NAIDuplicable.html" title="NAIDuplicable"><span class="type">NAIDuplicable</span></a> *object</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> modified</code></em>);
<span class="returnvalue">void</span> <a class="link" href="NAIDuplicable.html#na-iduplicable-register-consumer" title="na_iduplicable_register_consumer ()">na_iduplicable_register_consumer</a> (<em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> *consumer</code></em>);
enum <a class="link" href="NAIDuplicable.html#DuplicableMode" title="enum DuplicableMode">DuplicableMode</a>;
</pre>
</div>
<div class="refsect1">
<a name="NAIDuplicable.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
GInterface
+----NAIDuplicable
</pre>
</div>
<div class="refsect1">
<a name="NAIDuplicable.prerequisites"></a><h2>Prerequisites</h2>
<p>
NAIDuplicable requires
<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>.</p>
</div>
<div class="refsect1">
<a name="NAIDuplicable.implementations"></a><h2>Known Implementations</h2>
<p>
NAIDuplicable is implemented by
<a class="link" href="NAObject.html" title="NAObject">NAObject</a>, <a class="link" href="NAObjectAction.html" title="NAObjectAction">NAObjectAction</a>, <a class="link" href="NAObjectId.html" title="NAObjectId">NAObjectId</a>, <a class="link" href="NAObjectItem.html" title="NAObjectItem">NAObjectItem</a>, <a class="link" href="NAObjectMenu.html" title="NAObjectMenu">NAObjectMenu</a> and <a class="link" href="NAObjectProfile.html" title="NAObjectProfile">NAObjectProfile</a>.</p>
</div>
<div class="refsect1">
<a name="NAIDuplicable.description"></a><h2>Description</h2>
<p>
This interface is implemented by <a class="link" href="NAObject.html" title="NAObject"><span class="type">NAObject</span></a> in order to let
<a class="link" href="NAObject.html" title="NAObject"><span class="type">NAObject</span></a> -derived instance duplication be easily tracked. This works
by keeping a pointer on the original object at duplication time, and
then only checking edition status when explicitely required.
</p>
<p>
As the reference count of the original object is not incremented
here, the caller has to garantee itself that the original object
will stay in life at least as long as the duplicated one.
</p>
<p>
</p>
<div class="refsect2">
<a name="id-1.7.8.7.4.1"></a><h3>
Modification status in Nautilus-Actions configuration tool
</h3>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem"><p>
Objects whose origin is NULL are considered as modified ; this is
in particular the case of new, pasted, imported and dropped
objects.
</p></li>
<li class="listitem"><p>
when a new object, whether is is really new or it has been pasted,
imported or dropped, is inserted somewhere in the tree, its
immediate parent is also marked as modified.
</p></li>
<li class="listitem"><p>
Check for edition status, which positions modification and validity
status, is not recursive ; it is the responsability of the
implementation to check for edition status of children of object..
</p></li>
</ul></div>
</div>
<p>
</p>
<p>
</p>
<div class="refsect2">
<a name="id-1.7.8.7.5.1"></a><h3>Versions historic</h3>
<div class="table">
<a name="id-1.7.8.7.5.1.2"></a><p class="title"><b>Table 10. Historic of the versions of the <a class="link" href="NAIDuplicable.html" title="NAIDuplicable"><span class="type">NAIDuplicable</span></a> interface</b></p>
<div class="table-contents"><table summary="Historic of the versions of the NAIDuplicable interface" border="1">
<colgroup>
<col align="center" class="na-version">
<col align="center" class="api-version">
<col align="center" class="current">
</colgroup>
<thead><tr>
<th align="center">
<span class="productname">Nautilus-Actions</span>™ version</th>
<th align="center">
<a class="link" href="NAIDuplicable.html" title="NAIDuplicable"><span class="type">NAIDuplicable</span></a> interface version</th>
<th align="center"> </th>
</tr></thead>
<tbody><tr>
<td align="center">since 2.30</td>
<td align="center">1</td>
<td align="center">current version</td>
</tr></tbody>
</table></div>
</div>
<br class="table-break">
</div>
<p>
</p>
</div>
<div class="refsect1">
<a name="NAIDuplicable.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="NA-TYPE-IDUPLICABLE:CAPS"></a><h3>NA_TYPE_IDUPLICABLE</h3>
<pre class="programlisting">#define NA_TYPE_IDUPLICABLE ( na_iduplicable_get_type())
</pre>
</div>
<hr>
<div class="refsect2">
<a name="NA-IDUPLICABLE:CAPS"></a><h3>NA_IDUPLICABLE()</h3>
<pre class="programlisting">#define NA_IDUPLICABLE( instance ) ( G_TYPE_CHECK_INSTANCE_CAST( instance, NA_TYPE_IDUPLICABLE, NAIDuplicable ))
</pre>
</div>
<hr>
<div class="refsect2">
<a name="NA-IS-IDUPLICABLE:CAPS"></a><h3>NA_IS_IDUPLICABLE()</h3>
<pre class="programlisting">#define NA_IS_IDUPLICABLE( instance ) ( G_TYPE_CHECK_INSTANCE_TYPE( instance, NA_TYPE_IDUPLICABLE ))
</pre>
</div>
<hr>
<div class="refsect2">
<a name="NA-IDUPLICABLE-GET-INTERFACE:CAPS"></a><h3>NA_IDUPLICABLE_GET_INTERFACE()</h3>
<pre class="programlisting">#define NA_IDUPLICABLE_GET_INTERFACE( instance ) ( G_TYPE_INSTANCE_GET_INTERFACE(( instance ), NA_TYPE_IDUPLICABLE, NAIDuplicableInterface ))
</pre>
</div>
<hr>
<div class="refsect2">
<a name="NAIDuplicable-struct"></a><h3>NAIDuplicable</h3>
<pre class="programlisting">typedef struct _NAIDuplicable NAIDuplicable;</pre>
</div>
<hr>
<div class="refsect2">
<a name="NAIDuplicableInterface"></a><h3>NAIDuplicableInterface</h3>
<pre class="programlisting">typedef struct {
/**
* copy:
* @target: the #NAIDuplicable target of the copy.
* @source: the #NAIDuplicable source of the copy.
* @mode: the duplication mode.
*
* Copies data from @source to @ŧarget, so that @target becomes an
* exact copy of @source.
*
* Each derived class of the implementation should define this
* function to copy its own data. The implementation should take
* care itself of calling each function in the class hierarchy,
* from topmost base class to most-derived one.
*
* Since: 2.30
*/
void ( *copy ) ( NAIDuplicable *target, const NAIDuplicable *source, guint mode );
/**
* are_equal:
* @a: a first #NAIDuplicable object.
* @b: a second #NAIDuplicable object to be compared to the first
* one.
*
* Compares the two objects.
*
* Each derived class of the implementation should define this
* function to compare its own data. The implementation should take
* care itself of calling each function in the class hierarchy,
* from topmost base class to most-derived one.
*
* When testing for the modification status of an object, @a stands for
* the original object, while @b stands for the duplicated one.
*
* Returns: TRUE if @a and @b are identical, FALSE else.
*
* Since: 2.30
*/
gboolean ( *are_equal ) ( const NAIDuplicable *a, const NAIDuplicable *b );
/**
* is_valid:
* @object: the NAIDuplicable object to be checked.
*
* Checks @object for validity.
*
* Each derived class of the implementation should define this
* function to compare its own data. The implementation should take
* care itself of calling each function in the class hierarchy,
* from topmost base class to most-derived one.
*
* Returns: TRUE if @object is valid, FALSE else.
*
* Since: 2.30
*/
gboolean ( *is_valid ) ( const NAIDuplicable *object );
} NAIDuplicableInterface;
</pre>
<p>
This interface is implemented by <a class="link" href="NAObject.html" title="NAObject"><span class="type">NAObject</span></a> objects, in order to be able
to keep the trace of all duplicated objects.
</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="structfield"><code><a name="NAIDuplicableInterface.copy"></a>copy</code></em> ()</span></p></td>
<td>copies one object to another.</td>
</tr>
<tr>
<td><p><span class="term"><em class="structfield"><code><a name="NAIDuplicableInterface.are-equal"></a>are_equal</code></em> ()</span></p></td>
<td>tests if two objects are equals.</td>
</tr>
<tr>
<td><p><span class="term"><em class="structfield"><code><a name="NAIDuplicableInterface.is-valid"></a>is_valid</code></em> ()</span></p></td>
<td>tests if one object is valid.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="IDUPLICABLE-SIGNAL-MODIFIED-CHANGED:CAPS"></a><h3>IDUPLICABLE_SIGNAL_MODIFIED_CHANGED</h3>
<pre class="programlisting">#define IDUPLICABLE_SIGNAL_MODIFIED_CHANGED "iduplicable-modified-changed"
</pre>
</div>
<hr>
<div class="refsect2">
<a name="IDUPLICABLE-SIGNAL-VALID-CHANGED:CAPS"></a><h3>IDUPLICABLE_SIGNAL_VALID_CHANGED</h3>
<pre class="programlisting">#define IDUPLICABLE_SIGNAL_VALID_CHANGED "iduplicable-valid-changed"
</pre>
</div>
<hr>
<div class="refsect2">
<a name="na-iduplicable-dispose"></a><h3>na_iduplicable_dispose ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> na_iduplicable_dispose (<em class="parameter"><code>const <a class="link" href="NAIDuplicable.html" title="NAIDuplicable"><span class="type">NAIDuplicable</span></a> *object</code></em>);</pre>
<p>
Releases resources.
</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>object</code></em> :</span></p></td>
<td>the <a class="link" href="NAIDuplicable.html" title="NAIDuplicable"><span class="type">NAIDuplicable</span></a> object to be initialized.</td>
</tr></tbody>
</table></div>
<p class="since">Since 2.30</p>
</div>
<hr>
<div class="refsect2">
<a name="na-iduplicable-dump"></a><h3>na_iduplicable_dump ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> na_iduplicable_dump (<em class="parameter"><code>const <a class="link" href="NAIDuplicable.html" title="NAIDuplicable"><span class="type">NAIDuplicable</span></a> *object</code></em>);</pre>
<p>
Dumps via g_debug the properties of the object.
</p>
<p>
We ouput here only the data we set ourselves againt the
<a class="link" href="NAIDuplicable.html" title="NAIDuplicable"><span class="type">NAIDuplicable</span></a> -implemented object.
</p>
<p>
This function should be called by the implementation when it dumps
itself its own content.
</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>object</code></em> :</span></p></td>
<td>the <a class="link" href="NAIDuplicable.html" title="NAIDuplicable"><span class="type">NAIDuplicable</span></a> object to be dumped.</td>
</tr></tbody>
</table></div>
<p class="since">Since 2.30</p>
</div>
<hr>
<div class="refsect2">
<a name="na-iduplicable-duplicate"></a><h3>na_iduplicable_duplicate ()</h3>
<pre class="programlisting"><a class="link" href="NAIDuplicable.html" title="NAIDuplicable"><span class="returnvalue">NAIDuplicable</span></a> * na_iduplicable_duplicate (<em class="parameter"><code>const <a class="link" href="NAIDuplicable.html" title="NAIDuplicable"><span class="type">NAIDuplicable</span></a> *object</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> mode</code></em>);</pre>
<p>
Exactly duplicates a <a class="link" href="NAIDuplicable.html" title="NAIDuplicable"><span class="type">NAIDuplicable</span></a> -implemented object, including
modification and validity status which are copied from <em class="parameter"><code>object</code></em> to
the duplicated one.
</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>object</code></em> :</span></p></td>
<td>the <a class="link" href="NAIDuplicable.html" title="NAIDuplicable"><span class="type">NAIDuplicable</span></a> object to be duplicated.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>mode</code></em> :</span></p></td>
<td>the <a class="link" href="NAIDuplicable.html#DuplicableMode" title="enum DuplicableMode"><code class="literal">DuplicableMode</code></a> duplication mode.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a new <a class="link" href="NAIDuplicable.html" title="NAIDuplicable"><span class="type">NAIDuplicable</span></a>.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.30</p>
</div>
<hr>
<div class="refsect2">
<a name="na-iduplicable-check-status"></a><h3>na_iduplicable_check_status ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> na_iduplicable_check_status (<em class="parameter"><code>const <a class="link" href="NAIDuplicable.html" title="NAIDuplicable"><span class="type">NAIDuplicable</span></a> *object</code></em>);</pre>
<p>
Checks the edition status of the <a class="link" href="NAIDuplicable.html" title="NAIDuplicable"><span class="type">NAIDuplicable</span></a> object, and set up
the corresponding properties.
</p>
<p>
This function is supposed to be called each time the object may have
been modified in order to set the corresponding properties. Helper
functions <a class="link" href="NAIDuplicable.html#na-iduplicable-is-modified" title="na_iduplicable_is_modified ()"><code class="function">na_iduplicable_is_modified()</code></a> and <a class="link" href="NAIDuplicable.html#na-iduplicable-is-valid" title="na_iduplicable_is_valid ()"><code class="function">na_iduplicable_is_valid()</code></a>
will then only return the current value of the properties.
</p>
<p>
<a class="link" href="NAIDuplicable.html#na-iduplicable-check-status" title="na_iduplicable_check_status ()"><code class="function">na_iduplicable_check_status()</code></a> is not, as itself, recursive.
That is, the modification and validity status are only set on the
specified object.
<a class="link" href="NAObject.html" title="NAObject"><span class="type">NAObject</span></a> implementation has chosen to handle itself the recursivity:
<a class="link" href="nautilus-actions-API.html#na-object-check-status" title="na_object_check_status()"><code class="function">na_object_check_status()</code></a> so first check status for children, before
calling this function.
</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>object</code></em> :</span></p></td>
<td>the <a class="link" href="NAIDuplicable.html" title="NAIDuplicable"><span class="type">NAIDuplicable</span></a> object to be checked.</td>
</tr></tbody>
</table></div>
<p class="since">Since 2.30</p>
</div>
<hr>
<div class="refsect2">
<a name="na-iduplicable-get-origin"></a><h3>na_iduplicable_get_origin ()</h3>
<pre class="programlisting"><a class="link" href="NAIDuplicable.html" title="NAIDuplicable"><span class="returnvalue">NAIDuplicable</span></a> * na_iduplicable_get_origin (<em class="parameter"><code>const <a class="link" href="NAIDuplicable.html" title="NAIDuplicable"><span class="type">NAIDuplicable</span></a> *object</code></em>);</pre>
<p>
Returns the origin of a duplicated <a class="link" href="NAIDuplicable.html" title="NAIDuplicable"><span class="type">NAIDuplicable</span></a>.
</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>object</code></em> :</span></p></td>
<td>the <a class="link" href="NAIDuplicable.html" title="NAIDuplicable"><span class="type">NAIDuplicable</span></a> object whose origin is to be returned.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the original <a class="link" href="NAIDuplicable.html" title="NAIDuplicable"><span class="type">NAIDuplicable</span></a>, or NULL.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.30</p>
</div>
<hr>
<div class="refsect2">
<a name="na-iduplicable-is-valid"></a><h3>na_iduplicable_is_valid ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> na_iduplicable_is_valid (<em class="parameter"><code>const <a class="link" href="NAIDuplicable.html" title="NAIDuplicable"><span class="type">NAIDuplicable</span></a> *object</code></em>);</pre>
<p>
Returns the current value of the relevant property
without rechecking the edition status itself.
</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>object</code></em> :</span></p></td>
<td>the <a class="link" href="NAIDuplicable.html" title="NAIDuplicable"><span class="type">NAIDuplicable</span></a> object whose status is to be returned.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> is the provided object is valid.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.30</p>
</div>
<hr>
<div class="refsect2">
<a name="na-iduplicable-is-modified"></a><h3>na_iduplicable_is_modified ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> na_iduplicable_is_modified (<em class="parameter"><code>const <a class="link" href="NAIDuplicable.html" title="NAIDuplicable"><span class="type">NAIDuplicable</span></a> *object</code></em>);</pre>
<p>
Returns the current value of the 'is_modified'
property without rechecking the edition status itself.
</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>object</code></em> :</span></p></td>
<td>the <a class="link" href="NAIDuplicable.html" title="NAIDuplicable"><span class="type">NAIDuplicable</span></a> object whose status is to be returned.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> is the provided object has been modified regarding of
the original one.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.30</p>
</div>
<hr>
<div class="refsect2">
<a name="na-iduplicable-set-origin"></a><h3>na_iduplicable_set_origin ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> na_iduplicable_set_origin (<em class="parameter"><code><a class="link" href="NAIDuplicable.html" title="NAIDuplicable"><span class="type">NAIDuplicable</span></a> *object</code></em>,
<em class="parameter"><code>const <a class="link" href="NAIDuplicable.html" title="NAIDuplicable"><span class="type">NAIDuplicable</span></a> *origin</code></em>);</pre>
<p>
Sets the new origin of a duplicated <a class="link" href="NAIDuplicable.html" title="NAIDuplicable"><span class="type">NAIDuplicable</span></a>.
</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>object</code></em> :</span></p></td>
<td>the <a class="link" href="NAIDuplicable.html" title="NAIDuplicable"><span class="type">NAIDuplicable</span></a> object whose origin is to be set.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>origin</code></em> :</span></p></td>
<td>the new original <a class="link" href="NAIDuplicable.html" title="NAIDuplicable"><span class="type">NAIDuplicable</span></a>.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.30</p>
</div>
<hr>
<div class="refsect2">
<a name="na-iduplicable-set-modified"></a><h3>na_iduplicable_set_modified ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> na_iduplicable_set_modified (<em class="parameter"><code><a class="link" href="NAIDuplicable.html" title="NAIDuplicable"><span class="type">NAIDuplicable</span></a> *object</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> modified</code></em>);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">na_iduplicable_set_modified</code> is deprecated and should not be used in newly-written code. 3.1</p>
</div>
<p>
Sets the new modification status of a duplicated <a class="link" href="NAIDuplicable.html" title="NAIDuplicable"><span class="type">NAIDuplicable</span></a>.
</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>object</code></em> :</span></p></td>
<td>the <a class="link" href="NAIDuplicable.html" title="NAIDuplicable"><span class="type">NAIDuplicable</span></a> object whose modification status is to be set.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>modified</code></em> :</span></p></td>
<td>the new modification status <a class="link" href="NAIDuplicable.html" title="NAIDuplicable"><span class="type">NAIDuplicable</span></a>.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.30</p>
</div>
<hr>
<div class="refsect2">
<a name="na-iduplicable-register-consumer"></a><h3>na_iduplicable_register_consumer ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> na_iduplicable_register_consumer (<em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> *consumer</code></em>);</pre>
<p>
This function registers a consumer, i.e. an instance to which edition
status signals will be propagated.
</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>consumer</code></em> :</span></p></td>
<td>the target instance.</td>
</tr></tbody>
</table></div>
<p class="since">Since 2.30</p>
</div>
<hr>
<div class="refsect2">
<a name="DuplicableMode"></a><h3>enum DuplicableMode</h3>
<pre class="programlisting">typedef enum {
DUPLICATE_ONLY = 1,
DUPLICATE_OBJECT,
DUPLICATE_REC
} DuplicableMode;
</pre>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><a name="DUPLICATE-ONLY:CAPS"></a><span class="term"><code class="literal">DUPLICATE_ONLY</code></span></p></td>
<td></td>
</tr>
<tr>
<td><p><a name="DUPLICATE-OBJECT:CAPS"></a><span class="term"><code class="literal">DUPLICATE_OBJECT</code></span></p></td>
<td></td>
</tr>
<tr>
<td><p><a name="DUPLICATE-REC:CAPS"></a><span class="term"><code class="literal">DUPLICATE_REC</code></span></p></td>
<td></td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.19</div>
</body>
</html>
|