← Back to branch summary

~ubuntu-branches/ubuntu/trusty/gcr/trusty

« back to all changes in this revision

Viewing changes to docs/reference/gcr/html/GcrCollectionModel.html

  • Committer: Package Import Robot
  • Author(s): Sebastien Bacher
  • Date: 2012-11-12 10:37:35 UTC
  • mfrom: (1.2.1) (2.1.1 experimental)
  • Revision ID: package-import@ubuntu.com-20121112103735-r6gqkxi4z3os95vx
Tags: 3.6.2-0ubuntu1
* New upstream versions:
  - Remove unneeded translation
  - Clear and focus password entry in gcr-viewer when invalid password
  - Keep enumerating if getting info about one slot fails.
  - Updated translations
  - Testing fixes

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/gcr/html/GcrCollectionModel.html
3
3
<head>
4
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
5
<title>GcrCollectionModel</title>
6
 
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.77.1">
7
7
<link rel="home" href="index.html" title="Gcr Library Reference Manual">
8
8
<link rel="up" href="collections.html" title="Part II. Collections">
9
9
<link rel="prev" href="GcrSimpleCollection.html" title="GcrSimpleCollection">
60
60
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <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>
61
61
                                                        (<em class="parameter"><code><a class="link" href="GcrCollectionModel.html" title="GcrCollectionModel"><span class="type">GcrCollectionModel</span></a> *self</code></em>,
62
62
                                                         <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> *object</code></em>,
63
 
                                                         <em class="parameter"><code><a href="http://developer.gnome.org/devel/gtk/GtkTreeModel.html#GtkTreeIter"><span class="type">GtkTreeIter</span></a> *iter</code></em>);
 
63
                                                         <em class="parameter"><code><a href="http://developer.gnome.org/gtk2/GtkTreeModel.html#GtkTreeIter"><span class="type">GtkTreeIter</span></a> *iter</code></em>);
64
64
<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="returnvalue">GObject</span></a> *           <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>
65
65
                                                        (<em class="parameter"><code><a class="link" href="GcrCollectionModel.html" title="GcrCollectionModel"><span class="type">GcrCollectionModel</span></a> *self</code></em>,
66
 
                                                         <em class="parameter"><code>const <a href="http://developer.gnome.org/devel/gtk/GtkTreeModel.html#GtkTreeIter"><span class="type">GtkTreeIter</span></a> *iter</code></em>);
 
66
                                                         <em class="parameter"><code>const <a href="http://developer.gnome.org/gtk2/GtkTreeModel.html#GtkTreeIter"><span class="type">GtkTreeIter</span></a> *iter</code></em>);
67
67
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="GcrCollectionModel.html#gcr-collection-model-is-selected" title="gcr_collection_model_is_selected ()">gcr_collection_model_is_selected</a>    (<em class="parameter"><code><a class="link" href="GcrCollectionModel.html" title="GcrCollectionModel"><span class="type">GcrCollectionModel</span></a> *self</code></em>,
68
 
                                                         <em class="parameter"><code><a href="http://developer.gnome.org/devel/gtk/GtkTreeModel.html#GtkTreeIter"><span class="type">GtkTreeIter</span></a> *iter</code></em>);
 
68
                                                         <em class="parameter"><code><a href="http://developer.gnome.org/gtk2/GtkTreeModel.html#GtkTreeIter"><span class="type">GtkTreeIter</span></a> *iter</code></em>);
69
69
<span class="returnvalue">void</span>                <a class="link" href="GcrCollectionModel.html#gcr-collection-model-change-selected" title="gcr_collection_model_change_selected ()">gcr_collection_model_change_selected</a>
70
70
                                                        (<em class="parameter"><code><a class="link" href="GcrCollectionModel.html" title="GcrCollectionModel"><span class="type">GcrCollectionModel</span></a> *self</code></em>,
71
 
                                                         <em class="parameter"><code><a href="http://developer.gnome.org/devel/gtk/GtkTreeModel.html#GtkTreeIter"><span class="type">GtkTreeIter</span></a> *iter</code></em>,
 
71
                                                         <em class="parameter"><code><a href="http://developer.gnome.org/gtk2/GtkTreeModel.html#GtkTreeIter"><span class="type">GtkTreeIter</span></a> *iter</code></em>,
72
72
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> selected</code></em>);
73
73
<span class="returnvalue">void</span>                <a class="link" href="GcrCollectionModel.html#gcr-collection-model-toggle-selected" title="gcr_collection_model_toggle_selected ()">gcr_collection_model_toggle_selected</a>
74
74
                                                        (<em class="parameter"><code><a class="link" href="GcrCollectionModel.html" title="GcrCollectionModel"><span class="type">GcrCollectionModel</span></a> *self</code></em>,
75
 
                                                         <em class="parameter"><code><a href="http://developer.gnome.org/devel/gtk/GtkTreeModel.html#GtkTreeIter"><span class="type">GtkTreeIter</span></a> *iter</code></em>);
 
75
                                                         <em class="parameter"><code><a href="http://developer.gnome.org/gtk2/GtkTreeModel.html#GtkTreeIter"><span class="type">GtkTreeIter</span></a> *iter</code></em>);
76
76
<a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *             <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>
77
77
                                                        (<em class="parameter"><code><a class="link" href="GcrCollectionModel.html" title="GcrCollectionModel"><span class="type">GcrCollectionModel</span></a> *self</code></em>);
78
78
<span class="returnvalue">void</span>                <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>
93
93
<a name="GcrCollectionModel.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
94
94
<p>
95
95
GcrCollectionModel implements
96
 
 <a href="http://developer.gnome.org/devel/gtk/GtkTreeModel.html">GtkTreeModel</a> and  <a href="http://developer.gnome.org/devel/gtk/GtkTreeSortable.html">GtkTreeSortable</a>.</p>
 
96
 <a href="http://developer.gnome.org/gtk2/GtkTreeModel.html">GtkTreeModel</a> and  <a href="http://developer.gnome.org/gtk2/GtkTreeSortable.html">GtkTreeSortable</a>.</p>
97
97
</div>
98
98
<div class="refsect1">
99
99
<a name="GcrCollectionModel.properties"></a><h2>Properties</h2>
106
106
<div class="refsect1">
107
107
<a name="GcrCollectionModel.description"></a><h2>Description</h2>
108
108
<p>
109
 
This is an implementation of <a href="http://developer.gnome.org/devel/gtk/GtkTreeModel.html"><span class="type">GtkTreeModel</span></a> which represents the objects in
 
109
This is an implementation of <a href="http://developer.gnome.org/gtk2/GtkTreeModel.html"><span class="type">GtkTreeModel</span></a> which represents the objects in
110
110
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,
111
111
rows are added and removed from this model.
112
112
</p>
135
135
<a name="GcrCollectionModel-struct"></a><h3>struct GcrCollectionModel</h3>
136
136
<pre class="programlisting">struct GcrCollectionModel;</pre>
137
137
<p>
138
 
A <a href="http://developer.gnome.org/devel/gtk/GtkTreeModel.html"><span class="type">GtkTreeModel</span></a> which contains a row for each object in a <a class="link" href="GcrCollection.html" title="GcrCollection"><span class="type">GcrCollection</span></a>.
 
138
A <a href="http://developer.gnome.org/gtk2/GtkTreeModel.html"><span class="type">GtkTreeModel</span></a> which contains a row for each object in a <a class="link" href="GcrCollection.html" title="GcrCollection"><span class="type">GcrCollection</span></a>.
139
139
</p>
140
140
</div>
141
141
<hr>
148
148
<p>
149
149
The class for <a class="link" href="GcrCollectionModel.html" title="GcrCollectionModel"><span class="type">GcrCollectionModel</span></a>.
150
150
</p>
151
 
<div class="variablelist"><table border="0">
 
151
<div class="variablelist"><table border="0" class="variablelist">
 
152
<colgroup>
152
153
<col align="left" valign="top">
 
154
<col>
 
155
</colgroup>
153
156
<tbody><tr>
154
157
<td><p><span class="term"><a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObjectClass"><span class="type">GObjectClass</span></a> <em class="structfield"><code><a name="GcrCollectionModelClass.parent-class"></a>parent_class</code></em>;</span></p></td>
155
158
<td>The parent class</td>
169
172
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
170
173
objects include as child rows in a tree form.
171
174
</p>
172
 
<div class="variablelist"><table border="0">
 
175
<div class="variablelist"><table border="0" class="variablelist">
 
176
<colgroup>
173
177
<col align="left" valign="top">
 
178
<col>
 
179
</colgroup>
174
180
<tbody>
175
181
<tr>
176
182
<td><p><a name="GCR-COLLECTION-MODEL-LIST:CAPS"></a><span class="term"><code class="literal">GCR_COLLECTION_MODEL_LIST</code></span></p></td>
196
202
pairs of property names, and <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"><span class="type">GType</span></a> values. The variable argument list should
197
203
be terminated with <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.
198
204
</p>
199
 
<div class="variablelist"><table border="0">
 
205
<div class="variablelist"><table border="0" class="variablelist">
 
206
<colgroup>
200
207
<col align="left" valign="top">
 
208
<col>
 
209
</colgroup>
201
210
<tbody>
202
211
<tr>
203
212
<td><p><span class="term"><em class="parameter"><code>collection</code></em> :</span></p></td>
229
238
<p>
230
239
Create a new <a class="link" href="GcrCollectionModel.html" title="GcrCollectionModel"><span class="type">GcrCollectionModel</span></a>.
231
240
</p>
232
 
<div class="variablelist"><table border="0">
 
241
<div class="variablelist"><table border="0" class="variablelist">
 
242
<colgroup>
233
243
<col align="left" valign="top">
 
244
<col>
 
245
</colgroup>
234
246
<tbody>
235
247
<tr>
236
248
<td><p><span class="term"><em class="parameter"><code>collection</code></em> :</span></p></td>
271
283
The columns are accessed as static data. They should continue to remain
272
284
in memory for longer than the GcrCollectionModel object.
273
285
</p>
274
 
<div class="variablelist"><table border="0">
 
286
<div class="variablelist"><table border="0" class="variablelist">
 
287
<colgroup>
275
288
<col align="left" valign="top">
 
289
<col>
 
290
</colgroup>
276
291
<tbody>
277
292
<tr>
278
293
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
296
311
<p>
297
312
Get the collection which this model represents
298
313
</p>
299
 
<div class="variablelist"><table border="0">
 
314
<div class="variablelist"><table border="0" class="variablelist">
 
315
<colgroup>
300
316
<col align="left" valign="top">
 
317
<col>
 
318
</colgroup>
301
319
<tbody>
302
320
<tr>
303
321
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
325
343
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            gcr_collection_model_iter_for_object
326
344
                                                        (<em class="parameter"><code><a class="link" href="GcrCollectionModel.html" title="GcrCollectionModel"><span class="type">GcrCollectionModel</span></a> *self</code></em>,
327
345
                                                         <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> *object</code></em>,
328
 
                                                         <em class="parameter"><code><a href="http://developer.gnome.org/devel/gtk/GtkTreeModel.html#GtkTreeIter"><span class="type">GtkTreeIter</span></a> *iter</code></em>);</pre>
 
346
                                                         <em class="parameter"><code><a href="http://developer.gnome.org/gtk2/GtkTreeModel.html#GtkTreeIter"><span class="type">GtkTreeIter</span></a> *iter</code></em>);</pre>
329
347
<p>
330
348
Set <em class="parameter"><code>iter</code></em> to the row for the given object. If the object is not in this
331
349
model, then <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> will be returned.
332
350
</p>
333
 
<div class="variablelist"><table border="0">
 
351
<div class="variablelist"><table border="0" class="variablelist">
 
352
<colgroup>
334
353
<col align="left" valign="top">
 
354
<col>
 
355
</colgroup>
335
356
<tbody>
336
357
<tr>
337
358
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
358
379
<a name="gcr-collection-model-object-for-iter"></a><h3>gcr_collection_model_object_for_iter ()</h3>
359
380
<pre class="programlisting"><a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="returnvalue">GObject</span></a> *           gcr_collection_model_object_for_iter
360
381
                                                        (<em class="parameter"><code><a class="link" href="GcrCollectionModel.html" title="GcrCollectionModel"><span class="type">GcrCollectionModel</span></a> *self</code></em>,
361
 
                                                         <em class="parameter"><code>const <a href="http://developer.gnome.org/devel/gtk/GtkTreeModel.html#GtkTreeIter"><span class="type">GtkTreeIter</span></a> *iter</code></em>);</pre>
 
382
                                                         <em class="parameter"><code>const <a href="http://developer.gnome.org/gtk2/GtkTreeModel.html#GtkTreeIter"><span class="type">GtkTreeIter</span></a> *iter</code></em>);</pre>
362
383
<p>
363
384
Get the object that is represented by the given row in the model.
364
385
</p>
365
 
<div class="variablelist"><table border="0">
 
386
<div class="variablelist"><table border="0" class="variablelist">
 
387
<colgroup>
366
388
<col align="left" valign="top">
 
389
<col>
 
390
</colgroup>
367
391
<tbody>
368
392
<tr>
369
393
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
385
409
<div class="refsect2">
386
410
<a name="gcr-collection-model-is-selected"></a><h3>gcr_collection_model_is_selected ()</h3>
387
411
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/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>,
388
 
                                                         <em class="parameter"><code><a href="http://developer.gnome.org/devel/gtk/GtkTreeModel.html#GtkTreeIter"><span class="type">GtkTreeIter</span></a> *iter</code></em>);</pre>
 
412
                                                         <em class="parameter"><code><a href="http://developer.gnome.org/gtk2/GtkTreeModel.html#GtkTreeIter"><span class="type">GtkTreeIter</span></a> *iter</code></em>);</pre>
389
413
<p>
390
414
Check whether a given row has been toggled as selected.
391
415
</p>
392
 
<div class="variablelist"><table border="0">
 
416
<div class="variablelist"><table border="0" class="variablelist">
 
417
<colgroup>
393
418
<col align="left" valign="top">
 
419
<col>
 
420
</colgroup>
394
421
<tbody>
395
422
<tr>
396
423
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
412
439
<a name="gcr-collection-model-change-selected"></a><h3>gcr_collection_model_change_selected ()</h3>
413
440
<pre class="programlisting"><span class="returnvalue">void</span>                gcr_collection_model_change_selected
414
441
                                                        (<em class="parameter"><code><a class="link" href="GcrCollectionModel.html" title="GcrCollectionModel"><span class="type">GcrCollectionModel</span></a> *self</code></em>,
415
 
                                                         <em class="parameter"><code><a href="http://developer.gnome.org/devel/gtk/GtkTreeModel.html#GtkTreeIter"><span class="type">GtkTreeIter</span></a> *iter</code></em>,
 
442
                                                         <em class="parameter"><code><a href="http://developer.gnome.org/gtk2/GtkTreeModel.html#GtkTreeIter"><span class="type">GtkTreeIter</span></a> *iter</code></em>,
416
443
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> selected</code></em>);</pre>
417
444
<p>
418
445
Set whether a given row is toggled selected or not.
419
446
</p>
420
 
<div class="variablelist"><table border="0">
 
447
<div class="variablelist"><table border="0" class="variablelist">
 
448
<colgroup>
421
449
<col align="left" valign="top">
 
450
<col>
 
451
</colgroup>
422
452
<tbody>
423
453
<tr>
424
454
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
440
470
<a name="gcr-collection-model-toggle-selected"></a><h3>gcr_collection_model_toggle_selected ()</h3>
441
471
<pre class="programlisting"><span class="returnvalue">void</span>                gcr_collection_model_toggle_selected
442
472
                                                        (<em class="parameter"><code><a class="link" href="GcrCollectionModel.html" title="GcrCollectionModel"><span class="type">GcrCollectionModel</span></a> *self</code></em>,
443
 
                                                         <em class="parameter"><code><a href="http://developer.gnome.org/devel/gtk/GtkTreeModel.html#GtkTreeIter"><span class="type">GtkTreeIter</span></a> *iter</code></em>);</pre>
 
473
                                                         <em class="parameter"><code><a href="http://developer.gnome.org/gtk2/GtkTreeModel.html#GtkTreeIter"><span class="type">GtkTreeIter</span></a> *iter</code></em>);</pre>
444
474
<p>
445
475
Toggle the selected state of a given row.
446
476
</p>
447
 
<div class="variablelist"><table border="0">
 
477
<div class="variablelist"><table border="0" class="variablelist">
 
478
<colgroup>
448
479
<col align="left" valign="top">
 
480
<col>
 
481
</colgroup>
449
482
<tbody>
450
483
<tr>
451
484
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
466
499
<p>
467
500
Get a list of checked/selected objects.
468
501
</p>
469
 
<div class="variablelist"><table border="0">
 
502
<div class="variablelist"><table border="0" class="variablelist">
 
503
<colgroup>
470
504
<col align="left" valign="top">
 
505
<col>
 
506
</colgroup>
471
507
<tbody>
472
508
<tr>
473
509
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
491
527
<p>
492
528
Set the checked/selected objects.
493
529
</p>
494
 
<div class="variablelist"><table border="0">
 
530
<div class="variablelist"><table border="0" class="variablelist">
 
531
<colgroup>
495
532
<col align="left" valign="top">
 
533
<col>
 
534
</colgroup>
496
535
<tbody>
497
536
<tr>
498
537
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
515
554
Get the column identifier for the column that contains the values
516
555
of the selected state.
517
556
</p>
518
 
<div class="variablelist"><table border="0">
 
557
<div class="variablelist"><table border="0" class="variablelist">
 
558
<colgroup>
519
559
<col align="left" valign="top">
 
560
<col>
 
561
</colgroup>
520
562
<tbody>
521
563
<tr>
522
564
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>