~ken-vandine/dee/packaging

« back to all changes in this revision

Viewing changes to doc/reference/dee-1.0/html/DeeModel.html

  • Committer: Ken VanDine
  • Date: 2011-01-14 19:15:51 UTC
  • mfrom: (131.1.12 upstream)
  • Revision ID: ken.vandine@canonical.com-20110114191551-dv6swfs63ouxt6cm
Tags: 0.5.4-0ubuntu1
releasing version 0.5.4-0ubuntu1

Show diffs side-by-side

added added

removed removed

Lines of Context:
359
359
This method must be called exactly once before using <em class="parameter"><code>self</code></em>. Note that
360
360
some constructors will do this for you.
361
361
</p>
 
362
<p>
 
363
To create a model with three columns; a 32 bit integer, a string,
 
364
and lastly an array of strings, you would do:
 
365
</p>
 
366
<div class="informalexample"><pre class="programlisting">
 
367
 DeeModel *model;
 
368
 model = dee_sequence_model_new ();
 
369
 dee_model_set_schema (model, "i", "s", "as", NULL);
 
370
</pre></div>
 
371
<p>
 
372
</p>
362
373
<div class="variablelist"><table border="0">
363
374
<col align="left" valign="top">
364
375
<tbody>
406
417
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> * const *column_schemas</code></em>,
407
418
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> num_columns</code></em>);</pre>
408
419
<p>
 
420
Set the <a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> types and the number of columns used by <em class="parameter"><code>self</code></em>.
 
421
This method must be called exactly once before using <em class="parameter"><code>self</code></em>. Note that
 
422
some constructors will do this for you.
409
423
</p>
410
424
<div class="variablelist"><table border="0">
411
425
<col align="left" valign="top">
412
426
<tbody>
413
427
<tr>
414
428
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
415
 
<td>
 
429
<td>The <a class="link" href="DeeModel.html" title="DeeModel"><span class="type">DeeModel</span></a> to set the column layout for
416
430
</td>
417
431
</tr>
418
432
<tr>
419
433
<td><p><span class="term"><em class="parameter"><code>column_schemas</code></em> :</span></p></td>
420
 
<td>
 
434
<td> A list of <a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> type strings terminated by a <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=num_columns zero-terminated=1][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> utf8][<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym> utf8]</span>
421
435
</td>
422
436
</tr>
423
437
<tr>
424
438
<td><p><span class="term"><em class="parameter"><code>num_columns</code></em> :</span></p></td>
425
 
<td>
 
439
<td>an integer specifying the array length for <em class="parameter"><code>VarArgs</code></em>
426
440
</td>
427
441
</tr>
428
442
</tbody>
447
461
</tr>
448
462
<tr>
449
463
<td><p><span class="term"><em class="parameter"><code>num_columns</code></em> :</span></p></td>
450
 
<td>Address of an integer in which to store the number of
451
 
              columns in <em class="parameter"><code>self</code></em>. Or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore the array length.
 
464
<td> Address of an integer in which to store the
 
465
              number of columns in <em class="parameter"><code>self</code></em>. Or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore the array length. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
452
466
</td>
453
467
</tr>
454
468
<tr>
455
469
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
456
 
<td> A <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>-terminated array of <a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> type strings. The length of
 
470
<td> A <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>-terminated
 
471
         array of <a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> type strings. The length of
457
472
         the returned array is written to <em class="parameter"><code>num_columns</code></em>. The returned array
458
 
         should not be freed or modified. It is owned by the model.
 
473
         should not be freed or modified. It is owned by the model. <span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym>][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> utf8][<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym> utf8]</span>
459
474
</td>
460
475
</tr>
461
476
</tbody>
561
576
<td>A list of values matching the column schemas of <em class="parameter"><code>self</code></em>.
562
577
          Any basic variant type is passed as the standard C type while
563
578
          any other type must be boxed in a <a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a>. Any floating
564
 
          references will be consumed.
 
579
          references will be consumed. A <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> value for a string
 
580
          type column will be converted to the empty string.
565
581
</td>
566
582
</tr>
567
583
<tr>
568
584
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
569
 
<td> A <a class="link" href="DeeModel.html#DeeModelIter" title="DeeModelIter"><span class="type">DeeModelIter</span></a> pointing to the new row
 
585
<td> A <a class="link" href="DeeModel.html#DeeModelIter" title="DeeModelIter"><span class="type">DeeModelIter</span></a> pointing to the new row. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
570
586
</td>
571
587
</tr>
572
588
</tbody>
608
624
<p>
609
625
Like <a class="link" href="DeeModel.html#dee-model-append" title="dee_model_append ()"><code class="function">dee_model_append()</code></a> but intended for language bindings or
610
626
situations where you work with models on a meta level and may not have
611
 
a priori knowledge of the column schemas of the models. See also
 
627
a prior knowledge of the column schemas of the models. See also
612
628
<a class="link" href="DeeModel.html#dee-model-build-row" title="dee_model_build_row ()"><code class="function">dee_model_build_row()</code></a>.
613
629
</p>
614
630
<div class="variablelist"><table border="0">
621
637
</tr>
622
638
<tr>
623
639
<td><p><span class="term"><em class="parameter"><code>row_members</code></em> :</span></p></td>
624
 
<td>An array of <a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="type">GVariants</span></a> with type signature matching those of
625
 
              the column schemas of <em class="parameter"><code>self</code></em>. If any of the variants have
626
 
              floating references they will be consumed
 
640
<td> An array of  <a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="type">GVariants</span></a> with type
 
641
              signature matching those of the column schemas of <em class="parameter"><code>self</code></em>.
 
642
              If any of the variants have floating references they will be
 
643
              consumed. <span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> zero-terminated=1]</span>
627
644
</td>
628
645
</tr>
629
646
<tr>
630
647
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
631
 
<td> A <a class="link" href="DeeModel.html#DeeModelIter" title="DeeModelIter"><span class="type">DeeModelIter</span></a> pointing to the new row
 
648
<td> A <a class="link" href="DeeModel.html#DeeModelIter" title="DeeModelIter"><span class="type">DeeModelIter</span></a> pointing to the new row. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
632
649
</td>
633
650
</tr>
634
651
</tbody>
643
660
Creates and prepends a new row to the beginning of a <a class="link" href="DeeModel.html" title="DeeModel"><span class="type">DeeModel</span></a>, setting the
644
661
row values upon creation.
645
662
</p>
646
 
<p>
 
663
<div class="variablelist"><table border="0">
 
664
<col align="left" valign="top">
 
665
<tbody>
 
666
<tr>
 
667
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
 
668
<td>a <a class="link" href="DeeModel.html" title="DeeModel"><span class="type">DeeModel</span></a>
 
669
</td>
 
670
</tr>
 
671
<tr>
 
672
<td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td>
 
673
<td>A list of values  matching the column schemas of <em class="parameter"><code>self</code></em>.
 
674
          Any basic variant type is passed as the standard C type while
 
675
          any other type must be boxed in a <a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a>. Any floating
 
676
          references will be consumed. A <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> value for a string
 
677
          type column will be converted to the empty string.
 
678
</td>
 
679
</tr>
 
680
<tr>
 
681
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
682
<td> A <a class="link" href="DeeModel.html#DeeModelIter" title="DeeModelIter"><span class="type">DeeModelIter</span></a> pointing to the new row
 
683
 
647
684
Example:
648
 
</p>
649
 
<p>
650
 
</p>
 
685
 
651
686
<div class="informalexample"><pre class="programlisting">
652
687
 DeeModel *model;
653
688
 model = ...
654
689
 dee_model_set_schema (model, "i", "s", NULL);
655
690
 dee_model_prepend (model, 10, "Rooney");
656
 
</pre></div>
657
 
<p>
658
 
</p>
659
 
<div class="variablelist"><table border="0">
660
 
<col align="left" valign="top">
661
 
<tbody>
662
 
<tr>
663
 
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
664
 
<td>a <a class="link" href="DeeModel.html" title="DeeModel"><span class="type">DeeModel</span></a>
665
 
</td>
666
 
</tr>
667
 
<tr>
668
 
<td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td>
669
 
<td>A list of values matching the column schemas of <em class="parameter"><code>self</code></em>.
670
 
          Any basic variant type is passed as the standard C type while
671
 
          any other type must be boxed in a <a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a>. Any floating
672
 
          references will be consumed.
673
 
</td>
674
 
</tr>
675
 
<tr>
676
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
677
 
<td>
 
691
</pre></div>. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
678
692
</td>
679
693
</tr>
680
694
</tbody>
729
743
</tr>
730
744
<tr>
731
745
<td><p><span class="term"><em class="parameter"><code>row_members</code></em> :</span></p></td>
732
 
<td>An array of <a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="type">GVariants</span></a> with type signature matching those of
 
746
<td> An array of
 
747
              <a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="type">GVariants</span></a> with type signature matching those of
733
748
              the column schemas of <em class="parameter"><code>self</code></em>. If any of the variants have
734
 
              floating references they will be consumed
 
749
              floating references they will be consumed. <span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> zero-terminated=1]</span>
735
750
</td>
736
751
</tr>
737
752
<tr>
738
753
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
739
 
<td> A <a class="link" href="DeeModel.html#DeeModelIter" title="DeeModelIter"><span class="type">DeeModelIter</span></a> pointing to the new row
 
754
<td> A <a class="link" href="DeeModel.html#DeeModelIter" title="DeeModelIter"><span class="type">DeeModelIter</span></a> pointing to the new row. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
740
755
</td>
741
756
</tr>
742
757
</tbody>
770
785
</tr>
771
786
<tr>
772
787
<td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td>
773
 
<td>A list of values matching the column schemas of <em class="parameter"><code>self</code></em>.
 
788
<td>A list of values  matching the column schemas of <em class="parameter"><code>self</code></em>.
774
789
          Any basic variant type is passed as the standard C type while
775
790
          any other type must be boxed in a <a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a>. Any floating
776
 
          references will be consumed.
 
791
          references will be consumed. A <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> value for a string
 
792
          type column will be converted to the empty string.
777
793
</td>
778
794
</tr>
779
795
<tr>
780
796
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
781
 
<td> A <a class="link" href="DeeModel.html#DeeModelIter" title="DeeModelIter"><span class="type">DeeModelIter</span></a> pointing to the new row
 
797
<td> A <a class="link" href="DeeModel.html#DeeModelIter" title="DeeModelIter"><span class="type">DeeModelIter</span></a> pointing to the new row. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
782
798
</td>
783
799
</tr>
784
800
</tbody>
845
861
</tr>
846
862
<tr>
847
863
<td><p><span class="term"><em class="parameter"><code>row_members</code></em> :</span></p></td>
848
 
<td>An array of <a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="type">GVariants</span></a> with type signature matching those of
 
864
<td> An array of
 
865
              <a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="type">GVariants</span></a> with type signature matching those of
849
866
              the column schemas of <em class="parameter"><code>self</code></em>. If any of the variants have
850
 
              floating references they will be consumed
 
867
              floating references they will be consumed. <span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> zero-terminated]</span>
851
868
</td>
852
869
</tr>
853
870
<tr>
854
871
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
855
 
<td> A <a class="link" href="DeeModel.html#DeeModelIter" title="DeeModelIter"><span class="type">DeeModelIter</span></a> pointing to the new row
 
872
<td> A <a class="link" href="DeeModel.html#DeeModelIter" title="DeeModelIter"><span class="type">DeeModelIter</span></a> pointing to the new row. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
856
873
</td>
857
874
</tr>
858
875
</tbody>
905
922
</tr>
906
923
<tr>
907
924
<td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td>
908
 
<td>A list of values matching the column schemas of <em class="parameter"><code>self</code></em>.
 
925
<td>A list of values  matching the column schemas of <em class="parameter"><code>self</code></em>.
909
926
          Any basic variant type is passed as the standard C type while
910
927
          any other type must be boxed in a <a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a>. Any floating
911
 
          references will be consumed.
 
928
          references will be consumed. A <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> value for a string
 
929
          type column will be converted to the empty string.
912
930
</td>
913
931
</tr>
914
932
<tr>
915
933
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
916
 
<td> A <a class="link" href="DeeModel.html#DeeModelIter" title="DeeModelIter"><span class="type">DeeModelIter</span></a> pointing to the new row
 
934
<td> A <a class="link" href="DeeModel.html#DeeModelIter" title="DeeModelIter"><span class="type">DeeModelIter</span></a> pointing to the new row. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
917
935
</td>
918
936
</tr>
919
937
</tbody>
926
944
                                                         <em class="parameter"><code><a class="link" href="DeeModel.html#DeeModelIter" title="DeeModelIter"><span class="type">DeeModelIter</span></a> *iter</code></em>,
927
945
                                                         <em class="parameter"><code><span class="type">va_list</span> *args</code></em>);</pre>
928
946
<p>
929
 
As <a class="link" href="DeeModel.html#dee-model-insert-before" title="dee_model_insert_before ()"><code class="function">dee_model_insert_before()</code></a>, but intended for language bindings.
930
947
</p>
931
948
<div class="variablelist"><table border="0">
932
949
<col align="left" valign="top">
933
950
<tbody>
934
951
<tr>
935
952
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
936
 
<td>a <a class="link" href="DeeModel.html" title="DeeModel"><span class="type">DeeModel</span></a>
 
953
<td>
937
954
</td>
938
955
</tr>
939
956
<tr>
940
957
<td><p><span class="term"><em class="parameter"><code>iter</code></em> :</span></p></td>
941
 
<td>An iter pointing to the row before which to insert the new one
 
958
<td>
942
959
</td>
943
960
</tr>
944
961
<tr>
945
962
<td><p><span class="term"><em class="parameter"><code>args</code></em> :</span></p></td>
946
 
<td>See <a class="link" href="DeeModel.html#dee-model-insert-before" title="dee_model_insert_before ()"><code class="function">dee_model_insert_before()</code></a>
 
963
<td>
947
964
</td>
948
965
</tr>
949
966
<tr>
950
967
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
951
 
<td> A <a class="link" href="DeeModel.html#DeeModelIter" title="DeeModelIter"><span class="type">DeeModelIter</span></a> pointing to the new row
 
968
<td>
952
969
</td>
953
970
</tr>
954
971
</tbody>
981
998
</tr>
982
999
<tr>
983
1000
<td><p><span class="term"><em class="parameter"><code>row_members</code></em> :</span></p></td>
984
 
<td>
 
1001
<td> An array of
 
1002
      <a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="type">GVariants</span></a> with type signature matching those of the
 
1003
      column schemas of <em class="parameter"><code>self</code></em>. If any of the variants have floating
 
1004
      references they will be consumed. <span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> zero-terminated]</span>
985
1005
</td>
986
1006
</tr>
987
1007
<tr>
988
1008
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
989
 
<td> A <a class="link" href="DeeModel.html#DeeModelIter" title="DeeModelIter"><span class="type">DeeModelIter</span></a> pointing to the new row
 
1009
<td> A <a class="link" href="DeeModel.html#DeeModelIter" title="DeeModelIter"><span class="type">DeeModelIter</span></a> pointing to the new row. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
990
1010
</td>
991
1011
</tr>
992
1012
</tbody>
1010
1030
</tr>
1011
1031
<tr>
1012
1032
<td><p><span class="term"><em class="parameter"><code>iter</code></em> :</span></p></td>
1013
 
<td>
 
1033
<td>a <a class="link" href="DeeModel.html#DeeModelIter" title="DeeModelIter"><span class="type">DeeModelIter</span></a> pointing to the row to remove
1014
1034
</td>
1015
1035
</tr>
1016
1036
</tbody>
1076
1096
</tr>
1077
1097
<tr>
1078
1098
<td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td>
1079
 
<td>A list of values to set matching the column schemas
 
1099
<td>A list of values to set matching the column schemas.
 
1100
          Any basic variant type is passed as the standard C type while
 
1101
          any other type must be boxed in a <a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a>. Any floating
 
1102
          references will be consumed. A <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> value for a string
 
1103
          type column will be converted to the empty string.
1080
1104
</td>
1081
1105
</tr>
1082
1106
</tbody>
1089
1113
                                                         <em class="parameter"><code><a class="link" href="DeeModel.html#DeeModelIter" title="DeeModelIter"><span class="type">DeeModelIter</span></a> *iter</code></em>,
1090
1114
                                                         <em class="parameter"><code><span class="type">va_list</span> *args</code></em>);</pre>
1091
1115
<p>
1092
 
See <a class="link" href="DeeModel.html#dee-model-set" title="dee_model_set ()"><code class="function">dee_model_set()</code></a>. This version takes a va_list for language bindings.
1093
1116
</p>
1094
1117
<div class="variablelist"><table border="0">
1095
1118
<col align="left" valign="top">
1096
1119
<tbody>
1097
1120
<tr>
1098
1121
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
1099
 
<td>a <a class="link" href="DeeModel.html" title="DeeModel"><span class="type">DeeModel</span></a>
 
1122
<td>
1100
1123
</td>
1101
1124
</tr>
1102
1125
<tr>
1103
1126
<td><p><span class="term"><em class="parameter"><code>iter</code></em> :</span></p></td>
1104
 
<td>a <a class="link" href="DeeModel.html#DeeModelIter" title="DeeModelIter"><span class="type">DeeModelIter</span></a>
 
1127
<td>
1105
1128
</td>
1106
1129
</tr>
1107
1130
<tr>
1108
1131
<td><p><span class="term"><em class="parameter"><code>args</code></em> :</span></p></td>
1109
 
<td>a list of column/value location pairs, terminated by -1
 
1132
<td>
1110
1133
</td>
1111
1134
</tr>
1112
1135
</tbody>
1148
1171
</tr>
1149
1172
<tr>
1150
1173
<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
1151
 
<td>new value for cell. If <em class="parameter"><code>value</code></em> is a floating reference the model
 
1174
<td>New value for cell. If <em class="parameter"><code>value</code></em> is a floating reference the model
1152
1175
        will assume ownership of the variant
1153
1176
</td>
1154
1177
</tr>
1181
1204
</tr>
1182
1205
<tr>
1183
1206
<td><p><span class="term"><em class="parameter"><code>row_members</code></em> :</span></p></td>
1184
 
<td>And array of <a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a>s with type signature matching
 
1207
<td> And array of 
 
1208
              <a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a>s with type signature matching
1185
1209
              those from the model schema. If any of the variants have
1186
 
              floating references these will be consumed
 
1210
              floating references these will be consumed. <span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym>]</span>
1187
1211
</td>
1188
1212
</tr>
1189
1213
</tbody>
1256
1280
                                                         <em class="parameter"><code><a class="link" href="DeeModel.html#DeeModelIter" title="DeeModelIter"><span class="type">DeeModelIter</span></a> *iter</code></em>,
1257
1281
                                                         <em class="parameter"><code><span class="type">va_list</span> args</code></em>);</pre>
1258
1282
<p>
1259
 
See #<a class="link" href="DeeModel.html#dee-model-get" title="dee_model_get ()"><code class="function">dee_model_get()</code></a>. This version takes a va_list for language bindings.
1260
1283
</p>
1261
1284
<div class="variablelist"><table border="0">
1262
1285
<col align="left" valign="top">
1263
1286
<tbody>
1264
1287
<tr>
1265
1288
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
1266
 
<td>a <a class="link" href="DeeModel.html" title="DeeModel"><span class="type">DeeModel</span></a>
 
1289
<td>
1267
1290
</td>
1268
1291
</tr>
1269
1292
<tr>
1270
1293
<td><p><span class="term"><em class="parameter"><code>iter</code></em> :</span></p></td>
1271
 
<td>a <a class="link" href="DeeModel.html#DeeModelIter" title="DeeModelIter"><span class="type">DeeModelIter</span></a>
 
1294
<td>
1272
1295
</td>
1273
1296
</tr>
1274
1297
<tr>
1275
1298
<td><p><span class="term"><em class="parameter"><code>args</code></em> :</span></p></td>
1276
 
<td>a list of column/return location pairs, terminated by -1
 
1299
<td>
1277
1300
</td>
1278
1301
</tr>
1279
1302
</tbody>
1300
1323
</tr>
1301
1324
<tr>
1302
1325
<td><p><span class="term"><em class="parameter"><code>out_row_members</code></em> :</span></p></td>
1303
 
<td>An array of variants with a length bigger than or equal to
 
1326
<td> An array 
 
1327
                  of variants with a length bigger than or equal to
1304
1328
                  the number of columns in <em class="parameter"><code>self</code></em>, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. If you pass
1305
1329
                  <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> here a new array will be allocated for you. The
1306
 
                  returned variants will have a non-floating reference
 
1330
                  returned variants will have a non-floating reference. <span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym>][<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span>
1307
1331
</td>
1308
1332
</tr>
1309
1333
<tr>
1343
1367
</tr>
1344
1368
<tr>
1345
1369
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1346
 
<td> A, guaranteed non-floating, reference to a <a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> containing
1347
 
         the row data. Free with <a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#g-variant-unref"><code class="function">g_variant_unref()</code></a>.
 
1370
<td> A, guaranteed non-floating, reference to a
 
1371
         <a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> containing the row data. Free with <a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#g-variant-unref"><code class="function">g_variant_unref()</code></a>. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
1348
1372
</td>
1349
1373
</tr>
1350
1374
</tbody>
1455
1479
<tr>
1456
1480
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1457
1481
<td> if <em class="parameter"><code>iter</code></em> and <em class="parameter"><code>column</code></em> are valid, the boolean stored at <em class="parameter"><code>column</code></em>.
1458
 
 Otherwise <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>
 
1482
              Otherwise <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>
1459
1483
</td>
1460
1484
</tr>
1461
1485
</tbody>
1910
1934
          Basic variant types are passed directly while any other
1911
1935
          types must be boxed in a <a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a>. It's important to note that
1912
1936
          any floating references on variants passed to this method will be
1913
 
          <span class="emphasis"><em>not</em></span> be consumed.
 
1937
          <span class="emphasis"><em>not</em></span> be consumed. A <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> value for a string
 
1938
          type column will be converted to the empty string.
1914
1939
</td>
1915
1940
</tr>
1916
1941
<tr>
1917
1942
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1918
1943
<td> If <em class="parameter"><code>out_row_members</code></em> is <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> a newly allocated array of variants
1919
 
         will be returned, otherwise it will be reused. The variants in the
1920
 
         array may or may not have floating references, which means the
 
1944
         will be returned and the array must be freed with <a href="http://library.gnome.org/devel/glib/unstable/glib-Memory-Allocation.html#g-free"><code class="function">g_free()</code></a>.
 
1945
         If <em class="parameter"><code>out_row_members</code></em> is non<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> it will be reused, and variants in
 
1946
         the array may or may not have floating references, which means the
1921
1947
         caller must make sure that <a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#g-variant-ref-sink"><code class="function">g_variant_ref_sink()</code></a> and
1922
1948
         <a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#g-variant-unref"><code class="function">g_variant_unref()</code></a> are called on them.
1923
1949
 
1933
1959
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> **out_row_members</code></em>,
1934
1960
                                                         <em class="parameter"><code><span class="type">va_list</span> *args</code></em>);</pre>
1935
1961
<p>
1936
 
Like <a class="link" href="DeeModel.html#dee-model-build-row" title="dee_model_build_row ()"><code class="function">dee_model_build_row()</code></a> but intended for language bindings.
1937
1962
</p>
1938
1963
<div class="variablelist"><table border="0">
1939
1964
<col align="left" valign="top">
1940
1965
<tbody>
1941
1966
<tr>
1942
1967
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
1943
 
<td>The model to build a row for
 
1968
<td>
1944
1969
</td>
1945
1970
</tr>
1946
1971
<tr>
1947
1972
<td><p><span class="term"><em class="parameter"><code>out_row_members</code></em> :</span></p></td>
1948
 
<td>An array to write the values to or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to allocate
1949
 
                  a new array
 
1973
<td>
1950
1974
</td>
1951
1975
</tr>
1952
1976
<tr>
1953
1977
<td><p><span class="term"><em class="parameter"><code>args</code></em> :</span></p></td>
1954
 
<td>A <code class="literal">va_list</code> of arguments as described in <a class="link" href="DeeModel.html#dee-model-build-row" title="dee_model_build_row ()"><code class="function">dee_model_build_row()</code></a>
 
1978
<td>
1955
1979
</td>
1956
1980
</tr>
1957
1981
<tr>
1958
1982
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1959
 
<td> See <a class="link" href="DeeModel.html#dee-model-build-row" title="dee_model_build_row ()"><code class="function">dee_model_build_row()</code></a>
 
1983
<td>
1960
1984
</td>
1961
1985
</tr>
1962
1986
</tbody>
1983
2007
</tr>
1984
2008
<tr>
1985
2009
<td><p><span class="term"><em class="parameter"><code>iter</code></em> :</span></p></td>
1986
 
<td>a <a class="link" href="DeeModel.html#DeeModelIter" title="DeeModelIter"><span class="type">DeeModelIter</span></a> pointing to the newly added row
 
2010
<td> a <a class="link" href="DeeModel.html#DeeModelIter" title="DeeModelIter"><span class="type">DeeModelIter</span></a> pointing to the newly added row. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
1987
2011
</td>
1988
2012
</tr>
1989
2013
<tr>
2012
2036
</tr>
2013
2037
<tr>
2014
2038
<td><p><span class="term"><em class="parameter"><code>iter</code></em> :</span></p></td>
2015
 
<td>a <a class="link" href="DeeModel.html#DeeModelIter" title="DeeModelIter"><span class="type">DeeModelIter</span></a> pointing to the changed row
 
2039
<td> a <a class="link" href="DeeModel.html#DeeModelIter" title="DeeModelIter"><span class="type">DeeModelIter</span></a> pointing to the changed row. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
2016
2040
</td>
2017
2041
</tr>
2018
2042
<tr>
2042
2066
</tr>
2043
2067
<tr>
2044
2068
<td><p><span class="term"><em class="parameter"><code>iter</code></em> :</span></p></td>
2045
 
<td>a <a class="link" href="DeeModel.html#DeeModelIter" title="DeeModelIter"><span class="type">DeeModelIter</span></a> pointing to the removed row
 
2069
<td> a <a class="link" href="DeeModel.html#DeeModelIter" title="DeeModelIter"><span class="type">DeeModelIter</span></a> pointing to the removed row. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
2046
2070
</td>
2047
2071
</tr>
2048
2072
<tr>