← Back to branch summary

~ubuntu-branches/ubuntu/lucid/rhythmbox/lucid

« back to all changes in this revision

Viewing changes to doc/reference/html/RhythmDBPropertyModel.html

  • Committer: Bazaar Package Importer
  • Author(s): Sebastien Bacher
  • Date: 2010-03-29 10:12:48 UTC
  • mfrom: (1.1.45 upstream)
  • Revision ID: james.westby@ubuntu.com-20100329101248-fu29j0q1s2dx8k99
Tags: 0.12.8-0ubuntu1
* New upstream version
* debian/patches/90_autoreconf.patch:
  - new version update

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/reference/html/RhythmDBPropertyModel.html
8
8
<link rel="up" href="ch04.html" title="RhythmDB">
9
9
<link rel="prev" href="RhythmDBImportJob.html" title="RhythmDBImportJob">
10
10
<link rel="next" href="RhythmDBQueryModel.html" title="RhythmDBQueryModel">
11
 
<meta name="generator" content="GTK-Doc V1.11 (XML mode)">
 
11
<meta name="generator" content="GTK-Doc V1.13 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
13
<link rel="chapter" href="ch01.html" title="Backends">
14
14
<link rel="chapter" href="ch02.html" title="Lib">
29
29
</tr>
30
30
<tr><td colspan="5" class="shortcuts">
31
31
<a href="#RhythmDBPropertyModel.synopsis" class="shortcut">Top</a>
32
 
                 | 
33
 
                <a href="#RhythmDBPropertyModel.description" class="shortcut">Description</a>
34
 
                 | 
35
 
                <a href="#RhythmDBPropertyModel.object-hierarchy" class="shortcut">Object Hierarchy</a>
36
 
                 | 
37
 
                <a href="#RhythmDBPropertyModel.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
38
 
                 | 
39
 
                <a href="#RhythmDBPropertyModel.properties" class="shortcut">Properties</a>
40
 
                 | 
41
 
                <a href="#RhythmDBPropertyModel.signals" class="shortcut">Signals</a>
 
32
                   | 
 
33
                  <a href="#RhythmDBPropertyModel.description" class="shortcut">Description</a>
 
34
                   | 
 
35
                  <a href="#RhythmDBPropertyModel.object-hierarchy" class="shortcut">Object Hierarchy</a>
 
36
                   | 
 
37
                  <a href="#RhythmDBPropertyModel.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
 
38
                   | 
 
39
                  <a href="#RhythmDBPropertyModel.properties" class="shortcut">Properties</a>
 
40
                   | 
 
41
                  <a href="#RhythmDBPropertyModel.signals" class="shortcut">Signals</a>
42
42
</td></tr>
43
43
</table>
44
44
<div class="refentry" title="RhythmDBPropertyModel">
52
52
</tr></table></div>
53
53
<div class="refsynopsisdiv" title="Synopsis">
54
54
<a name="RhythmDBPropertyModel.synopsis"></a><h2>Synopsis</h2>
55
 
<pre class="synopsis">
56
 
                    <a class="link" href="RhythmDBPropertyModel.html#RhythmDBPropertyModel-struct" title="RhythmDBPropertyModel">RhythmDBPropertyModel</a>;
 
55
<pre class="synopsis">                    <a class="link" href="RhythmDBPropertyModel.html#RhythmDBPropertyModel-struct" title="RhythmDBPropertyModel">RhythmDBPropertyModel</a>;
57
56
                    <a class="link" href="RhythmDBPropertyModel.html#RhythmDBPropertyModelClass" title="RhythmDBPropertyModelClass">RhythmDBPropertyModelClass</a>;
58
57
enum                <a class="link" href="RhythmDBPropertyModel.html#RhythmDBPropertyModelColumn" title="enum RhythmDBPropertyModelColumn">RhythmDBPropertyModelColumn</a>;
59
 
<a class="link" href="RhythmDBPropertyModel.html" title="RhythmDBPropertyModel">RhythmDBPropertyModel</a> * <a class="link" href="RhythmDBPropertyModel.html#rhythmdb-property-model-new" title="rhythmdb_property_model_new ()">rhythmdb_property_model_new</a>     (<a class="link" href="RhythmDB.html" title="RhythmDB">RhythmDB</a> *db,
60
 
                                                         <a class="link" href="RhythmDB.html#RhythmDBPropType" title="enum RhythmDBPropType">RhythmDBPropType</a> propid);
61
 
<a
62
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
63
 
>gboolean</a>            <a class="link" href="RhythmDBPropertyModel.html#rhythmdb-property-model-iter-from-string" title="rhythmdb_property_model_iter_from_string ()">rhythmdb_property_model_iter_from_string</a>
64
 
                                                        (<a class="link" href="RhythmDBPropertyModel.html" title="RhythmDBPropertyModel">RhythmDBPropertyModel</a> *model,
65
 
                                                         const char *name,
66
 
                                                         <a
67
 
href="http://library.gnome.org/devel/gtk/unstable/GtkTreeModel.html#GtkTreeIter"
68
 
>GtkTreeIter</a> *iter);
69
 
void                <a class="link" href="RhythmDBPropertyModel.html#rhythmdb-property-model-enable-drag" title="rhythmdb_property_model_enable_drag ()">rhythmdb_property_model_enable_drag</a> (<a class="link" href="RhythmDBPropertyModel.html" title="RhythmDBPropertyModel">RhythmDBPropertyModel</a> *model,
70
 
                                                         <a
71
 
href="http://library.gnome.org/devel/gtk/unstable/GtkTreeView.html"
72
 
>GtkTreeView</a> *view);
 
58
<a class="link" href="RhythmDBPropertyModel.html" title="RhythmDBPropertyModel"><span class="returnvalue">RhythmDBPropertyModel</span></a> * <a class="link" href="RhythmDBPropertyModel.html#rhythmdb-property-model-new" title="rhythmdb_property_model_new ()">rhythmdb_property_model_new</a>     (<a class="link" href="RhythmDB.html" title="RhythmDB"><span class="returnvalue">RhythmDB</span></a> *db,
 
59
                                                         <a class="link" href="RhythmDB.html#RhythmDBPropType" title="enum RhythmDBPropType"><span class="returnvalue">RhythmDBPropType</span></a> propid);
 
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="RhythmDBPropertyModel.html#rhythmdb-property-model-iter-from-string" title="rhythmdb_property_model_iter_from_string ()">rhythmdb_property_model_iter_from_string</a>
 
61
                                                        (<a class="link" href="RhythmDBPropertyModel.html" title="RhythmDBPropertyModel"><span class="returnvalue">RhythmDBPropertyModel</span></a> *model,
 
62
                                                         const <span class="returnvalue">char</span> *name,
 
63
                                                         <a href="http://library.gnome.org/devel/gtk/unstable/GtkTreeModel.html#GtkTreeIter"><span class="returnvalue">GtkTreeIter</span></a> *iter);
 
64
<span class="returnvalue">void</span>                <a class="link" href="RhythmDBPropertyModel.html#rhythmdb-property-model-enable-drag" title="rhythmdb_property_model_enable_drag ()">rhythmdb_property_model_enable_drag</a> (<a class="link" href="RhythmDBPropertyModel.html" title="RhythmDBPropertyModel"><span class="returnvalue">RhythmDBPropertyModel</span></a> *model,
 
65
                                                         <a href="http://library.gnome.org/devel/gtk/unstable/GtkTreeView.html"><span class="returnvalue">GtkTreeView</span></a> *view);
73
66
</pre>
74
67
</div>
75
68
<div class="refsect1" title="Object Hierarchy">
76
69
<a name="RhythmDBPropertyModel.object-hierarchy"></a><h2>Object Hierarchy</h2>
77
70
<pre class="synopsis">
78
 
  <a
79
 
href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"
80
 
>GObject</a>
 
71
  <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
81
72
   +----RhythmDBPropertyModel
82
73
</pre>
83
74
</div>
85
76
<a name="RhythmDBPropertyModel.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
86
77
<p>
87
78
RhythmDBPropertyModel implements
88
 
 <a
89
 
href="http://library.gnome.org/devel/gtk/unstable/GtkTreeModel.html"
90
 
>GtkTreeModel</a> and  <a class="link" href="rhythmbox-rb-tree-dnd.html#RbTreeDragSource">RbTreeDragSource</a>.</p>
 
79
 <a href="http://library.gnome.org/devel/gtk/unstable/GtkTreeModel.html">GtkTreeModel</a> and  <a class="link" href="rhythmbox-rb-tree-dnd.html#RbTreeDragSource">RbTreeDragSource</a>.</p>
91
80
</div>
92
81
<div class="refsect1" title="Properties">
93
82
<a name="RhythmDBPropertyModel.properties"></a><h2>Properties</h2>
94
83
<pre class="synopsis">
95
 
  "<a class="link" href="RhythmDBPropertyModel.html#RhythmDBPropertyModel--db" title='The "db" property'>db</a>"                       <a class="link" href="RhythmDB.html" title="RhythmDB">RhythmDB</a>*             : Read / Write / Construct Only
96
 
  "<a class="link" href="RhythmDBPropertyModel.html#RhythmDBPropertyModel--prop" title='The "prop" property'>prop</a>"                     <a
97
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"
98
 
>gint</a>                  : Read / Write / Construct Only
99
 
  "<a class="link" href="RhythmDBPropertyModel.html#RhythmDBPropertyModel--query-model" title='The "query-model" property'>query-model</a>"              <a class="link" href="RhythmDBQueryModel.html" title="RhythmDBQueryModel">RhythmDBQueryModel</a>*   : Read / Write
 
84
  "<a class="link" href="RhythmDBPropertyModel.html#RhythmDBPropertyModel--db" title='The "db" property'>db</a>"                       <a class="link" href="RhythmDB.html" title="RhythmDB"><span class="type">RhythmDB</span></a>*             : Read / Write / Construct Only
 
85
  "<a class="link" href="RhythmDBPropertyModel.html#RhythmDBPropertyModel--prop" title='The "prop" property'>prop</a>"                     <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write / Construct Only
 
86
  "<a class="link" href="RhythmDBPropertyModel.html#RhythmDBPropertyModel--query-model" title='The "query-model" property'>query-model</a>"              <a class="link" href="RhythmDBQueryModel.html" title="RhythmDBQueryModel"><span class="type">RhythmDBQueryModel</span></a>*   : Read / Write
100
87
</pre>
101
88
</div>
102
89
<div class="refsect1" title="Signals">
111
98
A RhythmDBPropertyModel groups the entries in a <a class="link" href="RhythmDBQueryModel.html" title="RhythmDBQueryModel"><span class="type">RhythmDBQueryModel</span></a> by
112
99
the value of a property.  For example, a RhythmDBPropertyModel using
113
100
the RHYTHMDB_PROP_ARTIST property can be used as the model for a 
114
 
<a
115
 
href="http://library.gnome.org/devel/gtk/unstable/GtkTreeView.html"
116
 
><span class="type">GtkTreeView</span></a> that will list the artists present in the query model.
 
101
<a href="http://library.gnome.org/devel/gtk/unstable/GtkTreeView.html"><span class="type">GtkTreeView</span></a> that will list the artists present in the query model.
117
102
</p>
118
103
<p>
119
104
The album/artist/genre browsers displayed in the library and other sources are
120
105
populated using a RhythmDBPropertyModel for each property.</p>
121
 
<p>
122
 
</p>
123
106
</div>
124
107
<div class="refsect1" title="Details">
125
108
<a name="RhythmDBPropertyModel.details"></a><h2>Details</h2>
158
141
<hr>
159
142
<div class="refsect2" title="rhythmdb_property_model_new ()">
160
143
<a name="rhythmdb-property-model-new"></a><h3>rhythmdb_property_model_new ()</h3>
161
 
<pre class="programlisting"><a class="link" href="RhythmDBPropertyModel.html" title="RhythmDBPropertyModel">RhythmDBPropertyModel</a> * rhythmdb_property_model_new     (<a class="link" href="RhythmDB.html" title="RhythmDB">RhythmDB</a> *db,
162
 
                                                         <a class="link" href="RhythmDB.html#RhythmDBPropType" title="enum RhythmDBPropType">RhythmDBPropType</a> propid);</pre>
 
144
<pre class="programlisting"><a class="link" href="RhythmDBPropertyModel.html" title="RhythmDBPropertyModel"><span class="returnvalue">RhythmDBPropertyModel</span></a> * rhythmdb_property_model_new     (<a class="link" href="RhythmDB.html" title="RhythmDB"><span class="returnvalue">RhythmDB</span></a> *db,
 
145
                                                         <a class="link" href="RhythmDB.html#RhythmDBPropType" title="enum RhythmDBPropType"><span class="returnvalue">RhythmDBPropType</span></a> propid);</pre>
163
146
<p>
164
147
Creates a new property model for the specified property ID.</p>
165
 
<p>
166
 
</p>
167
148
<div class="variablelist"><table border="0">
168
149
<col align="left" valign="top">
169
150
<tbody>
188
169
<hr>
189
170
<div class="refsect2" title="rhythmdb_property_model_iter_from_string ()">
190
171
<a name="rhythmdb-property-model-iter-from-string"></a><h3>rhythmdb_property_model_iter_from_string ()</h3>
191
 
<pre class="programlisting"><a
192
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
193
 
>gboolean</a>            rhythmdb_property_model_iter_from_string
194
 
                                                        (<a class="link" href="RhythmDBPropertyModel.html" title="RhythmDBPropertyModel">RhythmDBPropertyModel</a> *model,
195
 
                                                         const char *name,
196
 
                                                         <a
197
 
href="http://library.gnome.org/devel/gtk/unstable/GtkTreeModel.html#GtkTreeIter"
198
 
>GtkTreeIter</a> *iter);</pre>
 
172
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            rhythmdb_property_model_iter_from_string
 
173
                                                        (<a class="link" href="RhythmDBPropertyModel.html" title="RhythmDBPropertyModel"><span class="returnvalue">RhythmDBPropertyModel</span></a> *model,
 
174
                                                         const <span class="returnvalue">char</span> *name,
 
175
                                                         <a href="http://library.gnome.org/devel/gtk/unstable/GtkTreeModel.html#GtkTreeIter"><span class="returnvalue">GtkTreeIter</span></a> *iter);</pre>
199
176
<p>
200
177
Locates the row in the model for a property value.</p>
201
 
<p>
202
 
</p>
203
178
<div class="variablelist"><table border="0">
204
179
<col align="left" valign="top">
205
180
<tbody>
215
190
</tr>
216
191
<tr>
217
192
<td><p><span class="term"><em class="parameter"><code>iter</code></em> :</span></p></td>
218
 
<td> a <a
219
 
href="http://library.gnome.org/devel/gtk/unstable/GtkTreeModel.html#GtkTreeIter"
220
 
><span class="type">GtkTreeIter</span></a> to point to the row
 
193
<td> a <a href="http://library.gnome.org/devel/gtk/unstable/GtkTreeModel.html#GtkTreeIter"><span class="type">GtkTreeIter</span></a> to point to the row
221
194
</td>
222
195
</tr>
223
196
<tr>
231
204
<hr>
232
205
<div class="refsect2" title="rhythmdb_property_model_enable_drag ()">
233
206
<a name="rhythmdb-property-model-enable-drag"></a><h3>rhythmdb_property_model_enable_drag ()</h3>
234
 
<pre class="programlisting">void                rhythmdb_property_model_enable_drag (<a class="link" href="RhythmDBPropertyModel.html" title="RhythmDBPropertyModel">RhythmDBPropertyModel</a> *model,
235
 
                                                         <a
236
 
href="http://library.gnome.org/devel/gtk/unstable/GtkTreeView.html"
237
 
>GtkTreeView</a> *view);</pre>
 
207
<pre class="programlisting"><span class="returnvalue">void</span>                rhythmdb_property_model_enable_drag (<a class="link" href="RhythmDBPropertyModel.html" title="RhythmDBPropertyModel"><span class="returnvalue">RhythmDBPropertyModel</span></a> *model,
 
208
                                                         <a href="http://library.gnome.org/devel/gtk/unstable/GtkTreeView.html"><span class="returnvalue">GtkTreeView</span></a> *view);</pre>
238
209
<p>
239
 
Enables drag and drop from a specified <a
240
 
href="http://library.gnome.org/devel/gtk/unstable/GtkTreeView.html"
241
 
><span class="type">GtkTreeView</span></a> that is
 
210
Enables drag and drop from a specified <a href="http://library.gnome.org/devel/gtk/unstable/GtkTreeView.html"><span class="type">GtkTreeView</span></a> that is
242
211
backed by the <a class="link" href="RhythmDBPropertyModel.html" title="RhythmDBPropertyModel"><span class="type">RhythmDBPropertyModel</span></a>.  Drag targets are
243
212
determined by the indexed property.</p>
244
 
<p>
245
 
</p>
246
213
<div class="variablelist"><table border="0">
247
214
<col align="left" valign="top">
248
215
<tbody>
253
220
</tr>
254
221
<tr>
255
222
<td><p><span class="term"><em class="parameter"><code>view</code></em> :</span></p></td>
256
 
<td> the <a
257
 
href="http://library.gnome.org/devel/gtk/unstable/GtkTreeView.html"
258
 
><span class="type">GtkTreeView</span></a> from which to enable drag and drop
 
223
<td> the <a href="http://library.gnome.org/devel/gtk/unstable/GtkTreeView.html"><span class="type">GtkTreeView</span></a> from which to enable drag and drop
259
224
</td>
260
225
</tr>
261
226
</tbody>
266
231
<a name="RhythmDBPropertyModel.property-details"></a><h2>Property Details</h2>
267
232
<div class="refsect2" title='The "db" property'>
268
233
<a name="RhythmDBPropertyModel--db"></a><h3>The <code class="literal">"db"</code> property</h3>
269
 
<pre class="programlisting">  "db"                       <a class="link" href="RhythmDB.html" title="RhythmDB">RhythmDB</a>*             : Read / Write / Construct Only</pre>
 
234
<pre class="programlisting">  "db"                       <a class="link" href="RhythmDB.html" title="RhythmDB"><span class="type">RhythmDB</span></a>*             : Read / Write / Construct Only</pre>
270
235
<p>
271
236
The <a class="link" href="RhythmDB.html" title="RhythmDB"><span class="type">RhythmDB</span></a> object the model is associated with.</p>
272
 
<p>
273
 
</p>
274
237
</div>
275
238
<hr>
276
239
<div class="refsect2" title='The "prop" property'>
277
240
<a name="RhythmDBPropertyModel--prop"></a><h3>The <code class="literal">"prop"</code> property</h3>
278
 
<pre class="programlisting">  "prop"                     <a
279
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"
280
 
>gint</a>                  : Read / Write / Construct Only</pre>
 
241
<pre class="programlisting">  "prop"                     <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write / Construct Only</pre>
281
242
<p>
282
243
The property that this property model indexes.</p>
283
 
<p>
284
 
</p>
285
244
<p>Allowed values: [0,59]</p>
286
245
<p>Default value: 0</p>
287
246
</div>
288
247
<hr>
289
248
<div class="refsect2" title='The "query-model" property'>
290
249
<a name="RhythmDBPropertyModel--query-model"></a><h3>The <code class="literal">"query-model"</code> property</h3>
291
 
<pre class="programlisting">  "query-model"              <a class="link" href="RhythmDBQueryModel.html" title="RhythmDBQueryModel">RhythmDBQueryModel</a>*   : Read / Write</pre>
 
250
<pre class="programlisting">  "query-model"              <a class="link" href="RhythmDBQueryModel.html" title="RhythmDBQueryModel"><span class="type">RhythmDBQueryModel</span></a>*   : Read / Write</pre>
292
251
<p>
293
252
The query model that this property model indexes.</p>
294
 
<p>
295
 
</p>
296
253
</div>
297
254
</div>
298
255
<div class="refsect1" title="Signal Details">
299
256
<a name="RhythmDBPropertyModel.signal-details"></a><h2>Signal Details</h2>
300
257
<div class="refsect2" title='The "pre-row-deletion" signal'>
301
258
<a name="RhythmDBPropertyModel-pre-row-deletion"></a><h3>The <code class="literal">"pre-row-deletion"</code> signal</h3>
302
 
<pre class="programlisting">void                user_function                      (<a class="link" href="RhythmDBPropertyModel.html" title="RhythmDBPropertyModel">RhythmDBPropertyModel</a> *model,
303
 
                                                        <a
304
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"
305
 
>gpointer</a>               user_data)      : Run Last</pre>
 
259
<pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="RhythmDBPropertyModel.html" title="RhythmDBPropertyModel"><span class="type">RhythmDBPropertyModel</span></a> *model,
 
260
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>               user_data)      : Run Last</pre>
306
261
<p>
307
262
Emitted just before a row is deleted from the model.</p>
308
 
<p>
309
 
</p>
310
263
<div class="variablelist"><table border="0">
311
264
<col align="left" valign="top">
312
265
<tbody>
326
279
</div>
327
280
<div class="footer">
328
281
<hr>
329
 
          Generated by GTK-Doc V1.11</div>
 
282
          Generated by GTK-Doc V1.13</div>
330
283
</body>
331
 
</html>
 
284
</html>
 
 
b'\\ No newline at end of file'