← Back to branch summary

~ubuntu-branches/ubuntu/utopic/rhythmbox/utopic-proposed

« back to all changes in this revision

Viewing changes to doc/reference/xml/rb-statusbar.xml

Tags: upstream-0.9.2
Import upstream version 0.9.2

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/reference/xml/rb-statusbar.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="rhythmbox-rb-statusbar">
 
5
<refmeta>
 
6
<refentrytitle>rb-statusbar</refentrytitle>
 
7
<manvolnum>3</manvolnum>
 
8
<refmiscinfo>RHYTHMBOX Library</refmiscinfo>
 
9
</refmeta>
 
10
 
 
11
<refnamediv>
 
12
<refname>rb-statusbar</refname><refpurpose></refpurpose>
 
13
</refnamediv>
 
14
 
 
15
<refsynopsisdiv><title>Synopsis</title>
 
16
 
 
17
<synopsis>
 
18
 
 
19
 
 
20
 
 
21
typedef     <link linkend="RBStatusbarPrivate">RBStatusbarPrivate</link>;
 
22
<link linkend="RBStatusbar">RBStatusbar</link>* <link linkend="rb-statusbar-new">rb_statusbar_new</link>               (<link linkend="RhythmDB">RhythmDB</link> *db,
 
23
                                             <link linkend="GtkActionGroup">GtkActionGroup</link> *actiongroup,
 
24
                                             <link linkend="RBShellPlayer">RBShellPlayer</link> *player);
 
25
<link linkend="void">void</link>        <link linkend="rb-statusbar-set-source">rb_statusbar_set_source</link>         (<link linkend="RBStatusbar">RBStatusbar</link> *bar,
 
26
                                             <link linkend="RBSource">RBSource</link> *player);
 
27
<link linkend="void">void</link>        <link linkend="rb-statusbar-set-progress">rb_statusbar_set_progress</link>       (<link linkend="RBStatusbar">RBStatusbar</link> *bar,
 
28
                                             <link linkend="double">double</link> progress,
 
29
                                             const <link linkend="char">char</link> *text);
 
30
<link linkend="void">void</link>        <link linkend="rb-statusbar-sync-state">rb_statusbar_sync_state</link>         (<link linkend="RBStatusbar">RBStatusbar</link> *statusbar);
 
31
 
 
32
</synopsis>
 
33
</refsynopsisdiv>
 
34
 
 
35
 
 
36
 
 
37
 
 
38
 
 
39
 
 
40
 
 
41
 
 
42
 
 
43
<refsect1>
 
44
<title>Description</title>
 
45
<para>
 
46
 
 
47
</para>
 
48
</refsect1>
 
49
 
 
50
<refsect1>
 
51
<title>Details</title>
 
52
<refsect2>
 
53
<title><anchor id="RBStatusbarPrivate"/>RBStatusbarPrivate</title>
 
54
<indexterm><primary>RBStatusbarPrivate</primary></indexterm><programlisting>typedef struct RBStatusbarPrivate RBStatusbarPrivate;
 
55
</programlisting>
 
56
<para>
 
57
 
 
58
</para></refsect2>
 
59
<refsect2>
 
60
<title><anchor id="rb-statusbar-new"/>rb_statusbar_new ()</title>
 
61
<indexterm><primary>rb_statusbar_new</primary></indexterm><programlisting><link linkend="RBStatusbar">RBStatusbar</link>* rb_statusbar_new               (<link linkend="RhythmDB">RhythmDB</link> *db,
 
62
                                             <link linkend="GtkActionGroup">GtkActionGroup</link> *actiongroup,
 
63
                                             <link linkend="RBShellPlayer">RBShellPlayer</link> *player);</programlisting>
 
64
<para>
 
65
 
 
66
</para><variablelist role="params">
 
67
<varlistentry><term><parameter>db</parameter>&nbsp;:</term>
 
68
<listitem><simpara>
 
69
</simpara></listitem></varlistentry>
 
70
<varlistentry><term><parameter>actiongroup</parameter>&nbsp;:</term>
 
71
<listitem><simpara>
 
72
</simpara></listitem></varlistentry>
 
73
<varlistentry><term><parameter>player</parameter>&nbsp;:</term>
 
74
<listitem><simpara>
 
75
</simpara></listitem></varlistentry>
 
76
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
 
77
 
 
78
 
 
79
</simpara></listitem></varlistentry>
 
80
</variablelist></refsect2>
 
81
<refsect2>
 
82
<title><anchor id="rb-statusbar-set-source"/>rb_statusbar_set_source ()</title>
 
83
<indexterm><primary>rb_statusbar_set_source</primary></indexterm><programlisting><link linkend="void">void</link>        rb_statusbar_set_source         (<link linkend="RBStatusbar">RBStatusbar</link> *bar,
 
84
                                             <link linkend="RBSource">RBSource</link> *player);</programlisting>
 
85
<para>
 
86
 
 
87
</para><variablelist role="params">
 
88
<varlistentry><term><parameter>bar</parameter>&nbsp;:</term>
 
89
<listitem><simpara>
 
90
</simpara></listitem></varlistentry>
 
91
<varlistentry><term><parameter>player</parameter>&nbsp;:</term>
 
92
<listitem><simpara>
 
93
 
 
94
 
 
95
</simpara></listitem></varlistentry>
 
96
</variablelist></refsect2>
 
97
<refsect2>
 
98
<title><anchor id="rb-statusbar-set-progress"/>rb_statusbar_set_progress ()</title>
 
99
<indexterm><primary>rb_statusbar_set_progress</primary></indexterm><programlisting><link linkend="void">void</link>        rb_statusbar_set_progress       (<link linkend="RBStatusbar">RBStatusbar</link> *bar,
 
100
                                             <link linkend="double">double</link> progress,
 
101
                                             const <link linkend="char">char</link> *text);</programlisting>
 
102
<para>
 
103
 
 
104
</para><variablelist role="params">
 
105
<varlistentry><term><parameter>bar</parameter>&nbsp;:</term>
 
106
<listitem><simpara>
 
107
</simpara></listitem></varlistentry>
 
108
<varlistentry><term><parameter>progress</parameter>&nbsp;:</term>
 
109
<listitem><simpara>
 
110
</simpara></listitem></varlistentry>
 
111
<varlistentry><term><parameter>text</parameter>&nbsp;:</term>
 
112
<listitem><simpara>
 
113
 
 
114
 
 
115
</simpara></listitem></varlistentry>
 
116
</variablelist></refsect2>
 
117
<refsect2>
 
118
<title><anchor id="rb-statusbar-sync-state"/>rb_statusbar_sync_state ()</title>
 
119
<indexterm><primary>rb_statusbar_sync_state</primary></indexterm><programlisting><link linkend="void">void</link>        rb_statusbar_sync_state         (<link linkend="RBStatusbar">RBStatusbar</link> *statusbar);</programlisting>
 
120
<para>
 
121
 
 
122
</para><variablelist role="params">
 
123
<varlistentry><term><parameter>statusbar</parameter>&nbsp;:</term>
 
124
<listitem><simpara>
 
125
 
 
126
 
 
127
</simpara></listitem></varlistentry>
 
128
</variablelist></refsect2>
 
129
 
 
130
</refsect1>
 
131
 
 
132
 
 
133
 
 
134
 
 
135
</refentry>