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