← Back to branch summary

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

« back to all changes in this revision

Viewing changes to doc/reference/xml/rb-play-queue-source.xml

  • 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/xml/rb-play-queue-source.xml
1
 
<?xml version="1.0"?>
2
 
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" 
3
 
               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
4
 
<refentry id="RBPlayQueueSource">
5
 
<refmeta>
6
 
<refentrytitle role="top_of_page" id="RBPlayQueueSource.top_of_page">RBPlayQueueSource</refentrytitle>
7
 
<manvolnum>3</manvolnum>
8
 
<refmiscinfo>RHYTHMBOX Library</refmiscinfo>
9
 
</refmeta>
10
 
 
11
 
<refnamediv>
12
 
<refname>RBPlayQueueSource</refname>
13
 
<refpurpose>source object for the play queue</refpurpose>
14
 
</refnamediv>
15
 
 
16
 
<refsynopsisdiv id="RBPlayQueueSource.synopsis" role="synopsis">
17
 
<title role="synopsis.title">Synopsis</title>
18
 
 
19
 
<synopsis>
20
 
                    <link linkend="RBPlayQueueSource-struct">RBPlayQueueSource</link>;
21
 
                    <link linkend="RBPlayQueueSourceClass">RBPlayQueueSourceClass</link>;
22
 
<link linkend="RBSource">RBSource</link> *          <link linkend="rb-play-queue-source-new">rb_play_queue_source_new</link>            (<link linkend="RBShell">RBShell</link> *shell);
23
 
<link linkend="void">void</link>                <link linkend="rb-play-queue-source-sidebar-song-info">rb_play_queue_source_sidebar_song_info</link>
24
 
                                                        (<link linkend="RBPlayQueueSource">RBPlayQueueSource</link> *source);
25
 
<link linkend="void">void</link>                <link linkend="rb-play-queue-source-sidebar-delete">rb_play_queue_source_sidebar_delete</link> (<link linkend="RBPlayQueueSource">RBPlayQueueSource</link> *source);
26
 
<link linkend="void">void</link>                <link linkend="rb-play-queue-source-clear-queue">rb_play_queue_source_clear_queue</link>    (<link linkend="RBPlayQueueSource">RBPlayQueueSource</link> *source);
27
 
</synopsis>
28
 
</refsynopsisdiv>
29
 
 
30
 
<refsect1 id="RBPlayQueueSource.object-hierarchy" role="object_hierarchy">
31
 
<title role="object_hierarchy.title">Object Hierarchy</title>
32
 
<synopsis>
33
 
  <link linkend="GObject">GObject</link>
34
 
   +----<link linkend="GInitiallyUnowned">GInitiallyUnowned</link>
35
 
         +----<link linkend="GtkObject">GtkObject</link>
36
 
               +----<link linkend="GtkWidget">GtkWidget</link>
37
 
                     +----<link linkend="GtkContainer">GtkContainer</link>
38
 
                           +----<link linkend="GtkBox">GtkBox</link>
39
 
                                 +----<link linkend="GtkHBox">GtkHBox</link>
40
 
                                       +----<link linkend="RBSource">RBSource</link>
41
 
                                             +----<link linkend="RBPlaylistSource">RBPlaylistSource</link>
42
 
                                                   +----<link linkend="RBStaticPlaylistSource">RBStaticPlaylistSource</link>
43
 
                                                         +----RBPlayQueueSource
44
 
</synopsis>
45
 
</refsect1>
46
 
 
47
 
 
48
 
 
49
 
<refsect1 id="RBPlayQueueSource.implemented-interfaces" role="impl_interfaces">
50
 
<title role="impl_interfaces.title">Implemented Interfaces</title>
51
 
<para>
52
 
RBPlayQueueSource implements
53
 
 <link linkend="AtkImplementorIface">AtkImplementorIface</link>,  <link linkend="GtkBuildable">GtkBuildable</link> and  <link linkend="GtkOrientable">GtkOrientable</link>.</para>
54
 
</refsect1>
55
 
 
56
 
 
57
 
<refsect1 id="RBPlayQueueSource.properties" role="properties">
58
 
<title role="properties.title">Properties</title>
59
 
<synopsis>
60
 
  &quot;<link linkend="RBPlayQueueSource--sidebar">sidebar</link>&quot;                  <link linkend="RBEntryView">RBEntryView</link>*          : Read
61
 
</synopsis>
62
 
</refsect1>
63
 
 
64
 
 
65
 
 
66
 
<refsect1 id="RBPlayQueueSource.description" role="desc">
67
 
<title role="desc.title">Description</title>
68
 
<para>
69
 
The main interesting thing about this source is that is
70
 
contains a second <link linkend="RBEntryView"><type>RBEntryView</type></link> to be displayed in the side
71
 
pane (beneath the source list).  This entry view displays
72
 
the track title, artist, and album in a single column,
73
 
split across three lines so the information mostly fits in
74
 
the usual horizontal space allowed for the side bar.</para>
75
 
<para>
76
 
</para>
77
 
</refsect1>
78
 
 
79
 
<refsect1 id="RBPlayQueueSource.details" role="details">
80
 
<title role="details.title">Details</title>
81
 
<refsect2 id="RBPlayQueueSource-struct" role="struct">
82
 
<title>RBPlayQueueSource</title>
83
 
<indexterm zone="RBPlayQueueSource-struct"><primary sortas="RBPlayQueueSource">RBPlayQueueSource</primary></indexterm><programlisting>typedef struct _RBPlayQueueSource RBPlayQueueSource;</programlisting>
84
 
<para>
85
 
</para></refsect2>
86
 
<refsect2 id="RBPlayQueueSourceClass" role="struct">
87
 
<title>RBPlayQueueSourceClass</title>
88
 
<indexterm zone="RBPlayQueueSourceClass"><primary sortas="RBPlayQueueSourceClass">RBPlayQueueSourceClass</primary></indexterm><programlisting>typedef struct {
89
 
        RBStaticPlaylistSourceClass parent;
90
 
} RBPlayQueueSourceClass;
91
 
</programlisting>
92
 
<para>
93
 
</para></refsect2>
94
 
<refsect2 id="rb-play-queue-source-new" role="function">
95
 
<title>rb_play_queue_source_new ()</title>
96
 
<indexterm zone="rb-play-queue-source-new"><primary sortas="rb_play_queue_source_new">rb_play_queue_source_new</primary></indexterm><programlisting><link linkend="RBSource">RBSource</link> *          rb_play_queue_source_new            (<link linkend="RBShell">RBShell</link> *shell);</programlisting>
97
 
<para>
98
 
Creates the play queue source object.</para>
99
 
<para>
100
 
</para><variablelist role="params">
101
 
<varlistentry><term><parameter>shell</parameter>&#160;:</term>
102
 
<listitem><simpara> the <link linkend="RBShell"><type>RBShell</type></link> instance
103
 
</simpara></listitem></varlistentry>
104
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the play queue source
105
 
</simpara></listitem></varlistentry>
106
 
</variablelist></refsect2>
107
 
<refsect2 id="rb-play-queue-source-sidebar-song-info" role="function">
108
 
<title>rb_play_queue_source_sidebar_song_info ()</title>
109
 
<indexterm zone="rb-play-queue-source-sidebar-song-info"><primary sortas="rb_play_queue_source_sidebar_song_info">rb_play_queue_source_sidebar_song_info</primary></indexterm><programlisting><link linkend="void">void</link>                rb_play_queue_source_sidebar_song_info
110
 
                                                        (<link linkend="RBPlayQueueSource">RBPlayQueueSource</link> *source);</programlisting>
111
 
<para>
112
 
Creates and displays a <link linkend="RBSongInfo"><type>RBSongInfo</type></link> for the currently selected
113
 
entry in the side pane play queue view</para>
114
 
<para>
115
 
</para><variablelist role="params">
116
 
<varlistentry><term><parameter>source</parameter>&#160;:</term>
117
 
<listitem><simpara> the <link linkend="RBPlayQueueSource"><type>RBPlayQueueSource</type></link>
118
 
</simpara></listitem></varlistentry>
119
 
</variablelist></refsect2>
120
 
<refsect2 id="rb-play-queue-source-sidebar-delete" role="function">
121
 
<title>rb_play_queue_source_sidebar_delete ()</title>
122
 
<indexterm zone="rb-play-queue-source-sidebar-delete"><primary sortas="rb_play_queue_source_sidebar_delete">rb_play_queue_source_sidebar_delete</primary></indexterm><programlisting><link linkend="void">void</link>                rb_play_queue_source_sidebar_delete (<link linkend="RBPlayQueueSource">RBPlayQueueSource</link> *source);</programlisting>
123
 
<para>
124
 
Deletes the selected entries from the play queue side pane.
125
 
This is called by the <link linkend="RBShellClipboard"><type>RBShellClipboard</type></link>.</para>
126
 
<para>
127
 
</para><variablelist role="params">
128
 
<varlistentry><term><parameter>source</parameter>&#160;:</term>
129
 
<listitem><simpara> the <link linkend="RBPlayQueueSource"><type>RBPlayQueueSource</type></link>
130
 
</simpara></listitem></varlistentry>
131
 
</variablelist></refsect2>
132
 
<refsect2 id="rb-play-queue-source-clear-queue" role="function">
133
 
<title>rb_play_queue_source_clear_queue ()</title>
134
 
<indexterm zone="rb-play-queue-source-clear-queue"><primary sortas="rb_play_queue_source_clear_queue">rb_play_queue_source_clear_queue</primary></indexterm><programlisting><link linkend="void">void</link>                rb_play_queue_source_clear_queue    (<link linkend="RBPlayQueueSource">RBPlayQueueSource</link> *source);</programlisting>
135
 
<para>
136
 
Clears the play queue.</para>
137
 
<para>
138
 
</para><variablelist role="params">
139
 
<varlistentry><term><parameter>source</parameter>&#160;:</term>
140
 
<listitem><simpara> the <link linkend="RBPlayQueueSource"><type>RBPlayQueueSource</type></link>
141
 
</simpara></listitem></varlistentry>
142
 
</variablelist></refsect2>
143
 
 
144
 
</refsect1>
145
 
<refsect1 id="RBPlayQueueSource.property-details" role="property_details">
146
 
<title role="property_details.title">Property Details</title>
147
 
<refsect2 id="RBPlayQueueSource--sidebar" role="property"><title>The <literal>&quot;sidebar&quot;</literal> property</title>
148
 
<indexterm zone="RBPlayQueueSource--sidebar"><primary sortas="RBPlayQueueSource:sidebar">RBPlayQueueSource:sidebar</primary></indexterm><programlisting>  &quot;sidebar&quot;                  <link linkend="RBEntryView">RBEntryView</link>*          : Read</programlisting>
149
 
<para>
150
 
The <link linkend="RBEntryView"><type>RBEntryView</type></link> for the play queue side pane.</para>
151
 
<para>
152
 
</para></refsect2>
153
 
</refsect1>
154
 
 
155
 
 
156
 
 
157
 
 
158
 
</refentry>