← Back to branch summary

~ubuntu-branches/ubuntu/quantal/rhythmbox/quantal-proposed

« back to all changes in this revision

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

  • Committer: Package Import Robot
  • Author(s): Didier Roche
  • Date: 2012-01-17 16:56:40 UTC
  • mfrom: (1.1.62)
  • Revision ID: package-import@ubuntu.com-20120117165640-pr034mkhmti3efh6
Tags: 2.95-0ubuntu1
https://launchpad.net/bugs/461279
* New upstream release:
  - wrong shortcut for Show / Hide the Queue Sidebar (LP: #461279)
* debian/watch:
  - update to latest url    
* debian/patches/00_fix_for_glib_2.32.patch:
  - was taken upstream, removed

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/reference/html/RBSongInfo.html
8
8
<link rel="up" href="ch07.html" title="Widgets">
9
9
<link rel="prev" href="RBSearchEntry.html" title="RBSearchEntry">
10
10
<link rel="next" href="RBURIDialog.html" title="RBURIDialog">
11
 
<meta name="generator" content="GTK-Doc V1.18.1 (XML mode)">
 
11
<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
13
</head>
14
14
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
47
47
<a name="RBSongInfo.synopsis"></a><h2>Synopsis</h2>
48
48
<pre class="synopsis">struct              <a class="link" href="RBSongInfo.html#RBSongInfo-struct" title="struct RBSongInfo">RBSongInfo</a>;
49
49
struct              <a class="link" href="RBSongInfo.html#RBSongInfoClass" title="struct RBSongInfoClass">RBSongInfoClass</a>;
50
 
<a href="http://library.gnome.org/devel/gtk/GtkWidget.html"><span class="returnvalue">GtkWidget</span></a> *         <a class="link" href="RBSongInfo.html#rb-song-info-new" title="rb_song_info_new ()">rb_song_info_new</a>                    (<em class="parameter"><code><a class="link" href="RBSource.html" title="RBSource"><span class="type">RBSource</span></a> *source</code></em>,
 
50
<span class="returnvalue">GtkWidget</span> *         <a class="link" href="RBSongInfo.html#rb-song-info-new" title="rb_song_info_new ()">rb_song_info_new</a>                    (<em class="parameter"><code><a class="link" href="RBSource.html" title="RBSource"><span class="type">RBSource</span></a> *source</code></em>,
51
51
                                                         <em class="parameter"><code><a class="link" href="RBEntryView.html" title="RBEntryView"><span class="type">RBEntryView</span></a> *entry_view</code></em>);
52
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               <a class="link" href="RBSongInfo.html#rb-song-info-append-page" title="rb_song_info_append_page ()">rb_song_info_append_page</a>            (<em class="parameter"><code><a class="link" href="RBSongInfo.html" title="RBSongInfo"><span class="type">RBSongInfo</span></a> *info</code></em>,
 
52
<span class="returnvalue">guint</span>               <a class="link" href="RBSongInfo.html#rb-song-info-append-page" title="rb_song_info_append_page ()">rb_song_info_append_page</a>            (<em class="parameter"><code><a class="link" href="RBSongInfo.html" title="RBSongInfo"><span class="type">RBSongInfo</span></a> *info</code></em>,
53
53
                                                         <em class="parameter"><code>const <span class="type">char</span> *title</code></em>,
54
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gtk/GtkWidget.html"><span class="type">GtkWidget</span></a> *page</code></em>);
 
54
                                                         <em class="parameter"><code><span class="type">GtkWidget</span> *page</code></em>);
55
55
</pre>
56
56
</div>
57
57
<div class="refsect1">
58
58
<a name="RBSongInfo.object-hierarchy"></a><h2>Object Hierarchy</h2>
59
59
<pre class="synopsis">
60
 
  <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
61
 
   +----<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
62
 
         +----<a href="http://library.gnome.org/devel/gtk/GtkWidget.html">GtkWidget</a>
63
 
               +----<a href="http://library.gnome.org/devel/gtk/GtkContainer.html">GtkContainer</a>
64
 
                     +----<a href="http://library.gnome.org/devel/gtk/GtkBin.html">GtkBin</a>
65
 
                           +----<a href="http://library.gnome.org/devel/gtk/GtkWindow.html">GtkWindow</a>
66
 
                                 +----<a href="http://library.gnome.org/devel/gtk/GtkDialog.html">GtkDialog</a>
 
60
  GObject
 
61
   +----GInitiallyUnowned
 
62
         +----GtkWidget
 
63
               +----GtkContainer
 
64
                     +----GtkBin
 
65
                           +----GtkWindow
 
66
                                 +----GtkDialog
67
67
                                       +----RBSongInfo
68
68
</pre>
69
69
</div>
71
71
<a name="RBSongInfo.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
72
72
<p>
73
73
RBSongInfo implements
74
 
 AtkImplementorIface and  <a href="http://library.gnome.org/devel/gtk/GtkBuildable.html">GtkBuildable</a>.</p>
 
74
 AtkImplementorIface and  GtkBuildable.</p>
75
75
</div>
76
76
<div class="refsect1">
77
77
<a name="RBSongInfo.properties"></a><h2>Properties</h2>
78
78
<pre class="synopsis">
79
79
  "<a class="link" href="RBSongInfo.html#RBSongInfo--current-entry" title='The "current-entry" property'>current-entry</a>"            <a class="link" href="RhythmDB.html#RhythmDBEntry"><span class="type">RhythmDBEntry</span></a>*        : Read
80
80
  "<a class="link" href="RBSongInfo.html#RBSongInfo--entry-view" title='The "entry-view" property'>entry-view</a>"               <a class="link" href="RBEntryView.html" title="RBEntryView"><span class="type">RBEntryView</span></a>*          : Read / Write / Construct Only
81
 
  "<a class="link" href="RBSongInfo.html#RBSongInfo--selected-entries" title='The "selected-entries" property'>selected-entries</a>"         <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Value-arrays.html#GValueArray"><span class="type">GValueArray</span></a>*          : Read
 
81
  "<a class="link" href="RBSongInfo.html#RBSongInfo--selected-entries" title='The "selected-entries" property'>selected-entries</a>"         <span class="type">GValueArray</span>*          : Read
82
82
  "<a class="link" href="RBSongInfo.html#RBSongInfo--source" title='The "source" property'>source</a>"                   <a class="link" href="RBSource.html" title="RBSource"><span class="type">RBSource</span></a>*             : Read / Write / Construct Only
83
83
</pre>
84
84
</div>
85
85
<div class="refsect1">
86
86
<a name="RBSongInfo.signals"></a><h2>Signals</h2>
87
87
<pre class="synopsis">
88
 
  "<a class="link" href="RBSongInfo.html#RBSongInfo-post-metadata-change" title='The "post-metadata-change" signal'>post-metadata-change</a>"                           : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a>
89
 
  "<a class="link" href="RBSongInfo.html#RBSongInfo-pre-metadata-change" title='The "pre-metadata-change" signal'>pre-metadata-change</a>"                            : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a>
 
88
  "<a class="link" href="RBSongInfo.html#RBSongInfo-post-metadata-change" title='The "post-metadata-change" signal'>post-metadata-change</a>"                           : <code class="literal">Run Last</code>
 
89
  "<a class="link" href="RBSongInfo.html#RBSongInfo-pre-metadata-change" title='The "pre-metadata-change" signal'>pre-metadata-change</a>"                            : <code class="literal">Run Last</code>
90
90
</pre>
91
91
</div>
92
92
<div class="refsect1">
97
97
</p>
98
98
<p>
99
99
This class has two modes.  It can display and edit properties of a single
100
 
entry, in which case it uses a <a href="http://library.gnome.org/devel/gtk/GtkNotebook.html"><span class="type">GtkNotebook</span></a> to split the properties across
 
100
entry, in which case it uses a <span class="type">GtkNotebook</span> to split the properties across
101
101
'basic' and 'details' pages, and it can display and edit properties of
102
102
multiple entries at a time, in which case a smaller set of properties is
103
103
displayed in a single set.
104
104
</p>
105
105
<p>
106
 
In single-entry mode, it is possible to add extra pages to the <a href="http://library.gnome.org/devel/gtk/GtkNotebook.html"><span class="type">GtkNotebook</span></a>
 
106
In single-entry mode, it is possible to add extra pages to the <span class="type">GtkNotebook</span>
107
107
widget in the dialog.  The 'create-song-info' signal is emitted by the <a class="link" href="RBShell.html" title="RBShell"><span class="type">RBShell</span></a>
108
108
object, allowing signal handlers to add pages by calling <a class="link" href="RBSongInfo.html#rb-song-info-append-page" title="rb_song_info_append_page ()"><span class="type">rb_song_info_append_page</span></a>.
109
109
The lyrics plugin is currently the only place where this ability is used.
145
145
<hr>
146
146
<div class="refsect2">
147
147
<a name="rb-song-info-new"></a><h3>rb_song_info_new ()</h3>
148
 
<pre class="programlisting"><a href="http://library.gnome.org/devel/gtk/GtkWidget.html"><span class="returnvalue">GtkWidget</span></a> *         rb_song_info_new                    (<em class="parameter"><code><a class="link" href="RBSource.html" title="RBSource"><span class="type">RBSource</span></a> *source</code></em>,
 
148
<pre class="programlisting"><span class="returnvalue">GtkWidget</span> *         rb_song_info_new                    (<em class="parameter"><code><a class="link" href="RBSource.html" title="RBSource"><span class="type">RBSource</span></a> *source</code></em>,
149
149
                                                         <em class="parameter"><code><a class="link" href="RBEntryView.html" title="RBEntryView"><span class="type">RBEntryView</span></a> *entry_view</code></em>);</pre>
150
150
<p>
151
151
Creates a new <a class="link" href="RBSongInfo.html" title="RBSongInfo"><span class="type">RBSongInfo</span></a> for the selected entry or entries in
173
173
<hr>
174
174
<div class="refsect2">
175
175
<a name="rb-song-info-append-page"></a><h3>rb_song_info_append_page ()</h3>
176
 
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               rb_song_info_append_page            (<em class="parameter"><code><a class="link" href="RBSongInfo.html" title="RBSongInfo"><span class="type">RBSongInfo</span></a> *info</code></em>,
 
176
<pre class="programlisting"><span class="returnvalue">guint</span>               rb_song_info_append_page            (<em class="parameter"><code><a class="link" href="RBSongInfo.html" title="RBSongInfo"><span class="type">RBSongInfo</span></a> *info</code></em>,
177
177
                                                         <em class="parameter"><code>const <span class="type">char</span> *title</code></em>,
178
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gtk/GtkWidget.html"><span class="type">GtkWidget</span></a> *page</code></em>);</pre>
 
178
                                                         <em class="parameter"><code><span class="type">GtkWidget</span> *page</code></em>);</pre>
179
179
<p>
180
180
Adds a new page to the song properties window.  Should be called
181
181
in a handler connected to the <a class="link" href="RBShell.html" title="RBShell"><span class="type">RBShell</span></a> 'create-song-info' signal.
194
194
</tr>
195
195
<tr>
196
196
<td><p><span class="term"><em class="parameter"><code>page</code></em> :</span></p></td>
197
 
<td>the page <a href="http://library.gnome.org/devel/gtk/GtkWidget.html"><span class="type">GtkWidget</span></a>
 
197
<td>the page <span class="type">GtkWidget</span>
198
198
</td>
199
199
</tr>
200
200
<tr>
228
228
<hr>
229
229
<div class="refsect2">
230
230
<a name="RBSongInfo--selected-entries"></a><h3>The <code class="literal">"selected-entries"</code> property</h3>
231
 
<pre class="programlisting">  "selected-entries"         <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Value-arrays.html#GValueArray"><span class="type">GValueArray</span></a>*          : Read</pre>
 
231
<pre class="programlisting">  "selected-entries"         <span class="type">GValueArray</span>*          : Read</pre>
232
232
<p>
233
233
The set of <a class="link" href="RhythmDB.html#RhythmDBEntry"><span class="type">RhythmDBEntry</span></a> objects currently being displayed.  Valid for both
234
234
single-entry and multiple-entry song properties windows.
251
251
<a name="RBSongInfo-post-metadata-change"></a><h3>The <code class="literal">"post-metadata-change"</code> signal</h3>
252
252
<pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="RBSongInfo.html" title="RBSongInfo"><span class="type">RBSongInfo</span></a>    *song_info,
253
253
                                                        <a class="link" href="RhythmDB.html#RhythmDBEntry"><span class="type">RhythmDBEntry</span></a> *entry,
254
 
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>       user_data)      : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a></pre>
 
254
                                                        <span class="type">gpointer</span>       user_data)      : <code class="literal">Run Last</code></pre>
255
255
<p>
256
256
Emitted just after changes have been applied to the database.
257
257
Probably useless.
279
279
<a name="RBSongInfo-pre-metadata-change"></a><h3>The <code class="literal">"pre-metadata-change"</code> signal</h3>
280
280
<pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="RBSongInfo.html" title="RBSongInfo"><span class="type">RBSongInfo</span></a>    *song_info,
281
281
                                                        <a class="link" href="RhythmDB.html#RhythmDBEntry"><span class="type">RhythmDBEntry</span></a> *entry,
282
 
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>       user_data)      : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a></pre>
 
282
                                                        <span class="type">gpointer</span>       user_data)      : <code class="literal">Run Last</code></pre>
283
283
<p>
284
284
Emitted just before the changes made in the song properties window
285
285
are applied to the database.  This is only emitted in the single-entry
307
307
</div>
308
308
<div class="footer">
309
309
<hr>
310
 
          Generated by GTK-Doc V1.18.1</div>
 
310
          Generated by GTK-Doc V1.18</div>
311
311
</body>
312
312
</html>
 
 
b'\\ No newline at end of file'