/usr/share/gtk-doc/html/gcr-3/GcrCollectionModel.html is in libgcr-3-doc 3.20.0-5.1.
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 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GcrCollectionModel: Gcr Library Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="Gcr Library Reference Manual">
<link rel="up" href="collections.html" title="Part II. Collections">
<link rel="prev" href="GcrSimpleCollection.html" title="GcrSimpleCollection">
<link rel="next" href="widgets.html" title="Part III. Widgets">
<meta name="generator" content="GTK-Doc V1.25 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
<a href="#GcrCollectionModel.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#GcrCollectionModel.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces"> <span class="dim">|</span>
<a href="#GcrCollectionModel.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_properties"> <span class="dim">|</span>
<a href="#GcrCollectionModel.properties" class="shortcut">Properties</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="collections.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="GcrSimpleCollection.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="widgets.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="GcrCollectionModel"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GcrCollectionModel.top_of_page"></a>GcrCollectionModel</span></h2>
<p>GcrCollectionModel — A GtkTreeModel that represents a collection</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="GcrCollectionModel.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a class="link" href="GcrCollectionModel.html" title="GcrCollectionModel"><span class="returnvalue">GcrCollectionModel</span></a> *
</td>
<td class="function_name">
<a class="link" href="GcrCollectionModel.html#gcr-collection-model-new" title="gcr_collection_model_new ()">gcr_collection_model_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="GcrCollectionModel.html" title="GcrCollectionModel"><span class="returnvalue">GcrCollectionModel</span></a> *
</td>
<td class="function_name">
<a class="link" href="GcrCollectionModel.html#gcr-collection-model-new-full" title="gcr_collection_model_new_full ()">gcr_collection_model_new_full</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>
</td>
<td class="function_name">
<a class="link" href="GcrCollectionModel.html#gcr-collection-model-set-columns" title="gcr_collection_model_set_columns ()">gcr_collection_model_set_columns</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="GcrCollection.html" title="GcrCollection"><span class="returnvalue">GcrCollection</span></a> *
</td>
<td class="function_name">
<a class="link" href="GcrCollectionModel.html#gcr-collection-model-get-collection" title="gcr_collection_model_get_collection ()">gcr_collection_model_get_collection</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GcrCollectionModel.html#gcr-collection-model-set-collection" title="gcr_collection_model_set_collection ()">gcr_collection_model_set_collection</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="GcrCollectionModel.html#gcr-collection-model-iter-for-object" title="gcr_collection_model_iter_for_object ()">gcr_collection_model_iter_for_object</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject-struct"><span class="returnvalue">GObject</span></a> *
</td>
<td class="function_name">
<a class="link" href="GcrCollectionModel.html#gcr-collection-model-object-for-iter" title="gcr_collection_model_object_for_iter ()">gcr_collection_model_object_for_iter</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="GcrCollectionModel.html#gcr-collection-model-is-selected" title="gcr_collection_model_is_selected ()">gcr_collection_model_is_selected</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GcrCollectionModel.html#gcr-collection-model-change-selected" title="gcr_collection_model_change_selected ()">gcr_collection_model_change_selected</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GcrCollectionModel.html#gcr-collection-model-toggle-selected" title="gcr_collection_model_toggle_selected ()">gcr_collection_model_toggle_selected</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *
</td>
<td class="function_name">
<a class="link" href="GcrCollectionModel.html#gcr-collection-model-get-selected-objects" title="gcr_collection_model_get_selected_objects ()">gcr_collection_model_get_selected_objects</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GcrCollectionModel.html#gcr-collection-model-set-selected-objects" title="gcr_collection_model_set_selected_objects ()">gcr_collection_model_set_selected_objects</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>
</td>
<td class="function_name">
<a class="link" href="GcrCollectionModel.html#gcr-collection-model-column-for-selected" title="gcr_collection_model_column_for_selected ()">gcr_collection_model_column_for_selected</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GcrCollectionModel.properties"></a><h2>Properties</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="properties_type">
<col width="300px" class="properties_name">
<col width="200px" class="properties_flags">
</colgroup>
<tbody>
<tr>
<td class="property_type">
<a class="link" href="GcrCollection.html" title="GcrCollection"><span class="type">GcrCollection</span></a> *</td>
<td class="property_name"><a class="link" href="GcrCollectionModel.html#GcrCollectionModel--collection" title="The “collection” property">collection</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a></td>
<td class="property_name"><a class="link" href="GcrCollectionModel.html#GcrCollectionModel--columns" title="The “columns” property">columns</a></td>
<td class="property_flags">Read / Write / Construct Only</td>
</tr>
<tr>
<td class="property_type"><a class="link" href="GcrCollectionModel.html#GcrCollectionModelMode" title="enum GcrCollectionModelMode"><span class="type">GcrCollectionModelMode</span></a></td>
<td class="property_name"><a class="link" href="GcrCollectionModel.html#GcrCollectionModel--mode" title="The “mode” property">mode</a></td>
<td class="property_flags">Read / Write / Construct Only</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GcrCollectionModel.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="GcrCollectionModel.html#GcrCollectionModel-struct" title="struct GcrCollectionModel">GcrCollectionModel</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="GcrCollectionModel.html#GcrCollectionModelClass" title="struct GcrCollectionModelClass">GcrCollectionModelClass</a></td>
</tr>
<tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="GcrCollectionModel.html#GcrCollectionModelMode" title="enum GcrCollectionModelMode">GcrCollectionModelMode</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GcrCollectionModel.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a>
<span class="lineart">╰──</span> GcrCollectionModel
</pre>
</div>
<div class="refsect1">
<a name="GcrCollectionModel.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
GcrCollectionModel implements
GtkTreeModel and GtkTreeSortable.</p>
</div>
<div class="refsect1">
<a name="GcrCollectionModel.description"></a><h2>Description</h2>
<p>This is an implementation of <span class="type">GtkTreeModel</span> which represents the objects in
the a <a class="link" href="GcrCollection.html" title="GcrCollection"><span class="type">GcrCollection</span></a>. As objects are added or removed from the collection,
rows are added and removed from this model.</p>
<p>The row values come from the properties of the objects in the collection. Use
<a class="link" href="GcrCollectionModel.html#gcr-collection-model-new" title="gcr_collection_model_new ()"><code class="function">gcr_collection_model_new()</code></a> to create a new collection model. To have more
control over the values use a set of <a class="link" href="gcr-GcrColumn.html#GcrColumn" title="GcrColumn"><span class="type">GcrColumn</span></a> structures to define the
columns. This can be done with <a class="link" href="GcrCollectionModel.html#gcr-collection-model-new-full" title="gcr_collection_model_new_full ()"><code class="function">gcr_collection_model_new_full()</code></a> or
<a class="link" href="GcrCollectionModel.html#gcr-collection-model-set-columns" title="gcr_collection_model_set_columns ()"><code class="function">gcr_collection_model_set_columns()</code></a>.</p>
<p>Each row can have a selected state, which is represented by a boolean column.
The selected state can be toggled with <a class="link" href="GcrCollectionModel.html#gcr-collection-model-toggle-selected" title="gcr_collection_model_toggle_selected ()"><code class="function">gcr_collection_model_toggle_selected()</code></a>
or set with <a class="link" href="GcrCollectionModel.html#gcr-collection-model-set-selected-objects" title="gcr_collection_model_set_selected_objects ()"><code class="function">gcr_collection_model_set_selected_objects()</code></a> and retrieved with
<a class="link" href="GcrCollectionModel.html#gcr-collection-model-get-selected-objects" title="gcr_collection_model_get_selected_objects ()"><code class="function">gcr_collection_model_get_selected_objects()</code></a>.</p>
<p>To determine which object a row represents and vice versa, use the
<a class="link" href="GcrCollectionModel.html#gcr-collection-model-iter-for-object" title="gcr_collection_model_iter_for_object ()"><code class="function">gcr_collection_model_iter_for_object()</code></a> or <a class="link" href="GcrCollectionModel.html#gcr-collection-model-object-for-iter" title="gcr_collection_model_object_for_iter ()"><code class="function">gcr_collection_model_object_for_iter()</code></a>
functions.</p>
</div>
<div class="refsect1">
<a name="GcrCollectionModel.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="gcr-collection-model-new"></a><h3>gcr_collection_model_new ()</h3>
<pre class="programlisting"><a class="link" href="GcrCollectionModel.html" title="GcrCollectionModel"><span class="returnvalue">GcrCollectionModel</span></a> *
gcr_collection_model_new (<em class="parameter"><code><a class="link" href="GcrCollection.html" title="GcrCollection"><span class="type">GcrCollection</span></a> *collection</code></em>,
<em class="parameter"><code><a class="link" href="GcrCollectionModel.html#GcrCollectionModelMode" title="enum GcrCollectionModelMode"><span class="type">GcrCollectionModelMode</span></a> mode</code></em>,
<em class="parameter"><code>...</code></em>);</pre>
<p>Create a new <a class="link" href="GcrCollectionModel.html" title="GcrCollectionModel"><span class="type">GcrCollectionModel</span></a>. The variable argument list should contain
pairs of property names, and <a href="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#GType"><span class="type">GType</span></a> values. The variable argument list should
be terminated with <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.</p>
<p><span class="annotation">[<acronym title="Exposed in C code, not necessarily available in other languages."><span class="acronym">skip</span></acronym>]</span></p>
<div class="refsect3">
<a name="gcr-collection-model-new.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>collection</p></td>
<td class="parameter_description"><p>the collection to represent</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>mode</p></td>
<td class="parameter_description"><p>whether list or tree mode</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>...</p></td>
<td class="parameter_description"><p>the column names and types</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gcr-collection-model-new.returns"></a><h4>Returns</h4>
<p> a newly allocated model, which should be released
with <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>. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gcr-collection-model-new-full"></a><h3>gcr_collection_model_new_full ()</h3>
<pre class="programlisting"><a class="link" href="GcrCollectionModel.html" title="GcrCollectionModel"><span class="returnvalue">GcrCollectionModel</span></a> *
gcr_collection_model_new_full (<em class="parameter"><code><a class="link" href="GcrCollection.html" title="GcrCollection"><span class="type">GcrCollection</span></a> *collection</code></em>,
<em class="parameter"><code><a class="link" href="GcrCollectionModel.html#GcrCollectionModelMode" title="enum GcrCollectionModelMode"><span class="type">GcrCollectionModelMode</span></a> mode</code></em>,
<em class="parameter"><code>const <a class="link" href="gcr-GcrColumn.html#GcrColumn" title="GcrColumn"><span class="type">GcrColumn</span></a> *columns</code></em>);</pre>
<p>Create a new <a class="link" href="GcrCollectionModel.html" title="GcrCollectionModel"><span class="type">GcrCollectionModel</span></a>.</p>
<p><span class="annotation">[<acronym title="Exposed in C code, not necessarily available in other languages."><span class="acronym">skip</span></acronym>]</span></p>
<div class="refsect3">
<a name="gcr-collection-model-new-full.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>collection</p></td>
<td class="parameter_description"><p>the collection to represent</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>mode</p></td>
<td class="parameter_description"><p>whether list or tree mode</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>columns</p></td>
<td class="parameter_description"><p>the columns the model should contain</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gcr-collection-model-new-full.returns"></a><h4>Returns</h4>
<p> a newly allocated model, which should be released
with <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>. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gcr-collection-model-set-columns"></a><h3>gcr_collection_model_set_columns ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>
gcr_collection_model_set_columns (<em class="parameter"><code><a class="link" href="GcrCollectionModel.html" title="GcrCollectionModel"><span class="type">GcrCollectionModel</span></a> *self</code></em>,
<em class="parameter"><code>const <a class="link" href="gcr-GcrColumn.html#GcrColumn" title="GcrColumn"><span class="type">GcrColumn</span></a> *columns</code></em>);</pre>
<p>Set the columns that the model should contain. <em class="parameter"><code>columns</code></em>
is an array of
<a class="link" href="gcr-GcrColumn.html#GcrColumn" title="GcrColumn"><span class="type">GcrColumn</span></a> structures, with the last one containing <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> for all values.</p>
<p>This function can only be called once, and only if the model was not created
without a set of columns. This function cannot be called after the model
has been added to a view.</p>
<p>The columns are accessed as static data. They should continue to remain
in memory for longer than the GcrCollectionModel object.</p>
<p><span class="annotation">[<acronym title="Exposed in C code, not necessarily available in other languages."><span class="acronym">skip</span></acronym>]</span></p>
<div class="refsect3">
<a name="gcr-collection-model-set-columns.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>The model</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>columns</p></td>
<td class="parameter_description"><p>The columns the model should contain</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gcr-collection-model-set-columns.returns"></a><h4>Returns</h4>
<p> The number of columns</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gcr-collection-model-get-collection"></a><h3>gcr_collection_model_get_collection ()</h3>
<pre class="programlisting"><a class="link" href="GcrCollection.html" title="GcrCollection"><span class="returnvalue">GcrCollection</span></a> *
gcr_collection_model_get_collection (<em class="parameter"><code><a class="link" href="GcrCollectionModel.html" title="GcrCollectionModel"><span class="type">GcrCollectionModel</span></a> *self</code></em>);</pre>
<p>Get the collection which this model represents</p>
<div class="refsect3">
<a name="gcr-collection-model-get-collection.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>a collection model</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gcr-collection-model-get-collection.returns"></a><h4>Returns</h4>
<p> the collection, owned by the model. </p>
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gcr-collection-model-set-collection"></a><h3>gcr_collection_model_set_collection ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gcr_collection_model_set_collection (<em class="parameter"><code><a class="link" href="GcrCollectionModel.html" title="GcrCollectionModel"><span class="type">GcrCollectionModel</span></a> *self</code></em>,
<em class="parameter"><code><a class="link" href="GcrCollection.html" title="GcrCollection"><span class="type">GcrCollection</span></a> *collection</code></em>);</pre>
<p>Set the collection which this model represents</p>
<div class="refsect3">
<a name="gcr-collection-model-set-collection.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>a collection model</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>collection</p></td>
<td class="parameter_description"><p> the collection or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gcr-collection-model-iter-for-object"></a><h3>gcr_collection_model_iter_for_object ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
gcr_collection_model_iter_for_object (<em class="parameter"><code><a class="link" href="GcrCollectionModel.html" title="GcrCollectionModel"><span class="type">GcrCollectionModel</span></a> *self</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject-struct"><span class="type">GObject</span></a> *object</code></em>,
<em class="parameter"><code><span class="type">GtkTreeIter</span> *iter</code></em>);</pre>
<p>Set <em class="parameter"><code>iter</code></em>
to the row for the given object. If the object is not in this
model, then <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> will be returned.</p>
<div class="refsect3">
<a name="gcr-collection-model-iter-for-object.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>The model</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>object</p></td>
<td class="parameter_description"><p>The object</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>iter</p></td>
<td class="parameter_description"><p>The row for the object</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gcr-collection-model-iter-for-object.returns"></a><h4>Returns</h4>
<p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the object was present.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gcr-collection-model-object-for-iter"></a><h3>gcr_collection_model_object_for_iter ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject-struct"><span class="returnvalue">GObject</span></a> *
gcr_collection_model_object_for_iter (<em class="parameter"><code><a class="link" href="GcrCollectionModel.html" title="GcrCollectionModel"><span class="type">GcrCollectionModel</span></a> *self</code></em>,
<em class="parameter"><code>const <span class="type">GtkTreeIter</span> *iter</code></em>);</pre>
<p>Get the object that is represented by the given row in the model.</p>
<div class="refsect3">
<a name="gcr-collection-model-object-for-iter.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>The model</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>iter</p></td>
<td class="parameter_description"><p>The row</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gcr-collection-model-object-for-iter.returns"></a><h4>Returns</h4>
<p> The object, owned by the model. </p>
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gcr-collection-model-is-selected"></a><h3>gcr_collection_model_is_selected ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
gcr_collection_model_is_selected (<em class="parameter"><code><a class="link" href="GcrCollectionModel.html" title="GcrCollectionModel"><span class="type">GcrCollectionModel</span></a> *self</code></em>,
<em class="parameter"><code><span class="type">GtkTreeIter</span> *iter</code></em>);</pre>
<p>Check whether a given row has been toggled as selected.</p>
<div class="refsect3">
<a name="gcr-collection-model-is-selected.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>The model</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>iter</p></td>
<td class="parameter_description"><p>The row</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gcr-collection-model-is-selected.returns"></a><h4>Returns</h4>
<p> Whether the row has been selected.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gcr-collection-model-change-selected"></a><h3>gcr_collection_model_change_selected ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gcr_collection_model_change_selected (<em class="parameter"><code><a class="link" href="GcrCollectionModel.html" title="GcrCollectionModel"><span class="type">GcrCollectionModel</span></a> *self</code></em>,
<em class="parameter"><code><span class="type">GtkTreeIter</span> *iter</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> selected</code></em>);</pre>
<p>Set whether a given row is toggled selected or not.</p>
<div class="refsect3">
<a name="gcr-collection-model-change-selected.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>The model</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>iter</p></td>
<td class="parameter_description"><p>The row</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>selected</p></td>
<td class="parameter_description"><p>Whether the row should be selected or not.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gcr-collection-model-toggle-selected"></a><h3>gcr_collection_model_toggle_selected ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gcr_collection_model_toggle_selected (<em class="parameter"><code><a class="link" href="GcrCollectionModel.html" title="GcrCollectionModel"><span class="type">GcrCollectionModel</span></a> *self</code></em>,
<em class="parameter"><code><span class="type">GtkTreeIter</span> *iter</code></em>);</pre>
<p>Toggle the selected state of a given row.</p>
<div class="refsect3">
<a name="gcr-collection-model-toggle-selected.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>The model</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>iter</p></td>
<td class="parameter_description"><p>The row</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gcr-collection-model-get-selected-objects"></a><h3>gcr_collection_model_get_selected_objects ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *
gcr_collection_model_get_selected_objects
(<em class="parameter"><code><a class="link" href="GcrCollectionModel.html" title="GcrCollectionModel"><span class="type">GcrCollectionModel</span></a> *self</code></em>);</pre>
<p>Get a list of checked/selected objects.</p>
<div class="refsect3">
<a name="gcr-collection-model-get-selected-objects.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>the collection model</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gcr-collection-model-get-selected-objects.returns"></a><h4>Returns</h4>
<p> a list of selected
objects, which should be freed with <a href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#g-list-free"><code class="function">g_list_free()</code></a>. </p>
<p><span class="annotation">[<acronym title="Free data container after the code is done."><span class="acronym">transfer container</span></acronym>][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> GObject.Object]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gcr-collection-model-set-selected-objects"></a><h3>gcr_collection_model_set_selected_objects ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gcr_collection_model_set_selected_objects
(<em class="parameter"><code><a class="link" href="GcrCollectionModel.html" title="GcrCollectionModel"><span class="type">GcrCollectionModel</span></a> *self</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#GList"><span class="type">GList</span></a> *selected</code></em>);</pre>
<p>Set the checked/selected objects.</p>
<div class="refsect3">
<a name="gcr-collection-model-set-selected-objects.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>the collection model</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>selected</p></td>
<td class="parameter_description"><p> a list of objects to select. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> GObject.Object]</span></td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gcr-collection-model-column-for-selected"></a><h3>gcr_collection_model_column_for_selected ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>
gcr_collection_model_column_for_selected
(<em class="parameter"><code><a class="link" href="GcrCollectionModel.html" title="GcrCollectionModel"><span class="type">GcrCollectionModel</span></a> *self</code></em>);</pre>
<p>Get the column identifier for the column that contains the values
of the selected state.</p>
<div class="refsect3">
<a name="gcr-collection-model-column-for-selected.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>The model</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gcr-collection-model-column-for-selected.returns"></a><h4>Returns</h4>
<p> The column identifier.</p>
</div>
</div>
</div>
<div class="refsect1">
<a name="GcrCollectionModel.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GcrCollectionModel-struct"></a><h3>struct GcrCollectionModel</h3>
<pre class="programlisting">struct GcrCollectionModel;</pre>
<p>A <span class="type">GtkTreeModel</span> which contains a row for each object in a <a class="link" href="GcrCollection.html" title="GcrCollection"><span class="type">GcrCollection</span></a>.</p>
</div>
<hr>
<div class="refsect2">
<a name="GcrCollectionModelClass"></a><h3>struct GcrCollectionModelClass</h3>
<pre class="programlisting">struct GcrCollectionModelClass {
GObjectClass parent_class;
};
</pre>
<p>The class for <a class="link" href="GcrCollectionModel.html" title="GcrCollectionModel"><span class="type">GcrCollectionModel</span></a>.</p>
<div class="refsect3">
<a name="GcrCollectionModelClass.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="struct_members_name">
<col class="struct_members_description">
<col width="200px" class="struct_members_annotations">
</colgroup>
<tbody></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="GcrCollectionModelMode"></a><h3>enum GcrCollectionModelMode</h3>
<p>If set GcrCollectionModel is created with a mode of <a class="link" href="GcrCollectionModel.html#GCR-COLLECTION-MODEL-TREE:CAPS"><code class="literal">GCR_COLLECTION_MODEL_TREE</code></a>,
then any included objects that are themselves a <a class="link" href="GcrCollection.html" title="GcrCollection"><span class="type">GcrCollection</span></a>, will have all child
objects include as child rows in a tree form.</p>
<div class="refsect3">
<a name="GcrCollectionModelMode.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="enum_members_name">
<col class="enum_members_description">
<col width="200px" class="enum_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="enum_member_name"><p><a name="GCR-COLLECTION-MODEL-LIST:CAPS"></a>GCR_COLLECTION_MODEL_LIST</p></td>
<td class="enum_member_description">
<p>only objects in the top collection, no child objects</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GCR-COLLECTION-MODEL-TREE:CAPS"></a>GCR_COLLECTION_MODEL_TREE</p></td>
<td class="enum_member_description">
<p>show objects in the collection, and child objects in a tree form</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="GcrCollectionModel.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="GcrCollectionModel--collection"></a><h3>The <code class="literal">“collection”</code> property</h3>
<pre class="programlisting"> “collection” <a class="link" href="GcrCollection.html" title="GcrCollection"><span class="type">GcrCollection</span></a> *</pre>
<p>Collection to get objects from.</p>
<p>Flags: Read / Write</p>
</div>
<hr>
<div class="refsect2">
<a name="GcrCollectionModel--columns"></a><h3>The <code class="literal">“columns”</code> property</h3>
<pre class="programlisting"> “columns” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a></pre>
<p>Columns for the model.</p>
<p>Flags: Read / Write / Construct Only</p>
</div>
<hr>
<div class="refsect2">
<a name="GcrCollectionModel--mode"></a><h3>The <code class="literal">“mode”</code> property</h3>
<pre class="programlisting"> “mode” <a class="link" href="GcrCollectionModel.html#GcrCollectionModelMode" title="enum GcrCollectionModelMode"><span class="type">GcrCollectionModelMode</span></a></pre>
<p>Tree or list mode.</p>
<p>Flags: Read / Write / Construct Only</p>
<p>Default value: GCR_COLLECTION_MODEL_TREE</p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.25</div>
</body>
</html>
|